Stripe.js

https://docs.stripe.com/js
Admin
Stripe.js is a JavaScript library for building secure payment forms, collecting sensitive payment...
Tokens:3,315,445
Snippets:28,938
Trust Score:10
Update:1 week ago
Show doc for...
Tokens:
Raw
### Elements Provider Setup

Source: https://docs.stripe.com/js/setup_intents/verify_microdeposits_for_setup

Example of mounting the Elements provider with options for mode, currency, and amount.

```APIDOC
## Elements Provider Setup

### Description
Mounts the Elements provider with configuration options for payment mode, currency, and amount.

### Usage
Wrap your application components with the `Elements` component, passing the Stripe promise and options.

### Code Example
```jsx
import React from 'react';
import {Elements} from '@stripe/react-stripe-js';
import {loadStripe} from '@stripe/stripe-js';

const stripePromise = loadStripe('pk_test_TYooMQauvdEDq54NiTphI7jx');

export const App = ({children}) => (
  <Elements stripe={stripePromise} options={{
    mode: 'payment',
    currency: 'usd',
    amount: 1099,
  }}>
    {children}
  </Elements>
);
```

### Options
- **appearance** (object) - Optional - Match the design of your site. Supported for Payment Element, Contact Details Element, Express Checkout Element, and Address Element.
- **loader** ('auto' | 'always' | 'never') - Optional - Display skeleton loader UI while waiting for Elements to be fully loaded. Default is `'auto'`.
- **customerSessionClientSecret** (string) - Optional - The client_secret returned from create a CustomerSession. Used with Payment Element and Address Element.
- **syncAddressCheckbox** ('billing' | 'shipping' | 'none') - Optional - Configures which Address Element to show the checkbox above. Default is `'billing'`.
- **paymentMethodCreation** ('manual') - Optional - Allows PaymentMethods to be created from the Elements instance using stripe.createPaymentMethod. Used with Payment Element and Express Checkout Element.
- **allowedPaymentMethodTypes** (array) - Optional - The list of payment method types to allow for this payment.
- **excludedPaymentMethodTypes** (array) - Optional - The list of payment method types to exclude from use with this payment.
- **customPaymentMethods** (array) - Optional - An array of custom payment methods to display in the Payment Element or Express Checkout Element.

### Children
- **children** (ReactNode) - Required - `Elements` renders its children once the Stripe object and Elements instance are ready.
```

--------------------------------

### Stripe.js Setup Intent Confirmation Methods

Source: https://docs.stripe.com/js/payment_intents/confirm_zip_payment

Documentation for stripe.confirmSofortSetup and stripe.confirmTwintSetup methods, including parameters, request examples, and returns.

```APIDOC
## `confirmSofortSetup` with an existing PaymentMethod

### Description
Confirms a SOFORT SetupIntent with an existing PaymentMethod by passing its ID.

### Method
stripe.confirmSofortSetup

### Usage
`stripe.confirmSofortSetup(clientSecret, data?)`

### Parameters

#### clientSecret (string)
Required - The client secret of the SetupIntent.

#### data (object)

##### payment_method (string)
Required - The id of an existing PaymentMethod.

##### return_url (string)
Recommended - The URL your customer will be directed to after they complete authentication.

### Request Example
```javascript
stripe
  .confirmSofortSetup('{SETUP_INTENT_CLIENT_SECRET}', {
    payment_method: '{PAYMENT_METHOD_ID}',
  })
  .then(function(result) {
    // Handle result.error or result.setupIntent
  });
```

### Returns
A Promise that resolves with a result object containing either `result.error` or `result.setupIntent`.

## `confirmSofortSetup` with self collected data

### Description
Confirms a SOFORT SetupIntent by creating a new PaymentMethod from self-collected customer data.

### Method
stripe.confirmSofortSetup

### Usage
`stripe.confirmSofortSetup(clientSecret, data?)`

### Parameters

#### clientSecret (string)
Required - The client secret of the SetupIntent.

#### data (object)

##### payment_method (object)
Required - Pass an object to confirm with the customer's name and email.

- **country** (string) - Required - The country code where the customer's bank is located.
- **billing_details** (object) - Required - The customer's billing details. `name` and `email` are required.
  - **name** (string) - Required - The customer's name.
  - **email** (string) - Required - The customer's email.

##### return_url (string)
Recommended - The URL your customer will be directed to after they complete authentication.

### Request Example
```javascript
stripe
  .confirmSofortSetup('{SETUP_INTENT_CLIENT_SECRET}', {
    payment_method: {
      sofort: {
        country: 'DE'
      },
      billing_details: {
        name: 'Jenny Rosen',
        email: 'jenny@example.com',
      },
    },
    return_url: window.location.href,
  })
  .then(function(result) {
    if (result.error) {
      // Inform the customer that there was an error.
    }
  });
