PaymentRequest: shippingoptionchange event

Secure context: This feature is available only in secure contexts (HTTPS), in some or all supporting browsers.

Deprecated: This feature is no longer recommended. Though some browsers might still support it, it may have already been removed from the relevant web standards, may be in the process of being dropped, or may only be kept for compatibility purposes. Avoid using it, and update existing code if possible; see the compatibility table at the bottom of this page to guide your decision. Be aware that this feature may cease to work at any time.

Non-standard: This feature is non-standard and is not on a standards track. Do not use it on production sites facing the Web: it will not work for every user. There may also be large incompatibilities between implementations and the behavior may change in the future.

For payment requests that request shipping information, and for which shipping options are offered, the shippingoptionchange event is sent to the PaymentRequest whenever the user chooses a shipping option from the list of available options.

The string identifying the currently-selected shipping option can be found in the shippingOption property.

This event is not cancelable and does not bubble.

Syntax

Use the event name in methods like addEventListener(), or set an event handler property.

js
addEventListener("shippingoptionchange", (event) => {});

onshippingoptionchange = (event) => {};

Event type

A PaymentRequestUpdateEvent. Inherits from Event.

Event PaymentRequestUpdateEvent

Event properties

Provides only the properties inherited from Event.

Examples

This code snippet sets up a handler for the shippingoptionchange event. The code recalculates the total charge for the payment based on the selected shipping option. For example, if there are three options (such as "Free ground shipping", "2-day air", and "Next day"), each time the user chooses one of those options, this event handler is called to recalculate the total based on the changed shipping option.

js
paymentRequest.addEventListener(
  "shippingoptionchange",
  (event) => {
    const value = calculateNewTotal(paymentRequest.shippingOption);
    const total = {
      currency: "EUR",
      label: "Total due",
      value,
    };
    event.updateWith({ total });
  },
  false,
);

After calling a custom function, calculateNewTotal(), to compute the updated total based on the newly-selected shipping option as specified by the shippingOption. The revised total is submitted back to the payment request by calling the event's updateWith() method.

You can also create an event handler for shippingoptionchange using its corresponding event handler property, onshippingoptionchange:

js
paymentRequest.onshippingoptionchange = (event) => {
  const value = calculateNewTotal(paymentRequest.shippingOption);
  const total = {
    currency: "EUR",
    label: "Total due",
    value,
  };
  event.updateWith({ total });
};

Browser compatibility

BCD tables only load in the browser