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

This is an experimental technology
Check the Browser compatibility table carefully before using this in production.

The PaymentRequestUpdateEvent constructor creates a new PaymentRequestUpdateEvent object which enables a web page to update the details of a PaymentRequest in response to a user action.


var paymentRequestUpdateEvent = new PaymentRequestUpdateEvent(type[, options])


Must be "paymentrequest".
options Optional
Options are as follows:
  • displayItems[]: An array of optional line items for the payment request that the user agent may display, such as product details, tax, and shipping.
  • error: A message to display to the user when an invalid shipping options is passed to PaymentRequestUpdateEvent.updateWith().
  • modifiers: Modifiers for specific payment methods; for example, adjusting the total amount based on the payment method.
  • shippingOptions: The shipping options the user may choose from. If this sequence is blank, it indicates the merchant cannot ship to the current shipping address. The default shipping option may be indicated in this sequence.
  • total: The total amount of the payment request.


Specification Status Comment
Payment Request API
The definition of 'PaymentRequestUpdateEvent' in that specification.
Candidate Recommendation Initial definition.

Browser Compatibility

Feature Chrome Firefox (Gecko) Internet Explorer Opera Safari (WebKit)
Basic support 61 No support[1] ? No support ?
Feature Android Webview Chrome for Android Firefox Mobile (Gecko) IE Mobile Opera Mobile Safari Mobile
Basic support No support 52 No support[1] ? No support ?

[1] Supported since 56 but disabled on all versions. Hidden behind the dom.payments.request.enabled pref.

Document Tags and Contributors

 Contributors to this page: jpmedley, chrisdavidmills
 Last updated by: jpmedley,