```

### Returns
A Promise that resolves with a result object containing either `result.error` or `result.setupIntent`.

## `confirmTwintSetup`

### Description
Confirms a TWINT SetupIntent when the customer submits the setup form. It automatically redirects the customer to authorize the setup, then redirects back to the provided return URL.

### Method
stripe.confirmTwintSetup

### Usage
`stripe.confirmTwintSetup(clientSecret, data?, options?)`

### Parameters

#### clientSecret (string)
Required - The client secret of the SetupIntent.

#### data (object, optional)
Optional - Data to be sent with the request. Refer to the Setup Intents API for a full list of parameters.

- **payment_method** (object | string) - An object of collected data or an id of an existing PaymentMethod. See the use cases in the source for details.
  - **type** (string) - Set to `'twint'` when using an object.
- **return_url** (string) - Required - The URL your customer is redirected to after they complete authorization.

#### options (object, optional)
Optional - An options object to control the behavior of this method.

- **handleActions** (boolean) - Set to `false` to manually handle the authorization redirect. Default is `true`.

### Request Example
```javascript
stripe
  .confirmTwintSetup('{SETUP_INTENT_CLIENT_SECRET}', {
    payment_method: {
      type: 'twint',
    },
    return_url: "https://example.com/setup/complete",
  })
  .then(function(result) {
    if (result.error) {
      // Inform the customer that there was an error.
    }
  });
```

### Returns
A Promise that resolves with a result object containing either `result.setupIntent` or `result.error`. The method may take some time; disable the form and show a waiting indicator during that time.
```

--------------------------------

### Stripe.js Card Setup Methods

Source: https://docs.stripe.com/js/appendix/cookies

Documentation for Stripe.js methods to handle card setup and confirm SetupIntents.

```APIDOC
## stripe.handleCardSetup(clientSecret, data?)

### Description
Handles card setup for a SetupIntent. It confirms the SetupIntent and handles any required next actions, such as 3D Secure authentication. Returns a Promise that resolves with a result object containing either the successful SetupIntent or an error.

### Method
POST

### Endpoint
stripe.handleCardSetup

### Parameters
#### Path Parameters
- **clientSecret** (string) - Required - The client secret of the SetupIntent to confirm.

#### Request Body
- **payment_method** (string) - Required - The ID of the payment method to use for the setup.

### Request Example
```
stripe
  .handleCardSetup('{SETUP_INTENT_CLIENT_SECRET}', {
    payment_method: '{PAYMENT_METHOD_ID}',
  })
  .then(function(result) {
    // Handle result.error or result.setupIntent
  });
```

### Response
#### Success Response (200)
- **setupIntent** (object) - The successful SetupIntent.
- **error** (object) - An error object if the setup failed.

#### Response Example
```
{
  "setupIntent": {},
  "error": {}
}
```

### Notes
- May take several seconds to complete; disable form submission and show a waiting indicator during that time.
- May trigger a 3D Secure authentication challenge shown in a modal dialog.

## stripe.confirmSetupIntent(clientSecret, element, data?)

### Description
Confirms a SetupIntent using payment information gathered from an Element and additional data. This method is deprecated; use `confirmCardSetup` with `{handleActions: false}` instead. Only use this method if you want to handle next actions yourself.

### Method
POST

### Endpoint
stripe.confirmSetupIntent

### Parameters
#### Path Parameters
- **clientSecret** (string) - Required - The client secret of the SetupIntent to confirm.
- **element** (Element) - Required - An Element that will be used to create a payment method.
- **data** (object) - Optional - Data to be sent with the request.

#### Request Body
- **payment_method_data** (object) - Optional - Additional data relevant to the payment method, such as billing details.
  - **billing_details** (object) - Recommended - The billing details associated with the card.

### Response
#### Success Response (200)
- **setupIntent** (object) - The successful SetupIntent.
- **error** (object) - An error object if the confirmation failed.

### Notes
- Deprecated: use `confirmCardSetup` with `{handleActions: false}` instead.
- Only use if you want to handle next actions yourself.
```

--------------------------------

### Show adjustableQuantity properties

Source: https://docs.stripe.com/js/setup_intents

Displays the adjustableQuantity properties of a SetupIntent. The example is shown in a collapsible section titled 'Show adjustableQuantity properties'.

```json
{
  "livemode": true,
  "minorUnitsAmountDivisor": 100,
  "nameCollection": null,
  "phoneNumber": "+15555555555",
  "recurring": {
    "interval": "month"
  },
  "savedPaymentMethods": [
    {
      "id": "pm_123",
      "type": "card"
    }
  ],
  "shipping": null,
  "shippingAddress": {
    "line1": "123 Main St",
    "city": "San Francisco",
    "state": "CA",
    "postal_code": "94103",
    "country": "US"
  },
  "shippingOptions": [
    {
      "id": "ship_123",
      "label": "Standard",
      "amount": 500
    }
  ],
  "status": {
    "state": "complete"
  }
}
```

