Web/API/PaymentRequest/shippingoptionchange event

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

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.

Bubbles	No
Cancelable	No
Interface	PaymentRequestUpdateEvent
Event handler property	onshippingoptionchange

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.

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

After caling 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:

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

Specifications

Specification	Status	Comment
Payment Request APIThe definition of 'shippingoptionchange' in that specification.	Candidate Recommendation	Initial definition.

Browser compatibility

The compatibility table on this page is generated from structured data. If you'd like to contribute to the data, please check out https://github.com/mdn/browser-compat-data and send us a pull request.

Update compatibility data on GitHub

	Desktop						Mobile
	Chrome	Edge	Firefox	Internet Explorer	Opera	Safari	Android webview	Chrome for Android	Firefox for Android	Opera for Android	Safari on iOS	Samsung Internet
shippingoptionchange event	Chrome Full support 61	Edge Full support 15	Firefox No support No Notes' No support No Notes' Notes' Available only in nightly builds.	IE No support No	Opera Full support 47	Safari Full support 11.1	WebView Android No support No	Chrome Android Full support 53	Firefox Android No support No Notes' No support No Notes' Notes' Available only in nightly builds.	Opera Android Full support 44	Safari iOS Full support 11.3	Samsung Internet Android Full support 6.0

Legend

Full support  

Full support

No support  

No support

See implementation notes.'

See implementation notes.

See also

• onshippingoptionchange event handler property

PaymentRequest: shippingoptionchange event by Mozilla Contributors is licensed under CC-BY-SA 2.5.