PaymentRequest.onshippingaddresschange

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 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.
Editor's Draft Initial definition.

Browser Compatibility

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

53.0

No support[1] ? ? ?
Feature Android Android Webview Firefox Mobile (Gecko) IE Mobile Opera Mobile Safari Mobile Chrome for Android
Basic support No support 53.0 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, dgashmdn, jpmedley
 Last updated by: chrisdavidmills,