--------------------------------

### Stripe.js Card Setup Methods

Source: https://docs.stripe.com/js/appendix/supported_locales

Documentation for Stripe.js methods to handle card setup: handleCardSetup and confirmSetupIntent.

```APIDOC
## stripe.handleCardSetup(clientSecret, data)

### Description
Handles a card setup with a SetupIntent client secret and payment method data. Returns a Promise that resolves with a result object containing either a successful SetupIntent or an error.

### Method
handleCardSetup

### Parameters
- **clientSecret** (string) - Required - The client secret of the SetupIntent to confirm.
- **data** (object) - Required - Data to be sent with the request. Contains `payment_method` (string) - Required - The payment method ID.

### Request Example
```javascript
stripe
  .handleCardSetup('{SETUP_INTENT_CLIENT_SECRET}', {
    payment_method: '{PAYMENT_METHOD_ID}',
  })
  .then(function(result) {
    // Handle result.error or result.setupIntent
  });
```

### Response
#### Success Response
- **result.setupIntent** - The successful SetupIntent.
- **result.error** - An error. Refer to the API reference for all possible errors.

### Notes
- May take several seconds to complete. Disable form submission and show a waiting indicator.
- May trigger a 3D Secure authentication challenge shown in a modal dialog.

## stripe.confirmSetupIntent(clientSecret, element, data?) (Deprecated)

### Description
Confirms a SetupIntent when the customer submits a save payment method form. Gathers payment information from an Element and additional data. Only use if you want to handle next actions yourself; otherwise use `stripe.handleCardSetup`.

### Method
confirmSetupIntent

### Parameters
- **clientSecret** (string) - Required - The client secret of the SetupIntent to confirm.
- **element** (Element) - Required - An Element used to create a payment method.
- **data** (object) - Optional - Data to be sent with the request. Contains:
  - **payment_method_data** (object) - Use to supply additional data relevant to the payment method, such as billing details.
    - **billing_details** (object) - Recommended - The billing details associated with the card.

### Deprecation Note
`confirmSetupIntent` has been deprecated. Going forward, pass `{handleActions: false}` as a third argument to `confirmCardSetup` to confirm on the client without handling next actions.
```

--------------------------------

### Render PaymentElement

Source: https://docs.stripe.com/js/setup_intents/payment_method

Example of rendering the PaymentElement component in a React application using the ElementsProvider and loadStripe.

```APIDOC
## Render PaymentElement

### Description
Example of rendering the PaymentElement component in a React application using the ElementsProvider and loadStripe.

### Code Example
```jsx
import React from 'react';
import {ElementsProvider, PaymentElement} from '@stripe/react-stripe-js';
import {loadStripe} from '@stripe/stripe-js';

const stripePromise = loadStripe('pk_test_TYooMQauvdEDq54NiTphI7jx');

export const App = ({clientSecret}) => (
  <ElementsProvider
    stripe={stripePromise}
    options={{clientSecret}}
  >
    <form>
      <PaymentElement />
      <button type="submit">Pay now</button>
    </form>
  </ElementsProvider>
);
```
```

--------------------------------

### actions.updateTaxIdInfo(options)

Source: https://docs.stripe.com/js/setup_intents/verify_microdeposits_for_setup

Updates the customer's business name and tax ID for the current Setup Intent session. Returns a Promise that resolves with a result object indicating success or error.

```APIDOC
## actions.updateTaxIdInfo(options)

### Description
Updates the customer's business name and tax ID for the current Setup Intent session.

### Method
POST

### Endpoint
/actions/updateTaxIdInfo

### Parameters
#### Request Body
- **options** (object) - Required - Options for `updateTaxIdInfo`.
  - **businessName** (string) - Required - The customer's business name.
  - **taxId** (object) - Required - The tax ID information.
    - **type** (string) - Required - The type of tax ID (e.g., 'eu_vat').
    - **value** (string) - Required - The tax ID value.

### Request Example
```json
{
  "businessName": "Acme, Inc.",
  "taxId": {
    "type": "eu_vat",
    "value": "DK12345678"
  }
}
```

### Response
#### Success Response (200)
- **type** (string) - Either `"success"` or `"error"`.
- **session** (object) - Only populated when `type` is `"success"`. Contains a Session instance representing the updated state.
- **error** (object) - Only populated when `type` is `"error"`. Contains an object with a string `message` field.

#### Response Example
```json
{
  "type": "success",
  "session": {}
}
```

```

--------------------------------

### Render TaxIdElement

Source: https://docs.stripe.com/js/setup_intents/payment_method

Example of rendering the TaxIdElement component inside an Elements provider with a Stripe instance and client secret.

