PaymentRequest: shippingAddress property

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

Deprecated: This feature is no longer recommended. Though some browsers might still support it, it may have already been removed from the relevant web standards, may be in the process of being dropped, or may only be kept for compatibility purposes. Avoid using it, and update existing code if possible; see the compatibility table at the bottom of this page to guide your decision. Be aware that this feature may cease to work at any time.

Non-standard: This feature is non-standard and is not on a standards track. Do not use it on production sites facing the Web: it will not work for every user. There may also be large incompatibilities between implementations and the behavior may change in the future.

The shippingAddress read-only property of the PaymentRequest interface returns the shipping address provided by the user. It is null by default.



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 shippingaddresschange 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.
const payment = new PaymentRequest(supportedInstruments, details, options);

payment.addEventListener("shippingaddresschange", (evt) => {
    new Promise((resolve) => {
      updateDetails(details, request.shippingAddress, resolve);

  .then((paymentResponse) => {
    // Processing of paymentResponse excerpted for brevity.
  .catch((err) => {
    console.error("Uh oh, something bad happened", err.message);

function updateDetails(details, shippingAddress, resolve) {
  if ( === "US") {
    const 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;

Browser compatibility

BCD tables only load in the browser