Web/API/PaymentRequest/shippingaddresschange event

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

The shippingaddresschange event is sent to the PaymentRequest object when the user selects a shipping address or changes details of their shipping address.

Bubbles	No
Cancelable	No
Interface	`PaymentRequestUpdateEvent`
Event handler property	`onshippingaddresschange`

Usage notes

Depending on the browser, the shipping address information may be redacted for privacy reasons. That is, the PaymentAddress which contains the shipping address may have some portions of its content altered, obscured, or left out entirely in order to prevent identifying the user without their consent (since if they choose to have you ship products to them, you'll need their address).

Example

In this example, a handler for the shippingaddresschange event is set up to validate that the address meets requirements set by the web application.

const paymentRequest = new PaymentRequest(methodData, details, options);

paymentRequest.addEventListener("shippingaddresschange", event => {
  let detailsUpdate = checkAddress(paymentRequest.shippingAddress);
  event.updateWith(detailsUpate);
}, false);

const checkAddress = theAddress => {
  let detailsUpdate = {};

  // Check the address, return a PaymentDetailsUpdate object
  // with any changes or errors.

  return detailsUpdate;  
};

You can also establish a handler for shippingaddresschange using the onshippingaddresschange event handler property:

paymentRequest.onshippingaddresschange = event => {
  let detailsUpdate = checkAddress(paymentRequest.shippingAddress);
  event.updateWith(detailsUpdate);
};

Specifications

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

Browser compatibility

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
`shippingaddresschange` 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.