```APIDOC
## TaxIdElement

### Description
Use the `TaxIdElement` from `@stripe/react-stripe-js` to collect tax ID information from your customers, including business name and tax identification number. The component must be rendered inside an Elements Provider.

### 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)
Tax ID Element initialization options.

##### visibility ('always' | 'never' | 'auto')
By default, the Tax ID Element displays when the user is in a country that supports tax ID collection. Specify `always` to display the element regardless of the user's country. Specify `never` to hide the element completely.

##### fields (object)
By default, the Tax ID Element collects all tax ID information. If it's not necessary for you to collect all fields, you can disable Tax ID Element collection of certain fields with the `fields` option.

- **businessName** ('always' | 'never' | 'auto') - Specify `always` to collect the business name. Specify `never` to not collect the business name. Default is `auto`.

##### validation (object)
By default, the Tax ID Element will enforce preset validation for each field. You can customize the settings by using this option.

- **businessName** (object)
  - **required** ('always' | 'never' | 'auto') - Specify `always` to make business name a required field. Specify `never` to make business name an optional field. Default is `auto`.
- **taxId** (object)
  - **required** ('always' | 'never' | 'auto') - Specify `always` to make tax ID a required field. Specify `never` to make tax ID an optional field. Default is `auto`.

#### verification (object)
Configure real-time tax ID verification. Requires a Tax Complete subscription or Tax Custom pricing. If your account isn't eligible, the Tax ID Element emits a loaderror event.

##### taxId (object)
- **mode** ('if_supported' | 'never') - Specify `if_supported` to enable real-time tax ID verification for supported tax ID types. Specify `never` to disable verification. Default is `never`.

#### onChange (function)
Callback called when any value in the change event payload changes.

#### onReady (function)
Callback called once the Element is fully rendered. Receives the ready event payload.

#### 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.

#### onLoaderStart (function)
Callback called right before Stripe displays the Element skeleton loader. Receives the Element instance as its only argument.

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

### Options

#### visibility ('always' | 'never' | 'auto')
By default, the Tax ID Element displays when the user is in a country that supports tax ID collection. Specify `always` to display the element regardless of the user's country. Specify `never` to hide the element completely.

#### fields (object)
By default, the Tax ID Element collects all tax ID information. If it's not necessary for you to collect all fields, you can disable Tax ID Element collection of certain fields with the `fields` option.

##### businessName ('always' | 'never' | 'auto')
Specify `always` to collect the business name. Specify `never` to not collect the business name. Default is `auto`.

#### validation (object)
By default, the Tax ID Element will enforce preset validation for each field. You can customize the settings by using this option.

##### businessName (object)
- **required** ('always' | 'never' | 'auto') - Specify `always` to make business name a required field. Specify `never` to make business name an optional field. Default is `auto`.

##### taxId (object)
- **required** ('always' | 'never' | 'auto') - Specify `always` to make tax ID a required field. Specify `never` to make tax ID an optional field. Default is `auto`.

#### verification (object)
Configure real-time tax ID verification. Requires a Tax Complete subscription or Tax Custom pricing. If your account isn't eligible, the Tax ID Element emits a loaderror event.

##### taxId (object)
- **mode** ('if_supported' | 'never') - Specify `if_supported` to enable real-time tax ID verification for supported tax ID types. Specify `never` to disable verification. Default is `never`.

#### onChange (function)
Callback called when any value in the change event payload changes.

#### onReady (function)
Callback called once the Element is fully rendered. Receives the ready event payload.

#### 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.

#### onLoaderStart (function)
Callback called right before Stripe displays the Element skeleton loader. Receives the Element instance as its only argument.

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

### Options

#### visibility ('always' | 'never' | 'auto')
By default, the Tax ID Element displays when the user is in a country that supports tax ID collection. Specify `always` to display the element regardless of the user's country. Specify `never` to hide the element completely.

#### fields (object)
By default, the Tax ID Element collects all tax ID information. If it's not necessary for you to collect all fields, you can disable Tax ID Element collection of certain fields with the `fields` option.

##### businessName ('always' | 'never' | 'auto')
Specify `always` to collect the business name. Specify `never` to not collect the business name. Default is `auto`.

#### validation (object)
By default, the Tax ID Element will enforce preset validation for each field. You can customize the settings by using this option.

##### businessName (object)
- **required** ('always' | 'never' | 'auto') - Specify `always` to make business name a required field. Specify `never` to make business name an optional field. Default is `auto`.

##### taxId (object)
- **required** ('always' | 'never' | 'auto') - Specify `always` to make tax ID a required field. Specify `never` to make tax ID an optional field. Default is `auto`.

#### verification (object)
Configure real-time tax ID verification. Requires a Tax Complete subscription or Tax Custom pricing. If your account isn't eligible, the Tax ID Element emits a loaderror event.

##### taxId (object)
- **mode** ('if_supported' | 'never') - Specify `if_supported` to enable real-time tax ID verification for supported tax ID types. Specify `never` to disable verification. Default is `never`.

#### onChange (function)
Callback called when any value in the change event payload changes.

#### onReady (function)
Callback called once the Element is fully rendered. Receives the ready event payload.

#### 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.

#### onLoaderStart (function)
Callback called right before Stripe displays the Element skeleton loader. Receives the Element instance as its only argument.

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

### Options

#### visibility ('always' | 'never' | 'auto')
By default, the Tax ID Element displays when the user is in a country that supports tax ID collection. Specify `always` to display the element regardless of the user's country. Specify `never` to hide the element completely.

#### fields (object)
By default, the Tax ID Element collects all tax ID information. If it's not necessary for you to collect all fields, you can disable Tax ID Element collection of certain fields with the `fields` option.

##### businessName ('always' | 'never' | 'auto')
Specify `always` to collect the business name. Specify `never` to not collect the business name. Default is `auto`.

#### validation (object)
By default, the Tax ID Element will enforce preset validation for each field. You can customize the settings by using this option.

##### businessName (object)
- **required** ('always' | 'never' | 'auto') - Specify `always` to make business name a required field. Specify `never` to make business name an optional field. Default is `auto`.

##### taxId (object)
- **required** ('always' | 'never' | 'auto') - Specify `always` to make tax ID a required field. Specify `never` to make tax ID an optional field. Default is `auto`.

#### verification (object)
Configure real-time tax ID verification. Requires a Tax Complete subscription or Tax Custom pricing. If your account isn't eligible, the Tax ID Element emits a loaderror event.

##### taxId (object)
- **mode** ('if_supported' | 'never') - Specify `if_supported` to enable real-time tax ID verification for supported tax ID types. Specify `never` to disable verification. Default is `never`.

#### onChange (function)
Callback called when any value in the change event payload changes.

#### onReady (function)
Callback called once the Element is fully rendered. Receives the ready event payload.

#### 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.

#### onLoaderStart (function)
Callback called right before Stripe displays the Element skeleton loader. Receives the Element instance as its only argument.

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

### Options

#### visibility ('always' | 'never' | 'auto')
By default, the Tax ID Element displays when the user is in a country that supports tax ID collection. Specify `always` to display the element regardless of the user's country. Specify `never` to hide the element completely.

#### fields (object)
By default, the Tax ID Element collects all tax ID information. If it's not necessary for you to collect all fields, you can disable Tax ID Element collection of certain fields with the `fields` option.

##### businessName ('always' | 'never' | 'auto')
Specify `always` to collect the business name. Specify `never` to not collect the business name. Default is `auto`.

#### validation (object)
By default, the Tax ID Element will enforce preset validation for each field. You can customize the settings by using this option.

##### businessName (object)
- **required** ('always' | 'never' | 'auto') - Specify `always` to make business name a required field. Specify `never` to make business name an optional field. Default is `auto`.

##### taxId (object)
- **required** ('always' | 'never' | 'auto') - Specify `always` to make tax ID a required field. Specify `never` to make tax ID an optional field. Default is `auto`.

#### verification (object)
Configure real-time tax ID verification. Requires a Tax Complete subscription or Tax Custom pricing. If your account isn't eligible, the Tax ID Element emits a loaderror event.

##### taxId (object)
- **mode** ('if_supported' | 'never') - Specify `if_supported` to enable real-time tax ID verification for supported tax ID types. Specify `never` to disable verification. Default is `never`.

#### onChange (function)
Callback called when any value in the change event payload changes.

#### onReady (function)
Callback called once the Element is fully rendered. Receives the ready event payload.

#### 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.

#### onLoaderStart (function)
Callback called right before Stripe displays the Element skeleton loader. Receives the Element instance as its only argument.

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

### Options

#### visibility ('always' | 'never' | 'auto')
By default, the Tax ID Element displays when the user is in a country that supports tax ID collection. Specify `always` to display the element regardless of the user's country. Specify `never` to hide the element completely.

#### fields (object)
By default, the Tax ID Element collects all tax ID information. If it's not necessary for you to collect all fields, you can disable Tax ID Element collection of certain fields with the `fields` option.

##### businessName ('always' | 'never' | 'auto')
Specify `always` to collect the business name. Specify `never` to not collect the business name. Default is `auto`.

#### validation (object)
By default, the Tax ID Element will enforce preset validation for each field. You can customize the settings by using this option.

##### businessName object
- **required** ('always' | 'never' | 'auto') - Specify `always` to make business name a required field. Specify `never` to make business name an optional field. Default is `auto`.

##### taxId object
- **required** ('always' | 'never' | 'auto') - Specify `always` to make tax ID a required field. Specify `never` to make tax ID an optional field. Default is `auto`.

#### verification object
Configure real-time tax ID verification. Requires a Tax Complete subscription or Tax Custom pricing. If your account isn't eligible, the Tax ID Element emits a loaderror event.

##### taxId object
- **mode** ('if_supported' | 'never') - Specify `if_supported` to enable real-time tax ID verification for supported tax ID types. Specify `never` to disable verification. Default is `never`.

#### onChange (function)
Callback called when any value in the change event payload changes.

#### onReady (function)
Callback called once the Element is fully rendered. Receives the ready event payload.

#### 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.

#### onLoaderStart (function)
Callback called right before Stripe displays the Element skeleton loader. Receives the Element instance as its only argument.

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

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

const stripePromise = loadStripe('pk_test_TYooMQauvdEDq54NiTphI7jx');

export const App = ({clientSecret}) => (
  <Elements stripe={stripePromise} options={{clientSecret}}>
    <TaxIdElement />
  </Elements>
);
```
```

--------------------------------

### Confirm with an existing PaymentMethod

Source: https://docs.stripe.com/js/tokens/create_token

Example of confirming a PaymentIntent using an existing PaymentMethod ID.

```APIDOC
## Confirm with an existing PaymentMethod

