This article needs a technical review. How you can help.

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 shippingAddress read-only property of the PaymentRequest interface returns the shipping address provided by the user. It is null by default.


var paymentAddress = PaymentRequest.shippingAddress;


Generally, the user agent will fill the shippingAddress property value. You can trigger this by setting PaymentOptions.requestShipping to true when calling the PaymentRequest constructor.

In the example below, the cost of shipping varies by geography. When the PaymentRequest.onshippingaddresschange is called, updateDetails() is called to update the details of the PaymentRequest, using shippingAddress to set the correct shipping cost.

// Initialization of PaymentRequest arguments are excerpted for the sake of
//   brevity.
var payment = new PaymentRequest(supportedInstruments, details, options);

payment.addEventListener('shippingaddresschange', function(evt) {
  evt.updateWith(new Promise(function(resolve) {
    updateDetails(details, request.shippingAddress, resolve);
}); {
    // Processing of paymentResponse exerpted for brevity.
}).catch(function(err) {
    console.error("Uh oh, something bad happened", err.message);

function updateDetails(details, shippingAddress, resolve) {
  if ( === 'US') {
    var shippingOption = {
      id: '',
      label: '',
      amount: {currency: 'USD', value: '0.00'},
      selected: true
    if (shippingAddress.region === 'MO') { = 'mo';
      shippingOption.label = 'Free shipping in Missouri'; = '55.00';
    } else { = 'us';
      shippingOption.label = 'Standard shipping in US';
      shippingOption.amount.value = '5.00'; = '60.00';
    details.displayItems.splice(2, 1, shippingOption);
    details.shippingOptions = [shippingOption];
  } else {
    delete details.shippingOptions;


Specification Status Comment
Payment Request API
The definition of 'shippingaddress' in that specification.
Working Draft Initial definition.

Browser Compatibility

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


? ? ? ?
Feature Android Android Webview Firefox Mobile (Gecko) Firefox OS IE Mobile Opera Mobile Safari Mobile Chrome for Android
Basic support No support 53.0 ? ? ? ? ? 53.0

Document Tags and Contributors

 Contributors to this page: camerona93, dgashmdn, jpmedley
 Last updated by: camerona93,