Express Checkout Element Click Event
Click event
Last verified 2026-09-25
Is this helpful?
expressCheckoutElement.on(event: 'click', handler: function) The click event is triggered from an Express Checkout Element when the customer clicks a payment button. Use this event to configure the payment interface. - event The name of the event. In this case, click. - handler handler(event) => void is a callback function you provide that's called after the event is fired. After it's called, it passes an event object with the following properties: - elementType The type of element the event is fired from, which is expressCheckout in this case. - expressPaymentType The payment method the customer checks out with. - resolve A function resolve(payload) => void that's called to show the payment interface. You must call this function within 1 second if you handle the click event. - allowedShippingCountries (deprecated) This parameter has been deprecated in favor of the allowedShippingCountries param on the create function. By default, the Express Checkout Element allows all countries for shipping. You can specify which countries are allowed for shipping in the Express Checkout Element with a list of two-letter country codes. - applePay Specify Apple Pay specific options. These are passed through to the Apple Pay API. - recurringPaymentRequest Specify a request to set up a recurring payment. See the Apple Pay documentation for more details. - paymentDescription - managementURL - regularBilling - amount - label - recurringPaymentStartDate - recurringPaymentEndDate - recurringPaymentIntervalUnit - recurringPaymentIntervalCount - trialBilling - amount - label - recurringPaymentStartDate - recurringPaymentEndDate - recurringPaymentIntervalUnit - recurringPaymentIntervalCount - billingAgreement - deferredPaymentRequest Specify a request to set up a deferred payment. See the Apple Pay documentation for more details. - paymentDescription - managementURL - deferredBilling - amount - amountType Indicates whether the billing amount is known at request time. When set to 'final', the Apple Pay payment sheet shows the configured amount. - label - deferredPaymentDate - billingAgreement - freeCancellationDate If set, you must also supply a freeCancellationDateTimeZone. - freeCancellationDateTimeZone If set, you must also supply a freeCancellationDate. These are tz timezones such as America/Los_Angeles, Europe/Dublin, and Asia/Singapore. - automaticReloadPaymentRequest Specify a request to set up an automatic reload payment. See the Apple Pay documentation for more details. - paymentDescription - managementURL - automaticReloadBilling - amount - label - automaticReloadPaymentThresholdAmount - billingAgreement - billingAddressRequired (deprecated) This parameter has been deprecated in favor of the billingAddressRequired param on the create function. By default, the Express Checkout Element collects the billing address. You can disable this by setting billingAddressRequired to false. We highly recommend that you collect the billing address because it can be used to perform address verifications and block fraudulent payments. - business (deprecated) This parameter has been deprecated in favor of the business param on the create function. Provide information about your business that's displayed in the Express Checkout Element. This information will be retrieved from your Stripe account if it's not provided. - name The name of your business. Your business name is used to signal to the customer who they're paying. Klarna always retrieves the business name from your Stripe account, even when this option is set. - emailRequired (deprecated) This parameter has been deprecated in favor of the emailRequired param on the create function. Collect the customer's email by setting this option to true. - lineItems An array of LineItem objects. These LineItems are shown as line items in the payment interface, if line items are supported. You can represent discounts as negative amount LineItems. - name The name of the line item surfaced to the customer in the payment interface. - amount The amount in the currency's subunit (for example, cents, yen, etc.). - phoneNumberRequired (deprecated) This parameter has been deprecated in favor of the phoneNumberRequired param on the create function. Collect the customer's phone number by setting this option to true. PayPal doesn't provide a phone number, even when this option is set to true. - shippingAddressRequired (deprecated) This parameter has been deprecated in favor of the shippingAddressRequired param on the create function. Collect the customer's shipping address by setting this option to true. If true, you must also supply a valid shippingRates option in either the create, click, or shippingaddresschange events. - shippingRates An array of ShippingRate objects. The first shipping rate listed appears in the payment interface as the default option. - id Unique identifier for the object. - amount The amount to charge for shipping. - displayName The name of the shipping rate, displayed to the customer in the payment interface. - deliveryEstimate The estimated range for how long shipping takes, displayed to the customer in the payment interface. We recommended using the object format, but you can use a string instead. - maximum The upper bound of the estimated range. If empty, it represents no upper bound (for example, infinite). - unit A unit of time. - value Must be greater than 0. - minimum The lower bound of the estimated range. If empty, it represents no lower bound. - unit A unit of time. - value Must be greater than 0. - reject A function reject() => void that's called to cancel the payment interface. You must call this function within 1 second if you handle the click event. ### Example title Handle an express checkout element click event Is this helpful?