### Description
If you have already created a PaymentMethod, you can pass its id to payment_method and it will be used to confirm the PaymentIntent.

### Method
POST

### Endpoint
stripe.confirmPayByBankPayment

### Parameters
#### Request Body
- **payment_method** (string) - Required - The ID of an existing PaymentMethod.
- **return_url** (string) - Required - Return URL where the customer should be redirected after the authorization.

### Request Example
```
stripe
  .confirmPayByBankPayment('{PAYMENT_INTENT_CLIENT_SECRET}', {
    payment_method: '{PAYMENT_METHOD_ID}',
    // Return URL where the customer should be redirected after the authorization.
    return_url: window.location.href,
  })
  .then(function(result) {
    // Inform the customer that there was an error.
  });
```

### Response
#### Success Response (200)
- **result** (object) - The result object containing either paymentIntent or error.

#### Response Example
```
{
  "paymentIntent": {},
  "error": {}
}
```
```

--------------------------------

### Handle a card change event

Source: https://docs.stripe.com/js/tokens/create_token

Listens for the 'change' event on a cardElement to handle validation or completion states. The second block shows an example of the event object structure.

```javascript
cardElement.on('change', function(event) {
  if (event.complete) {
    // enable payment button
  } else if (event.error) {
    // show validation to customer
  }
});
```

```javascript
{
  complete: false,
  brand: 'visa',
  elementType: 'card',
  empty: false,
  error: undefined,
  value: { postalCode: "" },
}
```

--------------------------------

### Stripe.js Setup Intent Confirmation

Source: https://docs.stripe.com/js/element/events/on_click

Code examples for confirming SOFORT and TWINT setup intents using the Stripe.js library.

```APIDOC
## stripe.confirmSofortSetup(clientSecret, data?, options?)

