PaymentRequest.onshippingaddresschange

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

This is an experimental technology
Check the Browser compatibility table carefully before using this in production.

The onshippingaddresschange event of the PaymentRequest interface is fired whenever the user changes their shipping address, including when an address is added by the user for the first time.

Syntax

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

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

Examples

The shippingaddresschange event is triggered by a user-agent controlled interaction. If the address stored by the user agent changes at any time during a payment process, the event is triggered. To make sure an updated address 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 payment = new PaymentRequest(supportedInstruments, details, options);

request.addEventListener('shippingaddresschange', function(evt) {
  evt.updateWith(new Promise(function(resolve) {
    updateDetails(details, request.shippingAddress, resolve);
  }));
});

payment.show().then(function(paymentResponse) {
  // Processing of paymentResponse exerpted for the same of clarity.
}).catch(function(err) {
  console.error("Uh oh, something bad happened", err.message);
});

Specifications

Specification Status Comment
Payment Request API
The definition of 'onshippingaddresschange' in that specification.
Candidate Recommendation Initial definition.

Browser Compatibility

FeatureChromeEdgeFirefoxInternet ExplorerOperaSafari
Basic support6115551 No No ?
FeatureAndroid webviewChrome for AndroidEdge mobileFirefox for AndroidOpera AndroidiOS SafariSamsung Internet
Basic support No53 Yes551 No ?6.0

1. From version 55: this feature is behind the dom.payments.request.enabled preference (needs to be set to true). To change preferences in Firefox, visit about:config.

Document Tags and Contributors

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