MDN wants to learn about developers like you:


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

This is an experimental technology
Because this technology's specification has not stabilized, check the compatibility table for usage in various browsers. Also note that the syntax and behavior of an experimental technology is subject to change in future versions of browsers as the specification changes.

The onshippingoptionchange event of the PaymentRequest interface is fired whenever the user changes a shipping option. 


PaymentRequest.addEventListener('shippingaddresschange', shippingaddresschangeevent => { ... });

PaymentRequest.onshippingaddresschange = function(shippingaddresschangeevent) { ... };


The shippingoptionchange event is triggered by a user-agent controlled interaction. If the option stored by the user agent changes at any time during a payment process, the event is triggered. To make sure an updated option is included when sending payment information to the server, you should add event listeners for a PaymentRequest object after instantiation, but before the call to show().

// Initialization of PaymentRequest arguments are excerpted for clarity.
var request = new PaymentRequest(supportedInstruments, details, options);

// When user selects a shipping address
request.addEventListener('shippingaddresschange', e => {
  e.updateWith(((details, addr) => {
    var shippingOption = {
      id: '',
      label: '',
      amount: { currency: 'USD', value: '0.00' },
      selected: true
    // Shipping to US is supported
    if ( === 'US') { = 'us';
      shippingOption.label = 'Standard shipping in US';
      shippingOption.amount.value = '0.00'; = '55.00';
    // Shipping to JP is supported
    } else if ( === 'JP') { = 'jp';
      shippingOption.label = 'International shipping';
      shippingOption.amount.value = '10.00'; = '65.00';
    // Shipping to elsewhere is unsupported
    } else {
      // Empty array indicates rejection of the address
      details.shippingOptions = [];
      return Promise.resolve(details);
    // Hardcode for simplicity
    if (details.displayItems.length === 2) {
      details.displayItems[2] = shippingOption;
    } else {
    details.shippingOptions = [shippingOption];

    return Promise.resolve(details);
  })(details, request.shippingAddress));


Specification Status Comment
Payment Request API
The definition of 'onshippingoptionchange' in that specification.
Editor's Draft Initial definition.

Browser Compatibility

Feature Chrome Edge Firefox (Gecko) Internet Explorer Opera Safari (WebKit)
Basic support


(Yes) No support[1] ? ? ?
Feature Android Android Webview Edge Firefox Mobile (Gecko) IE Mobile Opera Mobile Safari Mobile Chrome for Android
Basic support No support 53.0 (Yes) No support[1] ? ? ? 53.0

[1] Supported since 55 but disabled on all versions. Hidden behind the dom.payments.request.enabled pref.

Document Tags and Contributors

 Contributors to this page: chrisdavidmills, libbymc, dgashmdn, jpmedley
 Last updated by: chrisdavidmills,