PaymentRequest: shippingoptionchange event

Syntax

Use the event name in methods like addEventListener(), or set an event handler property.

addEventListener("shippingoptionchange", (event) => { })

onshippingoptionchange = (event) => { }

Event type

A PaymentRequestUpdateEvent. Inherits from Event.

Event properties

Provides only the properties inherited from Event.

Examples

This code snippet sets up a handler for the shippingoptionchange event. The code recalculates the total charge for the payment based on the selected shipping option. For example, if there are three options (such as "Free ground shipping", "2-day air", and "Next day"), each time the user chooses one of those options, this event handler is called to recalculate the total based on the changed shipping option.

paymentRequest.addEventListener("shippingoptionchange", (event) => {
  const value = calculateNewTotal(paymentRequest.shippingOption);
  const total = {
    currency: "EUR",
    label: "Total due",
    value,
  };
  event.updateWith({ total });
});

After calling a custom function, calculateNewTotal(), to compute the updated total based on the newly-selected shipping option as specified by the shippingOption. The revised total is submitted back to the payment request by calling the event's updateWith() method.

You can also create an event handler for shippingoptionchange using its corresponding event handler property, onshippingoptionchange:

paymentRequest.onshippingoptionchange = (event) => {
  const value = calculateNewTotal(paymentRequest.shippingOption);
  const total = {
    currency: "EUR",
    label: "Total due",
    value,
  };
  event.updateWith({ total });
};

Browser compatibility