## ExpressCheckoutElement

Use the `ExpressCheckoutElement` from `@stripe/react-stripe-js` to accept payments through one-click payment buttons.

The component must be rendered inside an [Elements Provider](/js/react_stripe_js/elements/elements_provider.md).

### Props

- `id` (string)
  Sets the DOM `id` attribute on the rendered Element container. Use this to
target the Element for styling or testing.

- `className` (string)
  Applies custom CSS classes to the Element container.

- `options` (object)
  Options for creating the Express Checkout Element.

  - `allowedShippingCountries` (array)
    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` (object)
    Specify Apple Pay specific options. These are passed through to the Apple Pay API.

    - `recurringPaymentRequest` (object)
      Specify a request to set up a recurring payment. See the [Apple Pay documentation](https://developer.apple.com/documentation/apple_pay_on_the_web/applepayrecurringpaymentrequest) for more details.

      - `paymentDescription` (string) **required**

      - `managementURL` (string) **required**

      - `regularBilling` (object) **required**

        - `amount` (number) **required**

        - `label` (string) **required**

        - `recurringPaymentStartDate` (Date)

        - `recurringPaymentEndDate` (Date)

        - `recurringPaymentIntervalUnit` ('year' | 'month' | 'day' | 'hour' | 'minute')

        - `recurringPaymentIntervalCount` (number)

      - `trialBilling` (object)

        - `amount` (number) **required**

        - `label` (string) **required**

        - `recurringPaymentStartDate` (Date)

        - `recurringPaymentEndDate` (Date)

        - `recurringPaymentIntervalUnit` ('year' | 'month' | 'day' | 'hour' | 'minute')

        - `recurringPaymentIntervalCount` (number)

      - `billingAgreement` (string)

    - `deferredPaymentRequest` (object)
      Specify a request to set up a deferred payment. See the [Apple Pay documentation](https://developer.apple.com/documentation/apple_pay_on_the_web/applepaydeferredpaymentrequest) for more details.

      - `paymentDescription` (string) **required**

      - `managementURL` (string) **required**

      - `deferredBilling` (object) **required**

        - `amount` (number) **required**

        - `label` (string) **required**

        - `deferredPaymentDate` (Date) **required**

      - `billingAgreement` (string)

      - `freeCancellationDate` (Date)
        If set, you must also supply a freeCancellationDateTimeZone.

      - `freeCancellationDateTimeZone` (string)
        If set, you must also supply a freeCancellationDate.

These are [tz](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones) timezones such as `America/Los_Angeles`, `Europe/Dublin`, and `Asia/Singapore`.

    - `automaticReloadPaymentRequest` (object)
      Specify a request to set up an automatic reload payment. See the [Apple Pay documentation](https://developer.apple.com/documentation/apple_pay_on_the_web/applepayautomaticreloadpaymentrequest) for more details.

      - `paymentDescription` (string) **required**

      - `managementURL` (string) **required**

      - `automaticReloadBilling` (object) **required**

        - `amount` (number) **required**

        - `label` (string) **required**

        - `automaticReloadPaymentThresholdAmount` (number) **required**

      - `billingAgreement` (string)

  - `billingAddressRequired` (boolean)
    Controls whether the Express Checkout Element collects the billing address. The default value depends on your integration:

- If you pass `allowedShippingCountries`, `phoneNumberRequired`, `shippingAddressRequired`, `emailRequired`, `applePay`, `lineItems`, or `business` when creating the Express Checkout Element, `billingAddressRequired` defaults to false.
- Otherwise, `billingAddressRequired` defaults to true.

You can explicitly set `billingAddressRequired` to true or false to override the default behavior.

We highly recommend that you collect the billing address because it can be used to perform address verifications and block fraudulent payments.

  - `business` (object)
    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` (string)
      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.

  - `buttonHeight` (number)
    By default, the height of the buttons are 44px.