### Description
Confirms a SetupIntent for SOFORT payments. It can be used with an existing PaymentMethod or with self-collected data.

### Method
stripe.confirmSofortSetup

### Parameters
- **clientSecret** (string) - Required - The client secret of the SetupIntent.
- **data** (object) - Optional - Data to be sent with the request.
- **options** (object) - Optional - An options object to control the behavior of this method.

#### Data Properties
- **payment_method** (string) - Required - The `id` of an existing PaymentMethod.
- **return_url** (string) - Recommended - The URL your customer will be directed to after they complete authentication.

### Request Example
```javascript
stripe
  .confirmSofortSetup('{SETUP_INTENT_CLIENT_SECRET}', {
    payment_method: '{PAYMENT_METHOD_ID}',
  })
  .then(function(result) {
    // Handle result.error or result.setupIntent
  });
```

### Returns
Returns a `Promise` that resolves with a `result` object containing either `setupIntent` or `error`.
```

```APIDOC
## stripe.confirmSofortSetup(clientSecret, data?, options?) - with self collected data

### Description
Confirms a SetupIntent for SOFORT payments using self-collected customer data. The customer's name, email, and country of their bank are required.

### Method
stripe.confirmSofortSetup

### Parameters
- **clientSecret** (string) - Required - The client secret of the SetupIntent.
- **data** (object) - Optional - Data to be sent with the request.
- **options** (object) - Optional - An options object to control the behavior of this method.

#### Data Properties
- **payment_method** (object) - Required - An object to confirm with the customer's name and email.
  - **country** (string) - Required - The country code where customer's bank is located.
  - **billing_details** (object) - Required - The customer's billing_details. `name` and `email` are required.
    - **name** (string) - Required - The customer's name.
    - **email** (string) - Required - The customer's email.
- **return_url** (string) - Recommended - The URL your customer will be directed to after they complete authentication.

### Request Example
```javascript
stripe
  .confirmSofortSetup('{SETUP_INTENT_CLIENT_SECRET}', {
    payment_method: {
      sofort: {
        country: 'DE'
      },
      billing_details: {
        name: 'Jenny Rosen',
        email: 'jenny@example.com',
      },
    },
    // Return URL where the customer should be redirected after the authorization.
    return_url: window.location.href,
  })
  .then(function(result) {
    if (result.error) {
      // Inform the customer that there was an error.
    }
  });
```

### Returns
Returns a `Promise` that resolves with a `result` object containing either `setupIntent` or `error`.
```

```APIDOC
## stripe.confirmTwintSetup(clientSecret, data?, options?)

### Description
Confirms a SetupIntent for TWINT payments. It automatically redirects the customer to authorize the setup and then back to the specified `return_url`.

### Method
stripe.confirmTwintSetup

### Parameters
- **clientSecret** (string) - Required - The client secret of the SetupIntent.
- **data** (object) - Optional - Data to be sent with the request.
- **options** (object) - Optional - An options object to control the behavior of this method.

#### Data Properties
- **payment_method** (object | string) - Optional - An object of collected data or an `id` of an existing PaymentMethod.
- **return_url** (string) - Required - The URL your customer is redirected to after they complete authorization.

#### Options Properties
- **handleActions** (boolean) - Optional - Set to `false` to manually handle the authorization redirect. Default is `true`.

### Request Example
```javascript
stripe
  .confirmTwintSetup('{SETUP_INTENT_CLIENT_SECRET}', {
    payment_method: {
      type: 'twint',
    },
    // Return URL where the customer is redirected after
    // the authorization.
    return_url: "https://example.com/setup/complete",
  })
  .then(function(result) {
    if (result.error) {
      // Inform the customer that there was an error.
    }
  });
```

### Returns
Returns a `Promise` that resolves with a `result` object containing either `setupIntent` or `error`.
```

--------------------------------

### Confirm SetupIntent methods

Source: https://docs.stripe.com/js/payment_intents

Documentation for confirming SetupIntents with self-collected iDEAL data and Klarna setup.

```APIDOC
## stripe.confirmIdealSetup(clientSecret,data)

### Description
Confirms a SetupIntent using customer's iDEAL bank data collected by yourself, without using the `idealBank` Element. This method accepts a payment method with the customer's bank and billing details, and a return URL for the customer to be redirected after authentication.

### Method
CONFIRM_IDEAL_SETUP

### Parameters
#### clientSecret (string) - Required
The client secret of the SetupIntent.

#### data (object)
Data argument properties:
- **payment_method** (object) - Required - An object to confirm using data collected by an `idealBank` Element.
  - **ideal** (object) - Required - An object detailing the customer's iDEAL bank.
    - **bank** (string) - Required - The customer's bank.
  - **billing_details** (object) - Required - The customer's billing details. `name` and `email` are required.
    - **name** (string) - Required - The customer's name.
    - **email** (string) - Required - The customer's email.
- **return_url** (string) - Recommended - The url your customer will be directed to after they complete authentication.

### Request Example
```
stripe
  .confirmIdealSetup('{SETUP_INTENT_CLIENT_SECRET}', {
    payment_method: {
      ideal: {
        bank: 'abn_amro',
      },
      billing_details: {
        name: 'Jenny Rosen',
        email: 'jenny@example.com',
      },
    },
    // Return URL where the customer should be redirected after the authorization.
    return_url: window.location.href,
  })
  .then(function(result) {
    if (result.error) {
      // Inform the customer that there was an error.
    }
  });
```

### Response
When successful, this method will trigger a redirect. If there is an error, it returns a `Promise` that resolves with a `result` object. That object either has `result.setupIntent` (the successful SetupIntent) or `result.error` (an error).
```

```APIDOC
## stripe.confirmKlarnaSetup(clientSecret,data?)

### Description
Confirms a SetupIntent in the Klarna Payments with Setup Intents flow when the customer submits your setup form. When called, it will confirm the `SetupIntent` with `data` you provide, and it will automatically redirect the customer to authorize the setup. Once authorization is complete, the customer will be redirected back to your specified `return_url`.

### Method
CONFIRM_KLARNA_SETUP

### Parameters
#### clientSecret (string) - Required
The client secret of the `SetupIntent`.

#### data (object) - Optional
Data to be sent with the request. Refer to the Setup Intents API for a full list of parameters.
- **payment_method** (string | object) - Optional - The `id` of an existing PaymentMethod. See the use case sections below for details.
- **return_url** (string) - Required - The url your customer will be directed to after they complete authentication.

### Request Example
```
stripe
  .confirmKlarnaSetup('{SETUP_INTENT_CLIENT_SECRET}', {
    payment_method: {
      billing_details: {
        email: 'jenny@example.com',
        address: {
          country: 'DE',
        },
      },
    },
    // Return URL where the customer should be redirected after
    // the authorization.
    return_url: "https://example.com/setup/complete",
  })
  .then(function(result) {
    if (result.error) {
      // Inform the customer that there was an error.
    }
  });
```

### Response
`stripe.confirmKlarnaSetup` will trigger a redirect when successful. If there is an error, it will return a `Promise` which resolves with a `result` object. This object has either:
- `result.setupIntent`: the successful SetupIntent.
- `result.error`: an error. Refer to the API reference for all possible errors.