You can override this to specify a custom button height in the range of 40px-55px.

  - `buttonTheme` (object)
    Specify the preferred button theme to use. By default, Elements determines the themes based on the specified [appearance option](/js/elements_object/create.md#stripe_elements-options-appearance).

    - `applePay` ('black' | 'white' | 'white-outline')

    - `googlePay` ('black' | 'white')

    - `paypal` ('gold' | 'blue' | 'silver' | 'white' | 'black')

    - `klarna` ('dark' | 'light' | 'outlined')

  - `buttonType` (object)
    Specify the preferred button type to display.

    - `applePay` ('add-money' | 'book' | 'buy' | 'check-out' | 'contribute' | 'donate' | 'order' | 'plain' | 'reload' | 'rent' | 'subscribe' | 'support' | 'tip' | 'top-up')
      Default is `plain`.

    - `googlePay` ('book' | 'buy' | 'checkout' | 'donate' | 'order' | 'pay' | 'plain' | 'subscribe')
      Default is `buy`.

    - `paypal` ('paypal' | 'checkout' | 'buynow' | 'pay')
      Default is `paypal`.

    - `klarna` ('continue' | 'pay')
      Default is `pay`.

  - `emailRequired` (boolean)
    Collect the customer's email by setting this option to `true`.

  - `layout` (object)
    Specify how the buttons are arranged in a grid-like layout in the Express Checkout Element.
Elements determines the layout by using certain factors, such as available space, number of buttons, and the defined `layout` object.

    - `maxColumns` (number)
      Defines the maximum number of columns the Express Checkout Element can use to render. Default is `0`, meaning unlimited.

    - `maxRows` (number)
      Defines the maximum number of rows the Express Checkout Element can use to render. Default is `0`, meaning unlimited.

    - `overflow` ('auto' | 'never')
      Specify whether or not to always hide the overflow menu or allow Elements to determine when to show the overflow menu. Default is `auto`.
You can't specify both `overflow: 'never'` and set `maxRows` to a number greater than 0.

  - `lineItems` (array)
    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` (string) **required**
      The name of the line item surfaced to the customer in the payment interface.

    - `amount` (number) **required**
      The amount in the currency's subunit (for example, cents, yen, etc.).

  - `paymentMethods` (object)
    By default, the Express Checkout Element displays all payment
methods possible as a result of your Dashboard configuration. This is the `auto` behavior.

If you don't want to show a given payment method as a payment option, set its
property in `paymentMethods` to `never`.

    - `amazonPay` ('auto' | 'never')

    - `applePay` ('always' | 'auto' | 'never')
      Apple Pay has additional configurations
that determine when Stripe can show it. By default, Apple Pay shows when the customer
is using a supported platform and when we determine it's advantageous for your conversion.
This is the `auto` behavior.

If you want to always show Apple Pay when the customer is using a supported platform,
you can set its property in `paymentMethods` to `always`. This causes Apple Pay to be shown in supported browsers even when the customer
isn't logged in to Apple Pay, resulting in a sign-in flow.

Apple Pay on desktop Chromium browsers is only supported on MacOS when its property in `paymentMethods` is set to `always`.

    - `googlePay` ('always' | 'auto' | 'never')
      Google Pay has additional configurations
that determine when Stripe can show it. By default, Google Pay shows when the customer
is using a supported platform and when we determine it's advantageous for your conversion.
This is the `auto` behavior.

If you want to always show Google Pay when the customer is using a supported platform,
you can set its property in `paymentMethods` to `always`. This causes Google Pay to be shown in supported browsers even when the customer
isn't logged in to Google Pay, resulting in a sign-in flow.

    - `link` ('auto' | 'never')

    - `paypal` ('auto' | 'never')

    - `klarna` ('auto' | 'never')

  - `paymentMethodOrder` (array)
    By default, the Express Checkout Element uses a dynamic ordering that optimizes payment method display for each user.

You can override the default order in which payment methods display in the Express Checkout Element with a list of payment method types.

If there are payment methods that will show that are not specified in `paymentMethodOrder`, they display after the payment methods you specify. If you specify payment methods that will not show, they are ignored.

  - `phoneNumberRequired` (boolean)
    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`.

Google Pay makes a best effort to return the phone number registered to the wallet, but doesn't guarantee it will be provided in all cases.

  - `shippingAddressRequired` (boolean)
    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` (array)
    An array of ShippingRate objects. The first shipping rate listed appears in the payment interface as the default option.

    - `id` (string) **required**
      Unique identifier for the object.

    - `amount` (number) **required**
      The amount to charge for shipping.

    - `displayName` (string) **required**
      The name of the shipping rate, displayed to the customer in the payment interface.

    - `deliveryEstimate` (object | string)
      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` (object)
        The upper bound of the estimated range. If empty, it represents no upper bound (for example, infinite).

        - `unit` ('hour' | 'day' | 'business_day' | 'week' | 'month')
          A unit of time.

        - `value` (number)
          Must be greater than 0.

      - `minimum` (object)
        The lower bound of the estimated range. If empty, it represents no lower bound.

        - `unit` ('hour' | 'day' | 'business_day' | 'week' | 'month')
          A unit of time.

        - `value` (number)
          Must be greater than 0.

- `onConfirm` (function) **required**
  The [confirm](/js/elements_object/express_checkout_element_confirm_event.md) event is triggered from an Express Checkout Element when the customer finalizes their payment.

- `onClick` (function)
  The [click](/js/elements_object/express_checkout_element_click_event.md) event is triggered from an Express Checkout Element when the customer clicks a payment button.

- `onCancel` (function)
  The `cancel` event is triggered from an Express Checkout Element when the payment interface is dismissed.

Note that in some browsers, the payment interface might be dismissed by the customer even after they authorize the payment.
This means that you might receive a `cancel` event after receiving a `confirm` event.
If you're using the `cancel` event as a hook for canceling the customer's order, make sure you also refund the payment that you just created.

- `onShippingAddressChange` (function)
  Triggered when a customer changes their shipping address.

- `onShippingRateChange` (function)
  Triggered when a customer changes their shipping rate.

- `onReady` (function)
  Callback called once the Element is fully rendered.
Recieves the [ready event payload](/js/element/events/on_ready.md#element_on_ready-handler).

- `onBlur` (function)
  Callback called when the Element loses focus.

- `onFocus` (function)
  Callback called when the Element receives focus.

- `onEscape` (function)
  Callback called when the escape key is pressed within the Element.

- `onLoadError` (function)
  Callback called when the Element fails to load.

### Render ExpressCheckoutElement

```jsx
import React from 'react';
import {Elements, ExpressCheckoutElement} from '@stripe/react-stripe-js';
import {loadStripe} from '@stripe/stripe-js';

const stripePromise = loadStripe('{TEST_PUBLISHABLE_KEY}');

export const App = ({clientSecret}) => (
  <Elements
    stripe={stripePromise}
    options={{clientSecret}}
  >
    <ExpressCheckoutElement onConfirm={(event) => {
      // Fulfill order once the payment is confirmed
    }} />
  </Elements>
);
```