Note that `stripe.confirmKlarnaSetup` may take several seconds to complete. During that time, you should disable your form from being resubmitted and show a waiting indicator like a spinner. If you receive an error result, you should be sure to show that error to the customer, re-enable the form, and hide the waiting indicator.
```

--------------------------------

### elements.update(options)

Source: https://docs.stripe.com/js/setup_intents/confirm_us_bank_account_setup

Updates options on an existing Elements instance. Not all options are updatable. Starting in Stripe.js `dahlia`, returns a Promise that resolves when the update has been applied to all rendered Elements.

```APIDOC
## elements.update(options)

### Description
Updates options on an existing Elements instance. Not all options are updatable. Starting in Stripe.js `dahlia`, returns a Promise that resolves when the update has been applied to all rendered Elements. You can also listen for the `update-end` event as an alternative to awaiting the Promise.

### Method
`elements.update(options)`

### Parameters
#### options (object) - Required
A set of options to update this Elements instance with.

### Request Example
```javascript
elements.update({
  // options to update
});
```

### Response
Returns a Promise that resolves when the update has been applied to all rendered Elements (starting in Stripe.js `dahlia`).
```

--------------------------------

### Confirm US Bank Account Setup

Source: https://docs.stripe.com/js/appendix/supported_browsers

Code examples for confirming a US bank account setup with an existing or attached PaymentMethod.

```APIDOC
## stripe.confirmUsBankAccountSetup

### Description
Confirms a SetupIntent for ACH Direct Debit payments using an existing PaymentMethod ID.

### Method
confirmUsBankAccountSetup

### Parameters
- **clientSecret** (string) - Required - The client secret of the SetupIntent.
- **data** (object) - Required - An object containing the payment method ID.
  - **payment_method** (string) - Required - The ID of an existing PaymentMethod.

### Request Example
```javascript
stripe.confirmUsBankAccountSetup(
  '{SETUP_INTENT_CLIENT_SECRET}',
  {
    payment_method: '{PAYMENT_METHOD_ID}',
  }
).then(function(result) {
  if (result.error) {
    // Inform the customer that there was an error.
    console.log(result.error.message);
  } else {
    // Handle next step based on SetupIntent's status.
    console.log("SetupIntent ID: " + result.setupIntent.id);
    console.log("SetupIntent status: " + result.setupIntent.status);
  }
});
```

### Response
- **error** (object) - Present if an error occurred.
- **setupIntent** (object) - The SetupIntent object with `id` and `status` properties.
```

```APIDOC
## stripe.confirmUsBankAccountSetup (with attached PaymentMethod)

### Description
Confirms a SetupIntent for ACH Direct Debit payments when a PaymentMethod has already been attached to the SetupIntent.

### Method
confirmUsBankAccountSetup

### Parameters
- **clientSecret** (string) - Required - The client secret of the SetupIntent.
- **data** (object) - Required - An empty object `{}`.

### Request Example
```javascript
stripe.confirmUsBankAccountSetup(
  '{SETUP_INTENT_CLIENT_SECRET}',
  {}
).then(function(result) {
  if (result.error) {
    // Inform the customer that there was an error.
    console.log(result.error.message);
  } else {
    // Handle next step based on SetupIntent's status.
    console.log("SetupIntent ID: " + result.setupIntent.id);
    console.log("SetupIntent status: " + result.setupIntent.status);
  }
});
```

### Response
- **error** (object) - Present if an error occurred.
- **setupIntent** (object) - The SetupIntent object with `id` and `status` properties.
```

--------------------------------

### stripe.handleCardSetup(clientSecret, data?)

Source: https://docs.stripe.com/js/appendix/cross_origin_isolation

Documentation for the stripe.handleCardSetup method, which confirms a SetupIntent and handles next actions.

```APIDOC
## stripe.handleCardSetup(clientSecret, data?)

### Description
Confirms a SetupIntent with a payment method and handles any required next actions, such as 3D Secure authentication. Returns a Promise that resolves with a result object containing either the successful SetupIntent or an error.

### Method
handleCardSetup

### Parameters
- **clientSecret** (string) - Required - The client secret of the SetupIntent to confirm.
- **data** (object) - Optional - Data to be sent with the request. Can contain `payment_method` (string) - The ID of an existing payment method, or `payment_method_data` (object) - Additional data relevant to the payment method, such as `billing_details` (object) - The billing details associated with the card.

### Returns
A Promise that resolves with a `result` object containing either:
- `result.setupIntent`: the successful SetupIntent.
- `result.error`: An error object.

### Example
```javascript
stripe
  .handleCardSetup('{SETUP_INTENT_CLIENT_SECRET}', {
    payment_method: '{PAYMENT_METHOD_ID}',
  })
  .then(function(result) {
    // Handle result.error or result.setupIntent
  });
```
```
Tokens:
Raw