@stripe/stripe-js

@stripe/stripe-js

Version 8.2.0
Published 4 days ago
936 kB
No dependencies
MIT license

Install

npm i @stripe/stripe-js

yarn add @stripe/stripe-js

pnpm add @stripe/stripe-js

Overview

Stripe.js loading utility

Index

Functions

function loadStripe

loadStripe: (
    publishableKey: string,
    options?: StripeConstructorOptions | undefined
) => Promise<Stripe | null>;

Interfaces

interface AccountAddressParam

interface AccountAddressParam {}

property city

city?: string;

City, district, suburb, town, or village.

property country

country?: string;

Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).

property line1

line1?: string;

Address line 1 (e.g., street, PO Box, or company name).

property line2

line2?: string;

Address line 2 (e.g., apartment, suite, unit, or building).

property postal_code

postal_code?: string;

ZIP or postal code.

property state

state?: string;

State, county, province, or region.

interface Address

interface Address {}

The Address object.

property city

city: string | null;

City/District/Suburb/Town/Village.

property country

country: string | null;

2-letter country code.

property line1

line1: string | null;

Address line 1 (Street address/PO Box/Company name).

property line2

line2: string | null;

Address line 2 (Apartment/Suite/Unit/Building).

property postal_code

postal_code: string | null;

ZIP or postal code.

property state

state: string | null;

State/County/Province/Region.

interface AddressParam

interface AddressParam extends AccountAddressParam {}

property line1

line1: string;

Address line 1 (e.g., street, PO Box, or company name).

interface Appearance

interface Appearance {}

property disableAnimations

disableAnimations?: boolean;

Disables animations throughout Elements. Defaults to false.

property inputs

inputs?: 'spaced' | 'condensed';

The style of input fields to use for the Elements. Defaults to 'spaced'. https://stripe.com/docs/stripe-js/appearance-api#inputs

property labels

labels?: 'auto' | 'above' | 'floating';

The style of labels associated with input fields to use for the Elements. Defaults to 'auto'. https://stripe.com/docs/stripe-js/appearance-api#labels

property rules

rules?: {
    [selector: string]: {
        [cssPropertyName: string]: string;
    };
};

property theme

theme?: 'stripe' | 'night' | 'flat';

The theme to use for the Elements. Defaults to 'stripe'.

property variables

variables?: {
    // General font styles
    fontFamily?: string;
    fontSmooth?: string;
    fontVariantLigatures?: string;
    fontVariationSettings?: string;
    fontLineHeight?: string;

    // Font sizes
    fontSizeBase?: string;
    fontSizeSm?: string;
    fontSizeXs?: string;
    fontSize2Xs?: string;
    fontSize3Xs?: string;
    fontSizeLg?: string;
    fontSizeXl?: string;

    // Font weights
    fontWeightLight?: string;
    fontWeightNormal?: string;
    fontWeightMedium?: string;
    fontWeightBold?: string;

    // Spacing
    spacingUnit?: string;
    gridRowSpacing?: string;
    gridColumnSpacing?: string;
    tabSpacing?: string;
    accordionItemSpacing?: string;
    /** @deprecated Use gridRowSpacing instead. */
    spacingGridRow?: string;
    /** @deprecated Use gridColumnSpacing instead. */
    spacingGridColumn?: string;
    /** @deprecated Use tabSpacing instead. */
    spacingTab?: string;
    /** @deprecated Use accordionItemSpacing instead. */
    spacingAccordionItem?: string;

    // Colors
    colorPrimary?: string;
    colorBackground?: string;
    colorText?: string;
    colorSuccess?: string;
    colorDanger?: string;
    colorWarning?: string;

    // Text variations
    colorTextSecondary?: string;
    colorTextPlaceholder?: string;

    // Accessible text
    accessibleColorOnColorPrimary?: string;
    accessibleColorOnColorBackground?: string;
    accessibleColorOnColorSuccess?: string;
    accessibleColorOnColorDanger?: string;
    accessibleColorOnColorWarning?: string;
    /** @deprecated Use accessibleColorOnColorPrimary instead. */
    colorPrimaryText?: string;
    /** @deprecated Use accessibleColorOnColorBackground instead. */
    colorBackgroundText?: string;
    /** @deprecated Use accessibleColorOnColorSuccess instead. */
    colorSuccessText?: string;
    /** @deprecated Use accessibleColorOnColorDanger instead. */
    colorDangerText?: string;
    /** @deprecated Use accessibleColorOnColorWarning instead. */
    colorWarningText?: string;

    // Icons
    iconColor?: string;
    iconHoverColor?: string;
    iconCardErrorColor?: string;
    iconCardCvcColor?: string;
    iconCardCvcErrorColor?: string;
    iconCheckmarkColor?: string;
    iconChevronDownColor?: string;
    iconChevronDownHoverColor?: string;
    iconCloseColor?: string;
    iconCloseHoverColor?: string;
    iconLoadingIndicatorColor?: string;
    iconMenuColor?: string;
    iconMenuHoverColor?: string;
    iconPasscodeDeviceColor?: string;
    iconPasscodeDeviceHoverColor?: string;
    iconPasscodeDeviceNotificationColor?: string;
    iconRedirectColor?: string;
    /** @deprecated Use iconColor instead. */
    colorIcon?: string;
    /** @deprecated Use iconHoverColor instead. */
    colorIconHover?: string;
    /** @deprecated Use iconCardErrorColor instead. */
    colorIconCardError?: string;
    /** @deprecated Use iconCardCvcColor instead. */
    colorIconCardCvc?: string;
    /** @deprecated Use iconCardCvcErrorColor instead. */
    colorIconCardCvcError?: string;
    /** @deprecated Use iconCheckmarkColor instead. */
    colorIconCheckmark?: string;
    /** @deprecated Use iconChevronDownColor instead. */
    colorIconChevronDown?: string;
    /** @deprecated Use iconChevronDownHoverColor instead. */
    colorIconChevronDownHover?: string;
    /** @deprecated Use iconRedirectColor instead. */
    colorIconRedirect?: string;

    // TabIcons
    tabIconColor?: string;
    tabIconHoverColor?: string;
    tabIconSelectedColor?: string;
    tabIconMoreColor?: string;
    tabIconMoreHoverColor?: string;
    /** @deprecated Use tabIconColor instead. */
    colorIconTab?: string;
    /** @deprecated Use tabIconHoverColor instead. */
    colorIconTabHover?: string;
    /** @deprecated Use tabIconHoverColor instead. */
    colorIconTabSelected?: string;
    /** @deprecated Use tabIconMoreColor instead. */
    colorIconTabMore?: string;
    /** @deprecated Use tabIconMoreHoverColor instead. */
    colorIconTabMoreHover?: string;

    // Logos
    logoColor?: string;
    tabLogoColor?: string;
    tabLogoSelectedColor?: string;
    blockLogoColor?: string;
    /** @deprecated Use logoColor instead. */
    colorLogo?: string;
    /** @deprecated Use tabLogoColor instead. */
    colorLogoTab?: string;
    /** @deprecated Use tabLogoSelectedColor instead. */
    colorLogoTabSelected?: string;
    /** @deprecated Use blockLogoColor instead. */
    colorLogoBlock?: string;

    // Focus
    focusBoxShadow?: string;
    focusOutline?: string;

    // Radius
    buttonBorderRadius?: string;
    borderRadius?: string;
};

interface BalanceRefresh

interface BalanceRefresh {}

property last_attempted_at

last_attempted_at: number;

Time at which the Balance Refresh was attempted. Measured in seconds since the Unix epoch.

property status

status: 'pending' | 'succeeded' | 'failed';

The status of the Balance Refresh

interface BankAccount

interface BankAccount {}

The BankAccount object.

property account_holder_name

account_holder_name: string | null;

The name of the person or business that owns the bank account.

property account_holder_type

account_holder_type: string | null;

The type of entity that holds the account. This can be either individual or company.

property bank_name

bank_name: string | null;

Name of the bank associated with the routing number (e.g., WELLS FARGO).

property country

country: string;

Two-letter ISO code representing the country the bank account is located in.

property currency

currency: string;

Three-letter [ISO code for the currency](https://stripe.com/docs/payouts) paid out to the bank account.

property fingerprint

fingerprint: string | null;

Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same.

property id

id: string;

Unique identifier for the object.

property last4

last4: string;

The last four digits of the bank account number.

property object

object: 'bank_account';

String representing the object's type. Objects of the same type share the same value.

property routing_number

routing_number: string | null;

The routing transit number for the bank account.

property status

status: string;

For bank accounts, possible values are new, validated, verified, verification_failed, or errored. A bank account that hasn't had any activity or validation performed is new. If Stripe can determine that the bank account exists, its status will be validated. Note that there often isn't enough information to know (e.g., for smaller credit unions), and the validation is not always run. If customer bank account verification has succeeded, the bank account status will be verified. If the verification failed for any reason, such as microdeposit failure, the status will be verification_failed. If a transfer sent to this bank account fails, we'll set the status to errored and will not continue to send transfers until the bank details are updated.
For external accounts, possible values are new and errored. Validations aren't run against external accounts because they're only used for payouts. This means the other statuses don't apply. If a transfer fails, the status is set to errored and transfers are stopped until account details are updated.

interface BaseStripeElementsOptions

interface BaseStripeElementsOptions {}

Options to create an Elements instance with.

property appearance

appearance?: Appearance;

Match the Payment Element with the design of your site with the appearance option. The layout of the Payment Element stays consistent, but you can modify colors, fonts, borders, padding, and more.
https://stripe.com/docs/stripe-js/appearance-api

property customerOptions

customerOptions?: CustomerOptions;

Requires beta access: Contact [Stripe support](https://support.stripe.com/) for more information.
Display saved PaymentMethods and Customer information. Supported for the payment, shippingAddress, and linkAuthentication Elements.

property customerSessionClientSecret

customerSessionClientSecret?: string;

Display saved PaymentMethods and Customer information.

property customPaymentMethods

customPaymentMethods?: CustomPaymentMethod[];

Display Custom Payment Methods in the Payment Element that you are already registered with.
https://docs.stripe.com/js/elements_object/create#stripe_elements-options-customPaymentMethods

property fonts

fonts?: Array<CssFontSource | CustomFontSource>;

An array of custom fonts, which elements created from the Elements object can use.

property loader

loader?: 'auto' | 'always' | 'never';

Display skeleton loader UI while waiting for Elements to be fully loaded, after they are mounted. Supported for the payment, shippingAddress, and linkAuthentication Elements. Default is 'auto' (Stripe determines if a loader UI should be shown).

property locale

locale?: StripeElementLocale;

The [IETF language tag](https://en.wikipedia.org/wiki/IETF_language_tag) of the locale to display placeholders and error strings in. Default is auto (Stripe detects the locale of the browser). Setting the locale does not affect the behavior of postal code validation—a valid postal code for the billing country of the card is still required.

property syncAddressCheckbox

syncAddressCheckbox?: 'billing' | 'shipping' | 'none';

The syncAddressCheckbox parameter configures which Address Element to show the checkbox above when using 2 Address Elements.
Default is 'billing'
https://docs.stripe.com/js/elements_object/create#stripe_elements-options-syncAddressCheckbox

interface Card

interface Card {}

The Card object.

property address_city

address_city: string | null;

City/District/Suburb/Town/Village.

property address_country

address_country: string | null;

Billing address country, if provided when creating card.

property address_line1

address_line1: string | null;

Address line 1 (Street address/PO Box/Company name).

property address_line1_check

address_line1_check: string | null;

If address_line1 was provided, results of the check: pass, fail, unavailable, or unchecked.

property address_line2

address_line2: string | null;

Address line 2 (Apartment/Suite/Unit/Building).

property address_state

address_state: string | null;

State/County/Province/Region.

property address_zip

address_zip: string | null;

ZIP or postal code.

property address_zip_check

address_zip_check: string | null;

If address_zip was provided, results of the check: pass, fail, unavailable, or unchecked.

property brand

brand: string;

Card brand. Can be American Express, Diners Club, Discover, JCB, MasterCard, UnionPay, Visa, or Unknown.

property country

country: string | null;

Two-letter ISO code representing the country of the card. You could use this attribute to get a sense of the international breakdown of cards you've collected.

property currency

currency?: string | null;

Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).

property customer

customer?: string | null;

The customer that this card belongs to. This attribute will not be in the card object if the card belongs to an account or recipient instead.

property cvc_check

cvc_check: string | null;

If a CVC was provided, results of the check: pass, fail, unavailable, or unchecked.

property dynamic_last4

dynamic_last4: string | null;

(For tokenized numbers only.) The last four digits of the device account number.

property exp_month

exp_month: number;

Two-digit number representing the card's expiration month.

property exp_year

exp_year: number;

Four-digit number representing the card's expiration year.

property fingerprint

fingerprint?: string | null;

Uniquely identifies this particular card number. You can use this attribute to check whether two customers who've signed up with you are using the same card number, for example.

property funding

funding: string;

Card funding type. Can be credit, debit, prepaid, or unknown.

property id

id: string;

Unique identifier for the object.

property last4

last4: string;

The last four digits of the card.

property metadata

metadata: Metadata;

Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.

property name

name: string | null;

Cardholder name.

property object

object: 'card';

String representing the object's type. Objects of the same type share the same value.

property tokenization_method

tokenization_method: string | null;

If the card number is tokenized, this is the method that was used. Can be apple_pay or google_pay.

interface CashBalance

interface CashBalance {}

property cash

cash: {
    /**
     * The funds available to the account holder. Typically this is the
     * current balance less any holds.
     *
     * Each key is a three-letter ISO currency code, in lowercase.
     *
     * Each value is a integer amount. A positive amount indicates money owed
     * to the account holder. A negative amount indicates money owed by the
     * account holder.
     */
    available: { [key: string]: number | undefined };
};

Information on a cash balance. Only set if balance.type is cash.

property type

type: 'cash';

interface CollectBankAccountForPaymentOptions

interface CollectBankAccountForPaymentOptions {}

Data to be sent with a stripe.collectBankAccountForPayment request.

property clientSecret

clientSecret: string;

The client secret of the PaymentIntent.

property expand

expand?: Array<string>;

Specifies which fields in the response should be expanded.

property params

params: CollectBankAccountParams;

interface CollectBankAccountForSetupOptions

interface CollectBankAccountForSetupOptions {}

Data to be sent with a stripe.collectBankAccountForSetup request.

property clientSecret

clientSecret: string;

The client secret of the SetupIntent.

property expand

expand?: Array<string>;

Specifies which fields in the response should be expanded.

property params

params: CollectBankAccountParams;

interface CollectBankAccountParams

interface CollectBankAccountParams {}

property payment_method_data

payment_method_data: CollectBankAccountPaymentMethodData;

Payment method specific data to be sent with the request (billing details)

property payment_method_type

payment_method_type: string;

The payment method type for the bank account details (e.g. us_bank_account)

interface CollectBankAccountPaymentMethodData

interface CollectBankAccountPaymentMethodData {}

property billing_details

billing_details: PaymentMethodCreateParams.BillingDetails;

The customer's billing details. name, email, and address are required.
https://stripe.com/docs/api/payment_methods/create#create_payment_method-billing_details

property metadata

metadata?: Record<string, string>;

Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them https://docs.stripe.com/metadata

interface CollectBankAccountTokenOptions

interface CollectBankAccountTokenOptions {}

Data to be sent with a stripe.collectBankAccountToken request.

property clientSecret

clientSecret: string;

The client secret of the [Financial Connections Session](https://stripe.com/docs/api/financial_connections/session).

interface CollectFinancialConnectionsAccountsOptions

interface CollectFinancialConnectionsAccountsOptions {}

Data to be sent with a stripe.collectFinancialConnectionsAccounts request.

property clientSecret

clientSecret: string;

The client secret of the [Financial Connections Session](https://stripe.com/docs/api/financial_connections/session).

interface CommonBalance

interface CommonBalance {}

property as_of

as_of: number;

The time that the external institution calculated this balance. Measured in seconds since the Unix epoch.

property current

current: {
    [key: string]: number | undefined;
};

The balances owed to (or by) the account holder.
Each key is a three-letter ISO currency code, in lowercase.
Each value is a integer amount. A positive amount indicates money owed to the account holder. A negative amount indicates money owed by the account holder.

interface ConfirmAcssDebitPaymentData

interface ConfirmAcssDebitPaymentData extends PaymentIntentConfirmParams {}

Data to be sent with a stripe.confirmAcssDebitPayment request. Refer to the [Payment Intents API](https://stripe.com/docs/api/payment_intents/confirm) for a full list of parameters.

property payment_method

payment_method?: string | Omit<CreatePaymentMethodAcssDebitData, 'type'>;

Either the id of an existing [PaymentMethod](https://stripe.com/docs/api/payment_methods), or an object containing data to create a PaymentMethod with. This field is optional if a PaymentMethod has already been attached to this PaymentIntent.

interface ConfirmAcssDebitPaymentOptions

interface ConfirmAcssDebitPaymentOptions {}

An options object to control the behavior of stripe.confirmAcssDebitPayment.

property skipMandate

skipMandate?: boolean;

Set skipMandate to true if you want to skip displaying the mandate confirmation screen.

interface ConfirmAcssDebitSetupData

interface ConfirmAcssDebitSetupData extends SetupIntentConfirmParams {}

Data to be sent with a stripe.confirmAcssDebitSetup request. Refer to the [Setup Intents API](https://stripe.com/docs/api/setup_intents/confirm) for a full list of parameters.

property expand

expand?: Array<string>;

Specifies which fields in the response should be expanded.

property payment_method

payment_method?: string | Omit<CreatePaymentMethodAcssDebitData, 'type'>;

Either the id of an existing [PaymentMethod](https://stripe.com/docs/api/payment_methods), or an object containing data to create a PaymentMethod with. This field is optional if a PaymentMethod has already been attached to this SetupIntent.

interface ConfirmAcssDebitSetupOptions

interface ConfirmAcssDebitSetupOptions {}

An options object to control the behavior of stripe.confirmAcssDebitSetup.

property skipMandate

skipMandate?: boolean;

Set this to true if you want to skip displaying the mandate confirmation.

interface ConfirmAffirmPaymentData

interface ConfirmAffirmPaymentData extends PaymentIntentConfirmParams {}

Data to be sent with a stripe.confirmAffirmPayment request. Refer to the [Payment Intents API](https://stripe.com/docs/api/payment_intents/confirm) for a full list of parameters.

property payment_method

payment_method?: string | Omit<CreatePaymentMethodAffirmData, 'type'>;

Either the id of an existing [PaymentMethod](https://stripe.com/docs/api/payment_methods), or an object containing data to create a PaymentMethod with. This field is optional if a PaymentMethod has already been attached to this PaymentIntent.

property return_url

return_url?: string;

The url your customer will be directed to after they complete authentication.

interface ConfirmAffirmPaymentOptions

interface ConfirmAffirmPaymentOptions {}

An options object to control the behavior of stripe.confirmAffirmPayment.

property handleActions

handleActions?: boolean;

Set this to false if you want to handle next actions yourself. Please refer to our [Stripe Affirm integration guide](https://stripe.com/docs/payments/affirm/accept-a-payment) for more info. Default is true.

interface ConfirmAfterpayClearpayPaymentData

interface ConfirmAfterpayClearpayPaymentData extends PaymentIntentConfirmParams {}

Data to be sent with a stripe.confirmAfterpayClearpayPayment request. Refer to the [Payment Intents API](https://stripe.com/docs/api/payment_intents/confirm) for a full list of parameters.

property payment_method

payment_method?: string | Omit<CreatePaymentMethodAfterpayClearpayData, 'type'>;

Either the id of an existing [PaymentMethod](https://stripe.com/docs/api/payment_methods), or an object containing data to create a PaymentMethod with. This field is optional if a PaymentMethod has already been attached to this PaymentIntent.

property return_url

return_url?: string;

The url your customer will be directed to after they complete authentication.

interface ConfirmAfterpayClearpayPaymentOptions

interface ConfirmAfterpayClearpayPaymentOptions {}

An options object to control the behavior of stripe.confirmAfterpayClearpayPayment.

property handleActions

handleActions?: boolean;

Set this to false if you want to handle next actions yourself. Please refer to our [Stripe Afterpay / Clearpay integration guide](https://stripe.com/docs/payments/afterpay-clearpay/accept-a-payment#handle-redirect) for more info. Default is true.

interface ConfirmAlipayPaymentData

interface ConfirmAlipayPaymentData extends PaymentIntentConfirmParams {}

Data to be sent with a stripe.confirmAlipayPayment request. Refer to the [Payment Intents API](https://stripe.com/docs/api/payment_intents/confirm) for a full list of parameters.

property payment_method

payment_method?: string | Omit<CreatePaymentMethodAlipayData, 'type'>;

The id of an existing [PaymentMethod](https://stripe.com/docs/api/payment_methods). This field is optional if a PaymentMethod has already been attached to this PaymentIntent or a new PaymentMethod will be created.

property return_url

return_url?: string;

The url your customer will be directed to after they complete authentication.

interface ConfirmAlipayPaymentOptions

interface ConfirmAlipayPaymentOptions {}

An options object to control the behavior of stripe.confirmAlipayPayment.

property handleActions

handleActions?: boolean;

Set this to false if you want to [manually handle the authorization redirect](https://stripe.com/docs/payments/alipay/accept-a-payment#handle-redirect). Default is true.

interface ConfirmationToken

interface ConfirmationToken {}

The ConfirmationToken object.

property created

created: number;

Time at which the object was created. Measured in seconds since the Unix epoch.

property expires_at

expires_at: number;

Time at which this ConfirmationToken expires and can no longer be used to confirm a PaymentIntent or SetupIntent. This is set to null once this ConfirmationToken has been used. Measured in seconds since the Unix epoch.

property id

id: string;

Unique identifier for the object.

property livemode

livemode: boolean;

Has the value true if the object exists in live mode or the value false if the object exists in test mode.

property object

object: 'confirmation_token';

String representing the object's type. Objects of the same type share the same value.

property payment_intent

payment_intent: null | string;

ID of the PaymentIntent that this ConfirmationToken was used to confirm, or null if this ConfirmationToken has not yet been used.

property payment_method_preview

payment_method_preview: ConfirmationToken.PaymentMethodPreview;

Payment details collected by the Payment Element, used to create a PaymentMethod when a PaymentIntent or SetupIntent is confirmed with this ConfirmationToken.

property return_url

return_url: string | null;

The URL your customer is redirected to after they complete the payment.

property setup_future_usage

setup_future_usage: PaymentIntent.SetupFutureUsage | null;

Indicates that you intend to make future payments with this ConfirmationToken’s payment method.
The presence of this property will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent’s Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete.
Stripe uses setup_future_usage to dynamically optimize your payment flow and comply with regional legislation and network rules. For example, if your customer is impacted by [SCA](https://stripe.com/docs/strong-customer-authentication), using off_session will ensure that they are authenticated while processing this PaymentIntent. You will then be able to collect [off-session payments](https://stripe.com/docs/payments/cards/charging-saved-cards#off-session-payments-with-saved-cards) for this customer.

property setup_intent

setup_intent: null | string;

ID of the SetupIntent that this ConfirmationToken was used to confirm, or null if this ConfirmationToken has not yet been used.

property shipping

shipping: PaymentIntent.Shipping | null;

Shipping information for this ConfirmationToken.

property use_stripe_sdk

use_stripe_sdk: boolean;

Set to true when confirming server-side and using Stripe.js, iOS, or Android client-side SDKs to handle the next actions.

interface ConfirmationTokenCreateParams

interface ConfirmationTokenCreateParams {}

property payment_method_data

payment_method_data?: {
    /**
     * The customer's billing details.
     */
    billing_details?: PaymentMethodCreateParams.BillingDetails;

    /**
     * Specifies if the PaymentMethod should be redisplayed when using the Saved Payment Method feature
     */
    allow_redisplay?: 'always' | 'limited' | 'unspecified';

    /**
     * Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
     * Individual keys can be unset by posting an empty value to them
     * @docs https://docs.stripe.com/metadata
     */
    metadata?: Record<string, string>;
};

Data used to create a new payment method.

property return_url

return_url?: string | null;

The url your customer will be directed to after they complete authentication.

property shipping

shipping?: ConfirmationToken.Shipping;

Shipping information.

interface ConfirmAuBecsDebitPaymentData

interface ConfirmAuBecsDebitPaymentData extends PaymentIntentConfirmParams {}

Data to be sent with a stripe.confirmAuBecsDebitPayment request. Refer to the [Payment Intents API](https://stripe.com/docs/api/payment_intents/confirm) for a full list of parameters.

property payment_method

payment_method?: string | Omit<CreatePaymentMethodAuBecsDebitData, 'type'>;

Either the id of an existing [PaymentMethod](https://stripe.com/docs/api/payment_methods), or an object containing data to create a PaymentMethod with. This field is optional if a PaymentMethod has already been attached to this PaymentIntent.

property setup_future_usage

setup_future_usage?: 'off_session';

To save the BECS Direct Debit account for reuse, set this parameter to off_session. BECS Direct Debit only accepts an off_session value for this parameter.

interface ConfirmAuBecsDebitSetupData

interface ConfirmAuBecsDebitSetupData extends SetupIntentConfirmParams {}

Data to be sent with a stripe.confirmAuBecsDebitSetup request. Refer to the [Setup Intents API](https://stripe.com/docs/api/setup_intents/confirm) for a full list of parameters.

property payment_method

payment_method?: string | Omit<CreatePaymentMethodAuBecsDebitData, 'type'>;

interface ConfirmBacsDebitSetupData

interface ConfirmBacsDebitSetupData extends SetupIntentConfirmParams {}

Data to be sent with a stripe.confirmBacsDebitSetup request. Refer to the [Setup Intents API](https://stripe.com/docs/api/setup_intents/confirm) for a full list of parameters.

property payment_method

payment_method?: string | Omit<CreatePaymentMethodBacsDebitData, 'type'>;

interface ConfirmBancontactPaymentData

interface ConfirmBancontactPaymentData extends PaymentIntentConfirmParams {}

Data to be sent with a stripe.confirmBancontactPayment request. Refer to the [Payment Intents API](https://stripe.com/docs/api/payment_intents/confirm) for a full list of parameters.

property payment_method

payment_method?: string | Omit<CreatePaymentMethodBancontactData, 'type'>;

Either the id of an existing [PaymentMethod](https://stripe.com/docs/api/payment_methods), or an object containing data to create a PaymentMethod with. This field is optional if a PaymentMethod has already been attached to this PaymentIntent.

property return_url

return_url?: string;

The url your customer will be directed to after they complete authentication.

interface ConfirmBancontactPaymentOptions

interface ConfirmBancontactPaymentOptions {}

An options object to control the behavior of stripe.confirmBancontactPayment.

property handleActions

handleActions?: boolean;

Set this to false if you want to [manually handle the authorization redirect](https://stripe.com/docs/payments/bancontact#handle-redirect). Default is true.

interface ConfirmBancontactSetupData

interface ConfirmBancontactSetupData extends SetupIntentConfirmParams {}

Data to be sent with a stripe.confirmBancontactSetup request. Refer to the [Setup Intents API](https://stripe.com/docs/api/setup_intents/confirm) for a full list of parameters.

property payment_method

payment_method?: string | Omit<CreatePaymentMethodBancontactData, 'type'>;

interface ConfirmBilliePaymentData

interface ConfirmBilliePaymentData extends PaymentIntentConfirmParams {}

Data to be sent with a stripe.confirmBilliePayment request. Refer to the [Payment Intents API](https://stripe.com/docs/api/payment_intents/confirm) for a full list of parameters.

property payment_method

payment_method?: string | Omit<CreatePaymentMethodBillieData, 'type'>;

Either the id of an existing [PaymentMethod](https://stripe.com/docs/api/payment_methods), or an object containing data to create a PaymentMethod with. This field is optional if a PaymentMethod has already been attached to this PaymentIntent.

property return_url

return_url?: string;

The url your customer will be directed to after they complete authentication.

interface ConfirmBilliePaymentOptions

interface ConfirmBilliePaymentOptions {}

An options object to control the behavior of stripe.confirmBilliePayment.

property handleActions

handleActions?: boolean;

Set this to false if you want to [manually handle the authorization redirect](https://docs.stripe.com/payments/billie/accept-a-payment#handle-redirect). Default is true.

interface ConfirmBlikPaymentData

interface ConfirmBlikPaymentData extends PaymentIntentConfirmParams {}

Data to be sent with a stripe.ConfirmBlikPayment request. Refer to the [Payment Intents API](https://stripe.com/docs/api/payment_intents/confirm) for a full list of parameters.

property payment_method

payment_method?: string | Omit<CreatePaymentMethodBlikData, 'type'>;

Either the id of an existing [PaymentMethod](https://stripe.com/docs/api/payment_methods), or an object containing data to create a PaymentMethod with. This field is optional if a PaymentMethod has already been attached to this PaymentIntent.

property payment_method_options

payment_method_options: {
    /**
     * A configuration for this BLIK payment.
     */
    blik: {
        /**
         * Your customer's 6-digit BLIK code.
         */
        code: string;
    };
};

An object containing payment-method-specific configuration to confirm the [PaymentIntent](https://stripe.com/docs/api/payment_intents) with.

interface ConfirmBlikPaymentOptions

interface ConfirmBlikPaymentOptions {}

An options object to control the behavior of stripe.confirmBlikPayment.

property handleActions

handleActions?: boolean;

Set this to false if you want to manually determine if the confirmation has succeeded or failed.

interface ConfirmBoletoPaymentData

interface ConfirmBoletoPaymentData extends PaymentIntentConfirmParams {}

Data to be sent with a stripe.confirmBoletoPayment request. Refer to the [Payment Intents API](https://stripe.com/docs/api/payment_intents/confirm) for a full list of parameters.

property payment_method

payment_method?: string | Omit<CreatePaymentMethodBoletoData, 'type'>;

Either the id of an existing [PaymentMethod](https://stripe.com/docs/api/payment_methods), or an object containing data to create a PaymentMethod with. This field is optional if a PaymentMethod has already been attached to this PaymentIntent.

interface ConfirmBoletoPaymentOptions

interface ConfirmBoletoPaymentOptions {}

An options object to control the behavior of stripe.confirmBoletoPayment.

property handleActions

handleActions?: boolean;

Set this to false if you want to handle next actions yourself. Please refer to our [Stripe Boleto integration guide](https://stripe.com/docs/payments/boleto) for more info. Default is true.

interface ConfirmCardPaymentData

interface ConfirmCardPaymentData extends PaymentIntentConfirmParams {}

Data to be sent with a stripe.confirmCardPayment request. Refer to the [Payment Intents API](https://stripe.com/docs/api/payment_intents/confirm) for a full list of parameters.

property payment_method

payment_method?: string | Omit<CreatePaymentMethodCardData, 'type'>;

Either the id of an existing [PaymentMethod](https://stripe.com/docs/api/payment_methods), or an object containing data to create a PaymentMethod with. This field is optional if a PaymentMethod has already been attached to this PaymentIntent.

property payment_method_options

payment_method_options?: {
    /**
     * Configuration for this card payment.
     */
    card: {
        /**
         * Use the provided `CardCvcElement` when confirming the PaymentIntent with an existing PaymentMethod.
         */
        cvc?: StripeCardCvcElement;

        /**
         * Selected network to process this PaymentIntent on. Depends on the available networks of the card attached to the PaymentIntent.
         */
        network?: string;
    };
};

An object containing payment-method-specific configuration to confirm the [PaymentIntent](https://stripe.com/docs/api/payment_intents) with.

interface ConfirmCardPaymentOptions

interface ConfirmCardPaymentOptions {}

An options object to control the behavior of stripe.confirmCardPayment.

property handleActions

handleActions?: boolean;

Set this to false if you want to [handle next actions yourself](https://stripe.com/docs/payments/payment-intents/verifying-status#next-actions), or if you want to defer next action handling until later (e.g. for use in the [PaymentRequest API](https://stripe.com/docs/stripe-js/elements/payment-request-button#complete-payment-intents)). Default is true.

interface ConfirmCardSetupData

interface ConfirmCardSetupData extends SetupIntentConfirmParams {}

Data to be sent with a stripe.confirmCardSetup request. Refer to the [Setup Intents API](https://stripe.com/docs/api/setup_intents/confirm) for a full list of parameters.

property payment_method

payment_method?: string | Omit<CreatePaymentMethodCardData, 'type'>;

interface ConfirmCardSetupOptions

interface ConfirmCardSetupOptions {}

An options object to control the behavior of stripe.confirmCardSetup.

property handleActions

handleActions?: boolean;

interface ConfirmCashappPaymentData

interface ConfirmCashappPaymentData extends PaymentIntentConfirmParams {}

Data to be sent with a stripe.confirmCashappPayment request. Refer to the [Payment Intents API](https://stripe.com/docs/api/payment_intents/confirm) for a full list of parameters.

property payment_method

payment_method?: string | Omit<CreatePaymentMethodCashappData, 'type'>;

The id of an existing [PaymentMethod](https://stripe.com/docs/api/payment_methods). This field is optional if a PaymentMethod has already been attached to this PaymentIntent or a new PaymentMethod will be created.

property return_url

return_url?: string;

The url your customer will be directed to after they complete authentication.

interface ConfirmCashappPaymentOptions

interface ConfirmCashappPaymentOptions {}

An options object to control the behavior of stripe.confirmCashappPayment.

property handleActions

handleActions?: boolean;

Set this to false if you want to [manually handle the authorization QR code or redirect](https://stripe.com/docs/payments/cash-app-pay/accept-a-payment?platform=web&ui=API#handle-redirect). Default is true.

interface ConfirmCashappSetupData

interface ConfirmCashappSetupData extends SetupIntentConfirmParams {}

property payment_method

payment_method?: string | Omit<CreatePaymentMethodCashappData, 'type'>;

property return_url

return_url?: string;

The url your customer will be directed to after they complete authentication.

interface ConfirmCashappSetupOptions

interface ConfirmCashappSetupOptions {}

An options object to control the behavior of stripe.confirmCashappSetup.

property handleActions

handleActions?: boolean;

interface ConfirmCustomerBalancePaymentData

interface ConfirmCustomerBalancePaymentData extends PaymentIntentConfirmParams {}

Data to be sent with a stripe.confirmCustomerBalancePayment request. Refer to the [Payment Intents API](https://stripe.com/docs/api/payment_intents/confirm) for a full list of parameters.

property payment_method

payment_method: CreatePaymentMethodCustomerBalanceData;

An object specifying the customer_balance type.

property payment_method_options

payment_method_options?: {
    customer_balance?: {
        funding_type?: 'bank_transfer';
        bank_transfer?: {
            type:
                | 'eu_bank_transfer'
                | 'gb_bank_transfer'
                | 'id_bank_transfer'
                | 'jp_bank_transfer'
                | 'mx_bank_transfer'
                | 'us_bank_transfer';
            eu_bank_transfer?: {
                country: 'DE' | 'ES' | 'FR' | 'IE' | 'NL';
            };
            id_bank_transfer?: {
                bank: 'bni' | 'bca';
            };
            requested_address_types?: Array<
                | 'aba'
                | 'swift'
                | 'sort_code'
                | 'zengin'
                | 'iban'
                | 'spei'
                | 'id_bban'
                | 'sepa'
            >;
        };
    };
};

interface ConfirmCustomerBalancePaymentOptions

interface ConfirmCustomerBalancePaymentOptions {}

An options object to control the behavior of stripe.confirmCustomerBalancePayment.

property handleActions

handleActions: false;

This must be set to false. The Customer Balance does not handle the next actions for you automatically (e.g. displaying bank transfer details). To make future upgrades easier, this option is required to always be sent. Please refer to our [Stripe Customer Balance integration guide](https://stripe.com/docs/payments/bank-transfers) for more info.

interface ConfirmEpsPaymentData

interface ConfirmEpsPaymentData extends PaymentIntentConfirmParams {}

Data to be sent with a stripe.confirmEpsPayment request. Refer to the [Payment Intents API](https://stripe.com/docs/api/payment_intents/confirm) for a full list of parameters.

property payment_method

payment_method?: string | Omit<CreatePaymentMethodEpsData, 'type'>;

Either the id of an existing [PaymentMethod](https://stripe.com/docs/api/payment_methods), or an object containing data to create a PaymentMethod with. This field is optional if a PaymentMethod has already been attached to this PaymentIntent.

property return_url

return_url?: string;

The url your customer will be directed to after they complete authentication.

interface ConfirmEpsPaymentOptions

interface ConfirmEpsPaymentOptions {}

An options object to control the behavior of stripe.confirmEpsPayment.

property handleActions

handleActions?: boolean;

Set this to false if you want to [manually handle the authorization redirect](https://stripe.com/docs/payments/eps#handle-redirect). Default is true.

interface ConfirmFpxPaymentData

interface ConfirmFpxPaymentData extends PaymentIntentConfirmParams {}

Data to be sent with a stripe.confirmFpxPayment request. Refer to the [Payment Intents API](https://stripe.com/docs/api/payment_intents/confirm) for a full list of parameters.

property payment_method

payment_method?: string | Omit<CreatePaymentMethodFpxData, 'type'>;

Either the id of an existing [PaymentMethod](https://stripe.com/docs/api/payment_methods), or an object containing data to create a PaymentMethod with. This field is optional if a PaymentMethod has already been attached to this PaymentIntent.

property return_url

return_url?: string;

The url your customer will be directed to after they complete authentication.

interface ConfirmFpxPaymentOptions

interface ConfirmFpxPaymentOptions {}

An options object to control the behavior of stripe.confirmFpxPayment.

property handleActions

handleActions?: boolean;

Set this to false if you want to [manually handle the authorization redirect](https://stripe.com/docs/payments/fpx#handle-redirect). Default is true.

interface ConfirmGiropayPaymentData

interface ConfirmGiropayPaymentData extends PaymentIntentConfirmParams {}

Data to be sent with a stripe.confirmGiropayPayment request. Refer to the [Payment Intents API](https://stripe.com/docs/api/payment_intents/confirm) for a full list of parameters.

property payment_method

payment_method?: string | Omit<CreatePaymentMethodGiropayData, 'type'>;

Either the id of an existing [PaymentMethod](https://stripe.com/docs/api/payment_methods), or an object containing data to create a PaymentMethod with. This field is optional if a PaymentMethod has already been attached to this PaymentIntent.

property return_url

return_url?: string;

The url your customer will be directed to after they complete authentication.

interface ConfirmGiropayPaymentOptions

interface ConfirmGiropayPaymentOptions {}

An options object to control the behavior of stripe.confirmGiropayPayment.

property handleActions

handleActions?: boolean;

Set this to false if you want to [manually handle the authorization redirect](https://stripe.com/docs/payments/giropay#handle-redirect). Default is true.

interface ConfirmGrabPayPaymentData

interface ConfirmGrabPayPaymentData extends PaymentIntentConfirmParams {}

Data to be sent with a stripe.confirmGrabPayPayment request. Refer to the [Payment Intents API](https://stripe.com/docs/api/payment_intents/confirm) for a full list of parameters.

property payment_method

payment_method?: string | Omit<CreatePaymentMethodGrabPayData, 'type'>;

Either the id of an existing [PaymentMethod](https://stripe.com/docs/api/payment_methods), or an object containing data to create a PaymentMethod with. This field is optional if a PaymentMethod has already been attached to this PaymentIntent.

property return_url

return_url?: string;

The url your customer will be directed to after they complete authentication.

interface ConfirmGrabPayPaymentOptions

interface ConfirmGrabPayPaymentOptions {}

An options object to control the behavior of stripe.confirmGrabPayPayment.

property handleActions

handleActions?: boolean;

Set this to false if you want to handle next actions yourself. Please refer to our [Stripe GrabPay integration guide](https://stripe.com/docs/payments/grabpay/accept-a-payment) for more info. Default is true.

interface ConfirmIdealPaymentData

interface ConfirmIdealPaymentData extends PaymentIntentConfirmParams {}

Data to be sent with a stripe.confirmIdealPayment request. Refer to the [Payment Intents API](https://stripe.com/docs/api/payment_intents/confirm) for a full list of parameters.

property payment_method

payment_method?: string | Omit<CreatePaymentMethodIdealData, 'type'>;

Either the id of an existing [PaymentMethod](https://stripe.com/docs/api/payment_methods), or an object containing data to create a PaymentMethod with. This field is optional if a PaymentMethod has already been attached to this PaymentIntent.

property return_url

return_url?: string;

The url your customer will be directed to after they complete authentication.

interface ConfirmIdealPaymentOptions

interface ConfirmIdealPaymentOptions {}

An options object to control the behavior of stripe.confirmIdealPayment.

property handleActions

handleActions?: boolean;

Set this to false if you want to [manually handle the authorization redirect](https://stripe.com/docs/payments/ideal#handle-redirect). Default is true.

interface ConfirmIdealSetupData

interface ConfirmIdealSetupData extends SetupIntentConfirmParams {}

Data to be sent with a stripe.confirmIdealSetup request. Refer to the [Setup Intents API](https://stripe.com/docs/api/setup_intents/confirm) for a full list of parameters.

property payment_method

payment_method?: string | Omit<CreatePaymentMethodIdealData, 'type'>;

interface ConfirmKlarnaPaymentData

interface ConfirmKlarnaPaymentData extends PaymentIntentConfirmParams {}

Data to be sent with a stripe.confirmKlarnaPayment request. Refer to the [Payment Intents API](https://stripe.com/docs/api/payment_intents/confirm) for a full list of parameters.

property payment_method

payment_method?: string | Omit<CreatePaymentMethodKlarnaData, 'type'>;

Either the id of an existing [PaymentMethod](https://stripe.com/docs/api/payment_methods), or an object containing data to create a PaymentMethod with. This field is optional if a PaymentMethod has already been attached to this PaymentIntent.

property return_url

return_url?: string;

The url your customer will be directed to after they complete authentication.

interface ConfirmKlarnaPaymentOptions

interface ConfirmKlarnaPaymentOptions {}

An options object to control the behavior of stripe.confirmKlarnaPayment.

property handleActions

handleActions?: boolean;

Set this to false if you want to [manually handle the authorization redirect](https://stripe.com/docs/payments/klarna#handle-redirect). Default is true.

interface ConfirmKonbiniPaymentData

interface ConfirmKonbiniPaymentData extends PaymentIntentConfirmParams {}

Data to be sent with a stripe.confirmKonbiniPayment request. Refer to the [Payment Intents API](https://stripe.com/docs/api/payment_intents/confirm) for a full list of parameters.

property payment_method

payment_method?: string | Omit<CreatePaymentMethodKonbiniData, 'type'>;

Either the id of an existing [PaymentMethod](https://stripe.com/docs/api/payment_methods), or an object containing data to create a PaymentMethod with. This field is optional if a PaymentMethod has already been attached to this PaymentIntent.

property payment_method_options

payment_method_options?: {
    /**
     * Configuration for this Konbini payment.
     */
    konbini: {
        /**
         * An optional 10 to 11 digit numeric-only string determining the confirmation code at applicable convenience stores. May not be all 0 and could be rejected in case of insufficient uniqueness. We recommend to use the customer’s phone number.
         */
        confirmation_number?: string;
    };
};

An object containing payment-method-specific configuration to confirm the [PaymentIntent](https://stripe.com/docs/api/payment_intents) with.

interface ConfirmKonbiniPaymentOptions

interface ConfirmKonbiniPaymentOptions {}

An options object to control the behavior of stripe.confirmKonbiniPayment.

property handleActions

handleActions?: boolean;

Set this to false if you want to handle next actions yourself. Please refer to our [integration guide](https://stripe.com/docs/payments/konbini/accept-a-payment) for more info. Default is true.

interface ConfirmMobilepayPaymentData

interface ConfirmMobilepayPaymentData extends PaymentIntentConfirmParams {}

Data to be sent with a stripe.confirmMobilepayPayment request. Refer to the [Payment Intents API](https://stripe.com/docs/api/payment_intents/confirm) for a full list of parameters.

property payment_method

payment_method?: string | Omit<CreatePaymentMethodMobilepayData, 'type'>;

The id of an existing [PaymentMethod](https://stripe.com/docs/api/payment_methods). This field is optional if a PaymentMethod has already been attached to this PaymentIntent or a new PaymentMethod will be created.

property return_url

return_url?: string;

The url your customer will be directed to after they complete authentication.

interface ConfirmMobilepayPaymentOptions

interface ConfirmMobilepayPaymentOptions {}

An options object to control the behavior of stripe.confirmMobilepayPayment.

property handleActions

handleActions?: boolean;

Set this to false if you want to [manually handle the redirect](https://docs.stripe.com/payments/mobilepay/accept-a-payment?web-or-mobile=web&payments-ui-type=direct-api#web-confirm-payment-intent). Default is true.

interface ConfirmMultibancoPaymentData

interface ConfirmMultibancoPaymentData extends PaymentIntentConfirmParams {}

Data to be sent with a stripe.confirmMultibancoPayment request. Refer to the [Payment Intents API](https://stripe.com/docs/api/payment_intents/confirm) for a full list of parameters.

property payment_method

payment_method?: string | Omit<CreatePaymentMethodMultibancoData, 'type'>;

Either the id of an existing [PaymentMethod](https://stripe.com/docs/api/payment_methods), or an object containing data to create a PaymentMethod with. This field is optional if a PaymentMethod has already been attached to this PaymentIntent.

property return_url

return_url?: string;

The url your customer will be directed to after they complete authentication.

interface ConfirmMultibancoPaymentOptions

interface ConfirmMultibancoPaymentOptions {}

property handleActions

handleActions?: boolean;

Set this to false if you want to [manually handle the authorization redirect](https://stripe.com/docs/payments/sofort/accept-a-payment?platform=web#handle-redirect). Default is true.

interface ConfirmOxxoPaymentData

interface ConfirmOxxoPaymentData extends PaymentIntentConfirmParams {}

Data to be sent with a stripe.confirmOxxoPayment request. Refer to the [Payment Intents API](https://stripe.com/docs/api/payment_intents/confirm) for a full list of parameters.

property payment_method

payment_method?: string | Omit<CreatePaymentMethodOxxoData, 'type'>;

Either the id of an existing [PaymentMethod](https://stripe.com/docs/api/payment_methods), or an object containing data to create a PaymentMethod with. This field is optional if a PaymentMethod has already been attached to this PaymentIntent.

interface ConfirmOxxoPaymentOptions

interface ConfirmOxxoPaymentOptions {}

An options object to control the behavior of stripe.confirmOxxoPayment.

property handleActions

handleActions?: boolean;

Set this to false if you want to handle next actions yourself. Please refer to our [Stripe OXXO integration guide](https://stripe.com/docs/payments/oxxo) for more info. Default is true.

interface ConfirmP24PaymentData

interface ConfirmP24PaymentData extends PaymentIntentConfirmParams {}

Data to be sent with a stripe.confirmP24Payment request. Refer to the [Payment Intents API](https://stripe.com/docs/api/payment_intents/confirm) for a full list of parameters.

property payment_method

payment_method?: string | Omit<CreatePaymentMethodP24Data, 'type'>;

Either the id of an existing [PaymentMethod](https://stripe.com/docs/api/payment_methods), or an object containing data to create a PaymentMethod with. This field is optional if a PaymentMethod has already been attached to this PaymentIntent.

property payment_method_options

payment_method_options?: {
    /**
     * Configuration for this Przelewy24 payment.
     */
    p24: {
        /**
         * Specify that payer has agreed to the Przelewy24 Terms of Service
         */
        tos_shown_and_accepted?: boolean;
    };
};

property return_url

return_url?: string;

The url your customer will be directed to after they complete authentication.

interface ConfirmP24PaymentOptions

interface ConfirmP24PaymentOptions {}

An options object to control the behavior of stripe.confirmP24Payment.

property handleActions

handleActions?: boolean;

Set this to false if you want to [manually handle the authorization redirect](https://stripe.com/docs/payments/p24#handle-redirect). Default is true.

interface ConfirmPaymentData

interface ConfirmPaymentData extends PaymentIntentConfirmParams {}

Data to be sent with a stripe.confirmPayment request. Refer to the [Payment Intents API](https://stripe.com/docs/api/payment_intents/confirm) for a full list of parameters.

property confirmation_token

confirmation_token?: string;

Optional id of an existing [ConfirmationToken](https://stripe.com/docs/api/confirmation_tokens).
https://stripe.com/docs/js/payment_intents/confirm_payment#confirm_payment_intent-options-confirmParams-confirmation_token

property expand

expand?: Array<string>;

Specifies which fields in the response should be expanded.

property payment_method

payment_method?: string;

Optional id of an existing [PaymentMethod](https://stripe.com/docs/api/payment_methods).
https://stripe.com/docs/js/payment_intents/confirm_payment#confirm_payment_intent-options-confirmParams-payment_method

property payment_method_data

payment_method_data?: {
    /**
     * The customer's billing details. Details collected by Elements will override values passed here.
     * Billing fields that are omitted in the Payment Element via the `fields` option required.
     *
     * @docs https://stripe.com/docs/api/payment_intents/create#create_payment_intent-payment_method_data-billing_details
     */
    billing_details?: PaymentMethodCreateParams.BillingDetails;

    /**
     * Specifies if the PaymentMethod should be redisplayed when using the Saved Payment Method feature
     */
    allow_redisplay?: 'always' | 'limited' | 'unspecified';

    /**
     * Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
     * Individual keys can be unset by posting an empty value to them
     * @docs https://docs.stripe.com/metadata
     */
    metadata?: Record<string, string>;
};

An object to attach additional billing_details to the PaymentMethod created via Elements.
https://stripe.com/docs/api/payment_intents/create#create_payment_intent-payment_method_data

property return_url

return_url: string;

The url your customer will be directed to after they complete payment.

interface ConfirmPayNowPaymentData

interface ConfirmPayNowPaymentData extends PaymentIntentConfirmParams {}

Data to be sent with a stripe.confirmPayNowPayment request. Refer to the [Payment Intents API](https://stripe.com/docs/api/payment_intents/confirm) for a full list of parameters.

property payment_method

payment_method?: string | Omit<CreatePaymentMethodPayNowData, 'type'>;

The id of an existing [PaymentMethod](https://stripe.com/docs/api/payment_methods). This field is optional if a PaymentMethod has already been attached to this PaymentIntent or a new PaymentMethod will be created.

interface ConfirmPayNowPaymentOptions

interface ConfirmPayNowPaymentOptions {}

An options object to control the behavior of stripe.confirmPayNowPayment.

property handleActions

handleActions?: boolean;

Set this to false if you want to [manually handle the authorization redirect](https://stripe.com/docs/payments/p24#handle-redirect). Default is true.

interface ConfirmPayPalPaymentData

interface ConfirmPayPalPaymentData extends PaymentIntentConfirmParams {}

Data to be sent with a stripe.confirmPayPalPayment request. Refer to the [Payment Intents API](https://stripe.com/docs/api/payment_intents/confirm) for a full list of parameters.

property payment_method

payment_method?: string | Omit<CreatePaymentMethodPayPalData, 'type'>;

Either the id of an existing [PaymentMethod](https://stripe.com/docs/api/payment_methods), or an object containing data to create a PaymentMethod with. This field is optional if a PaymentMethod has already been attached to this PaymentIntent.

property return_url

return_url: string;

The required url your customer will be directed to after they complete authentication.

interface ConfirmPayPalSetupData

interface ConfirmPayPalSetupData extends SetupIntentConfirmParams {}

Data to be sent with a stripe.confirmIdealSetup request. Refer to the [Setup Intents API](https://stripe.com/docs/api/setup_intents/confirm) for a full list of parameters.

property payment_method

payment_method?: string | Omit<CreatePaymentMethodPayPalData, 'type'>;

property return_url

return_url: string;

The required url your customer will be directed to after they complete authentication.

interface ConfirmPixPaymentData

interface ConfirmPixPaymentData extends PaymentIntentConfirmParams {}

Data to be sent with a stripe.confirmPixPayment request. Refer to the [Payment Intents API](https://stripe.com/docs/api/payment_intents/confirm) for a full list of parameters.

property payment_method

payment_method?: string | Omit<CreatePaymentMethodPixData, 'type'>;

The id of an existing [PaymentMethod](https://stripe.com/docs/api/payment_methods). This field is optional if a PaymentMethod has already been attached to this PaymentIntent or a new PaymentMethod will be created.

interface ConfirmPixPaymentOptions

interface ConfirmPixPaymentOptions {}

An options object to control the behavior of stripe.confirmPayNowPayment.

property handleActions

handleActions?: boolean;

Set this to false if you want to [manually handle the authorization redirect](https://stripe.com/docs/payments/p24#handle-redirect). Default is true.

interface ConfirmPromptPayPaymentData

interface ConfirmPromptPayPaymentData extends PaymentIntentConfirmParams {}

Data to be sent with a stripe.confirmPayNowPayment request. Refer to the [Payment Intents API](https://stripe.com/docs/api/payment_intents/confirm) for a full list of parameters.

property payment_method

payment_method?: string | Omit<CreatePaymentMethodPromptPayData, 'type'>;

The id of an existing [PaymentMethod](https://stripe.com/docs/api/payment_methods). This field is optional if a PaymentMethod has already been attached to this PaymentIntent or a new PaymentMethod will be created.

interface ConfirmPromptPayPaymentOptions

interface ConfirmPromptPayPaymentOptions {}

An options object to control the behavior of stripe.confirmPayNowPayment.

property handleActions

handleActions?: boolean;

Set this to false if you want to [manually handle the authorization redirect](https://stripe.com/docs/payments/p24#handle-redirect). Default is true.

interface ConfirmSepaDebitPaymentData

interface ConfirmSepaDebitPaymentData extends PaymentIntentConfirmParams {}

Data to be sent with a stripe.confirmSepaDebitPayment request. Refer to the [Payment Intents API](https://stripe.com/docs/api/payment_intents/confirm) for a full list of parameters.

property payment_method

payment_method?: string | Omit<CreatePaymentMethodSepaDebitData, 'type'>;

Either the id of an existing [PaymentMethod](https://stripe.com/docs/api/payment_methods), or an object containing data to create a PaymentMethod with. This field is optional if a PaymentMethod has already been attached to this PaymentIntent.

property setup_future_usage

setup_future_usage?: 'off_session';

To save the SEPA Direct Debit account for reuse, set this parameter to off_session. SEPA Direct Debit only accepts an off_session value for this parameter.

interface ConfirmSepaDebitSetupData

interface ConfirmSepaDebitSetupData extends SetupIntentConfirmParams {}

Data to be sent with a stripe.confirmSepaDebitSetup request. Refer to the [Setup Intents API](https://stripe.com/docs/api/setup_intents/confirm) for a full list of parameters.

property payment_method

payment_method?: string | Omit<CreatePaymentMethodSepaDebitData, 'type'>;

interface ConfirmSetupData

interface ConfirmSetupData extends SetupIntentConfirmParams {}

Data to be sent with a stripe.confirmSetup request. Refer to the [Setup Intents API](https://stripe.com/docs/api/setup_intents/confirm) for a full list of parameters.

property confirmation_token

confirmation_token?: string;

Optional id of an existing [ConfirmationToken](https://stripe.com/docs/api/confirmation_tokens).
https://stripe.com/docs/js/payment_intents/confirm_payment#confirm_payment_intent-options-confirmParams-confirmation_token

property expand

expand?: Array<string>;

Specifies which fields in the response should be expanded.

property payment_method

payment_method?: string;

Optional id of an existing [PaymentMethod](https://stripe.com/docs/api/payment_methods).
https://stripe.com/docs/js/payment_intents/confirm_payment#confirm_payment_intent-options-confirmParams-payment_method

property payment_method_data

payment_method_data?: {
    /**
     * The customer's billing details. Details collected by Elements will override values passed here.
     * Billing fields that are omitted in the Payment Element via the `fields` option required.
     *
     * @docs https://stripe.com/docs/api/payment_intents/create#create_payment_intent-payment_method_data-billing_details
     */
    billing_details?: PaymentMethodCreateParams.BillingDetails;

    /**
     * Specifies if the PaymentMethod should be redisplayed when using the Saved Payment Method feature
     */
    allow_redisplay?: 'always' | 'limited' | 'unspecified';

    /**
     * Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
     * Individual keys can be unset by posting an empty value to them
     * @docs https://docs.stripe.com/metadata
     */
    metadata?: Record<string, string>;
};

An object to attach additional billing_details to the PaymentMethod created via Elements.
https://stripe.com/docs/api/payment_intents/create#create_payment_intent-payment_method_data

property return_url

return_url: string;

The url your customer will be directed to after they complete payment.

interface ConfirmSofortPaymentData

interface ConfirmSofortPaymentData extends PaymentIntentConfirmParams {}

Data to be sent with a stripe.confirmSofortPayment request. Refer to the [Payment Intents API](https://stripe.com/docs/api/payment_intents/confirm) for a full list of parameters.

property payment_method

payment_method?: string | Omit<CreatePaymentMethodSofortData, 'type'>;

Either the id of an existing [PaymentMethod](https://stripe.com/docs/api/payment_methods), or an object containing data to create a PaymentMethod with. This field is optional if a PaymentMethod has already been attached to this PaymentIntent.

property return_url

return_url?: string;

The url your customer will be directed to after they complete authentication.

property setup_future_usage

setup_future_usage?: 'off_session';

To set up a SEPA Direct Debit payment method using the bank details from this SOFORT payment, set this parameter to off_session. When using this parameter, a customer will need to be set on the [PaymentIntent](https://stripe.com/docs/api/payment_intents). The newly created SEPA Direct Debit [PaymentMethod](https://stripe.com/docs/api/payment_methods) will be attached to this customer.

interface ConfirmSofortPaymentOptions

interface ConfirmSofortPaymentOptions {}

An options object to control the behavior of stripe.confirmSofortPayment.

property handleActions

handleActions?: boolean;

Set this to false if you want to [manually handle the authorization redirect](https://stripe.com/docs/payments/sofort/accept-a-payment?platform=web#handle-redirect). Default is true.

interface ConfirmSofortSetupData

interface ConfirmSofortSetupData extends SetupIntentConfirmParams {}

Data to be sent with a stripe.confirmSofortSetup request. Refer to the [Setup Intents API](https://stripe.com/docs/api/setup_intents/confirm) for a full list of parameters.

property payment_method

payment_method?: string | Omit<CreatePaymentMethodSofortData, 'type'>;

interface ConfirmSofortSetupOptions

interface ConfirmSofortSetupOptions {}

An options object to control the behavior of stripe.confirmSofortSetup.

property handleActions

handleActions?: boolean;

Set this to false if you want to [manually handle the authorization redirect](https://stripe.com/docs/payments/sofort/accept-a-payment?platform=web#handle-redirect). Default is true.

interface ConfirmTwintPaymentData

interface ConfirmTwintPaymentData extends PaymentIntentConfirmParams {}

Data to be sent with a stripe.confirmTwintPayment request. Refer to the [Payment Intents API](https://stripe.com/docs/api/payment_intents/confirm) for a full list of parameters.

property payment_method

payment_method?: string | Omit<CreatePaymentMethodTwintData, 'type'>;

Either the id of an existing [PaymentMethod](https://stripe.com/docs/api/payment_methods), or an object containing data to create a PaymentMethod with. This field is optional if a PaymentMethod has already been attached to this PaymentIntent.

property return_url

return_url?: string;

The url your customer will be directed to after they complete authentication.

interface ConfirmTwintPaymentOptions

interface ConfirmTwintPaymentOptions {}

property handleActions

handleActions?: boolean;

Set this to false if you want to [manually handle the authorization redirect](https://stripe.com/docs/payments/sofort/accept-a-payment?platform=web#handle-redirect). Default is true.

interface ConfirmUsBankAccountPaymentData

interface ConfirmUsBankAccountPaymentData extends PaymentIntentConfirmParams {}

property payment_method

payment_method?: string | Omit<CreatePaymentMethodUsBankAccountData, 'type'>;

Either the id of an existing [PaymentMethod](https://stripe.com/docs/api/payment_methods), or an object containing data to create a PaymentMethod with. This field is optional if a PaymentMethod has already been attached to this PaymentIntent.

interface ConfirmUsBankAccountSetupData

interface ConfirmUsBankAccountSetupData extends SetupIntentConfirmParams {}

property payment_method

payment_method?: string | Omit<CreatePaymentMethodUsBankAccountData, 'type'>;

Either the id of an existing [PaymentMethod](https://stripe.com/docs/api/payment_methods), or an object containing data to create a PaymentMethod with. This field is optional if a PaymentMethod has already been attached to this SetupIntent.

interface ConfirmWechatPayPaymentData

interface ConfirmWechatPayPaymentData extends PaymentIntentConfirmParams {}

Data to be sent with a stripe.confirmWechatPayPayment request. Refer to the [Payment Intents API](https://stripe.com/docs/api/payment_intents/confirm) for a full list of parameters.

property payment_method

payment_method?: string | Omit<CreatePaymentMethodWechatPayData, 'type'>;

The id of an existing [PaymentMethod](https://stripe.com/docs/api/payment_methods). This field is optional if a PaymentMethod has already been attached to this PaymentIntent or a new PaymentMethod will be created.

property payment_method_options

payment_method_options?: {
    /**
     * Configuration for this wechat payment.
     */
    wechat_pay: {
        client?: 'web';
    };
};

An object containing payment-method-specific configuration to confirm the [PaymentIntent](https://stripe.com/docs/api/payment_intents) with.

interface ConfirmWechatPayPaymentOptions

interface ConfirmWechatPayPaymentOptions {}

An options object to control the behavior of stripe.confirmWechatPayPayment.

property handleActions

handleActions: boolean;

This must be set to false, and you are responsible for handling the next_action after confirming the PaymentIntent.

interface ContactOption

interface ContactOption {}

property address

address: {
    line1: string;
    line2?: string;
    city: string;
    state: string;
    postal_code: string;
    country: string;
};

property name

name: string;

property phone

phone?: string;

interface CreateConfirmationToken

interface CreateConfirmationToken {}

property elements

elements: StripeElements;

The Elements instance.
https://stripe.com/docs/js/elements_object

property params

params?: ConfirmationTokenCreateParams;

Parameters for creating the ConfirmationToken. Details collected by Elements will be overriden by values passed here.

interface CreatePaymentMethodAcssDebitData

interface CreatePaymentMethodAcssDebitData extends PaymentMethodCreateParams {}

property acss_debit

acss_debit?: {
    /**
     * Customer’s bank account number.
     */
    account_number: string;

    /**
     * Institution number of the customer’s bank.
     */
    institution_number: string;

    /**
     * Transit number of the customer’s bank.
     */
    transit_number: string;
};

Can be omitted as Stripe will help to collect bank account details and verification. Refer to our [integration guide](https://stripe.com/docs/payments/acss-debit/accept-a-payment) for more details.

property billing_details

billing_details: PaymentMethodCreateParams.BillingDetails;

The customer's billing details. name, email, and address are required.
https://stripe.com/docs/api/payment_methods/create#create_payment_method-billing_details

property type

type: 'acss_debit';

interface CreatePaymentMethodAffirmData

interface CreatePaymentMethodAffirmData extends PaymentMethodCreateParams {}

property affirm

affirm?: {};

Can be omitted as there are no Affirm-specific fields.

property type

type: 'affirm';

interface CreatePaymentMethodAfterpayClearpayData

interface CreatePaymentMethodAfterpayClearpayData
    extends PaymentMethodCreateParams {}

property afterpay_clearpay

afterpay_clearpay?: {};

Can be omitted as there are no AfterpayClearpay-specific fields.

property type

type: 'afterpay_clearpay';

interface CreatePaymentMethodAlipayData

interface CreatePaymentMethodAlipayData extends PaymentMethodCreateParams {}

property type

type: 'alipay';

interface CreatePaymentMethodAuBecsDebitData

interface CreatePaymentMethodAuBecsDebitData extends PaymentMethodCreateParams {}

property au_becs_debit

au_becs_debit:
    | StripeAuBankAccountElement
    | {
          /**
           * A BSB number.
           */
          bsb_number: string;

          /**
           * An account number.
           */
          account_number: string;
      };

Requires beta access: Contact [Stripe support](https://support.stripe.com/) for more information.

property billing_details

billing_details: PaymentMethodCreateParams.BillingDetails & {
    name: string;
    email: string;
};

The customer's billing details. name and email are required.
https://stripe.com/docs/api/payment_methods/create#create_payment_method-billing_details

property type

type: 'au_becs_debit';

Requires beta access: Contact [Stripe support](https://support.stripe.com/) for more information.

interface CreatePaymentMethodBacsDebitData

interface CreatePaymentMethodBacsDebitData extends PaymentMethodCreateParams {}

property bacs_debit

bacs_debit: {
    /**
     * A sort code.
     */
    sort_code: string;

    /**
     * An account number.
     */
    account_number: string;
};

property billing_details

billing_details: PaymentMethodCreateParams.BillingDetails & {
    name: string;
    email: string;
    address: PaymentMethodCreateParams.BillingDetails.Address & {
        line1: string;
        city: string;
        country: string;
        postal_code: string;
    };
};

The customer's billing details. name, email, and address are required.
https://stripe.com/docs/api/payment_methods/create#create_payment_method-billing_details

property type

type: 'bacs_debit';

interface CreatePaymentMethodBancontactData

interface CreatePaymentMethodBancontactData extends PaymentMethodCreateParams {}

property billing_details

billing_details: PaymentMethodCreateParams.BillingDetails & {
    name: string;
};

The customer's billing details. name is required.
https://stripe.com/docs/api/payment_methods/create#create_payment_method-billing_details

property type

type: 'bancontact';

interface CreatePaymentMethodBillieData

interface CreatePaymentMethodBillieData extends PaymentMethodCreateParams {}

property billie

billie: {};

Details about the Billie pament method. Currently there are no supported child attributes for this field, but sending an empty object is mandatory.

property type

type: 'billie';

Requires beta access: Contact [Stripe support](https://support.stripe.com/) for more information.

interface CreatePaymentMethodBlikData

interface CreatePaymentMethodBlikData extends PaymentMethodCreateParams {}

property blik

blik?: {};

Details about the BLIK pament method. Currently there are no supported child attributes for this field.

property type

type: 'blik';

interface CreatePaymentMethodBoletoData

interface CreatePaymentMethodBoletoData extends PaymentMethodCreateParams {}

property billing_details

billing_details: PaymentMethodCreateParams.BillingDetails & {
    email: string;
    name: string;
    address: PaymentMethodCreateParams.BillingDetails.Address & {
        line1: string;
        city: string;
        postal_code: string;
        state: string;
        country: string;
    };
};

The customer's billing details. name, email, and full address is required.
https://stripe.com/docs/api/payment_methods/create#create_payment_method-billing_details

property boleto

boleto: {
    tax_id: string;
};

property type

type: 'boleto';

interface CreatePaymentMethodCardData

interface CreatePaymentMethodCardData extends PaymentMethodCreateParams {}

property card

card: StripeCardElement | StripeCardNumberElement | { token: string };

property type

type: 'card';

interface CreatePaymentMethodCashappData

interface CreatePaymentMethodCashappData extends PaymentMethodCreateParams {}

property type

type: 'cashapp';

interface CreatePaymentMethodCustomerBalanceData

interface CreatePaymentMethodCustomerBalanceData extends PaymentMethodCreateParams {}

property customer_balance

customer_balance: Record<string, never>;

Requires beta access: Contact [Stripe support](https://support.stripe.com/) for more information.

interface CreatePaymentMethodEpsData

interface CreatePaymentMethodEpsData extends PaymentMethodCreateParams {}

property billing_details

billing_details: PaymentMethodCreateParams.BillingDetails & {
    name: string;
};

The customer's billing details. name is required.
https://stripe.com/docs/api/payment_methods/create#create_payment_method-billing_details

property eps

eps: {
    /**
     * The customer's bank
     */
    bank?: string;
};

property type

type: 'eps';

interface CreatePaymentMethodFpxData

interface CreatePaymentMethodFpxData extends PaymentMethodCreateParams {}

property fpx

fpx: {
    /**
     * The customer's bank.
     */
    bank: string;
};

property type

type: 'fpx';

interface CreatePaymentMethodFromElement

interface CreatePaymentMethodFromElement {}

property element

element: StripeElement;

The specific Element used to collect payment details
https://stripe.com/docs/js/element

property metadata

metadata?: MetadataParam;

Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to metadata.

property params

params?: PaymentMethodCreateParams;

Parameters that will be passed on to the PaymentMethod API
https://stripe.com/docs/api/payment_methods/create

interface CreatePaymentMethodFromElements

interface CreatePaymentMethodFromElements {}

property elements

elements: StripeElements;

The Elements instance
https://stripe.com/docs/js/elements_object

property metadata

metadata?: MetadataParam;

Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to metadata.

property params

params?: PaymentMethodCreateParams;

Parameters that will be passed on to the PaymentMethod API
https://stripe.com/docs/api/payment_methods/create

interface CreatePaymentMethodGiropayData

interface CreatePaymentMethodGiropayData extends PaymentMethodCreateParams {}

property billing_details

billing_details: PaymentMethodCreateParams.BillingDetails & {
    name: string;
};

The customer's billing details. name is required.
https://stripe.com/docs/api/payment_methods/create#create_payment_method-billing_details

property type

type: 'giropay';

interface CreatePaymentMethodGrabPayData

interface CreatePaymentMethodGrabPayData extends PaymentMethodCreateParams {}

property grabpay

grabpay?: {};

Can be omitted as there are no GrabPay-specific fields.

property type

type: 'grabpay';

interface CreatePaymentMethodIdealData

interface CreatePaymentMethodIdealData extends PaymentMethodCreateParams {}

property ideal

ideal: {
    /**
     * The customer's bank.
     */
    bank?: string;
};

property type

type: 'ideal';

interface CreatePaymentMethodKlarnaData

interface CreatePaymentMethodKlarnaData extends PaymentMethodCreateParams {}

property billing_details

billing_details: PaymentMethodCreateParams.BillingDetails & {
    address: PaymentMethodCreateParams.BillingDetails.Address & {
        country: string;
    };
};

The customer's billing details. address.country is required.
https://stripe.com/docs/api/payment_methods/create#create_payment_method-billing_details

property type

type: 'klarna';

Requires beta access: Contact [Stripe support](https://support.stripe.com/) for more information.

interface CreatePaymentMethodKonbiniData

interface CreatePaymentMethodKonbiniData extends PaymentMethodCreateParams {}

property billing_details

billing_details: PaymentMethodCreateParams.BillingDetails & {
    email: string;
    name: string;
};

The customer's billing details. email and name are required.
https://stripe.com/docs/api/payment_methods/create#create_payment_method-billing_details

property type

type: 'konbini';

interface CreatePaymentMethodMobilepayData

interface CreatePaymentMethodMobilepayData extends PaymentMethodCreateParams {}

property type

type: 'mobilepay';

interface CreatePaymentMethodMultibancoData

interface CreatePaymentMethodMultibancoData extends PaymentMethodCreateParams {}

property billing_details

billing_details: PaymentMethodCreateParams.BillingDetails & {
    email: string;
};

The customer's billing details. email is required.
https://stripe.com/docs/api/payment_methods/create#create_payment_method-billing_details

property type

type: 'multibanco';

interface CreatePaymentMethodOxxoData

interface CreatePaymentMethodOxxoData extends PaymentMethodCreateParams {}

property billing_details

billing_details: PaymentMethodCreateParams.BillingDetails & {
    email: string;
    name: string;
};

The customer's billing details. email and name are required.
https://stripe.com/docs/api/payment_methods/create#create_payment_method-billing_details

property type

type: 'oxxo';

interface CreatePaymentMethodP24Data

interface CreatePaymentMethodP24Data extends PaymentMethodCreateParams {}

property billing_details

billing_details: PaymentMethodCreateParams.BillingDetails & {
    email: string;
};

The customer's billing details. email is required.
https://stripe.com/docs/api/payment_methods/create#create_payment_method-billing_details

property p24

p24?: {
    /**
     * The customer's bank.
     */
    bank?: string;
};

property type

type: 'p24';

interface CreatePaymentMethodPayNowData

interface CreatePaymentMethodPayNowData extends PaymentMethodCreateParams {}

property type

type: 'paynow';

interface CreatePaymentMethodPayPalData

interface CreatePaymentMethodPayPalData extends PaymentMethodCreateParams {}

property type

type: 'paypal';

interface CreatePaymentMethodPixData

interface CreatePaymentMethodPixData extends PaymentMethodCreateParams {}

property type

type: 'pix';

interface CreatePaymentMethodPromptPayData

interface CreatePaymentMethodPromptPayData extends PaymentMethodCreateParams {}

property type

type: 'promptpay';

interface CreatePaymentMethodSepaDebitData

interface CreatePaymentMethodSepaDebitData extends PaymentMethodCreateParams {}

property billing_details

billing_details: PaymentMethodCreateParams.BillingDetails & {
    name: string;
    email: string;
};

The customer's billing details. name and email are required.
https://stripe.com/docs/api/payment_methods/create#create_payment_method-billing_details

property sepa_debit

sepa_debit:
    | StripeIbanElement
    | {
          /**
           * An IBAN account number.
           */
          iban: string;
      };

property type

type: 'sepa_debit';

interface CreatePaymentMethodSofortData

interface CreatePaymentMethodSofortData extends PaymentMethodCreateParams {}

property billing_details

billing_details?: PaymentMethodCreateParams.BillingDetails;

The customer's billing details. Required when setup_future_usage is set to off_session.
https://stripe.com/docs/api/payment_methods/create#create_payment_method-billing_details

property sofort

sofort: {
    /**
     * The country code where customer's bank is located.
     */
    country: string;
};

property type

type: 'sofort';

interface CreatePaymentMethodTwintData

interface CreatePaymentMethodTwintData extends PaymentMethodCreateParams {}

property type

type: 'twint';

interface CreatePaymentMethodUsBankAccountData

interface CreatePaymentMethodUsBankAccountData extends PaymentMethodCreateParams {}

property billing_details

billing_details: PaymentMethodCreateParams.BillingDetails;

The customer's billing details. name, email, and address are required.
https://stripe.com/docs/api/payment_methods/create#create_payment_method-billing_details

property type

type: 'us_bank_account';

property us_bank_account

us_bank_account: {
    /**
     * Customer’s bank account number.
     */
    account_number: string;

    /**
     * The routing transit number for the bank account.
     */
    routing_number: string;

    /**
     * The type of entity that holds the account. This can be either `individual` or `company`.
     */
    account_holder_type: string;

    /**
     * Account type: checkings or savings. Defaults to checking if omitted.
     */
    account_type?: string;
};

Can be omitted as Stripe will help to collect bank account details and verification. Refer to our [integration guide](https://stripe.com/docs/payments/acss-debit/accept-a-payment) for more details.

interface CreatePaymentMethodWechatPayData

interface CreatePaymentMethodWechatPayData extends PaymentMethodCreateParams {}

property type

type: 'wechat_pay';

Requires beta access: Contact [Stripe support](https://support.stripe.com/) for more information.

interface CreateSourceData

interface CreateSourceData extends SourceCreateParams {}

A required object containing the type of Source you want to create, and any additional payment information that you have collected. See the [Sources API](https://stripe.com/docs/api#create_source) reference for details.
You cannot pass raw card information to stripe.createSource(sourceData). Instead, you must gather card information in an Element and use stripe.createSource(element, sourceData). You can also pass an existing card token to convert it into a Source object.

property bancontact

bancontact?: CreateSourceData.DeprecatedMethodData;

property ideal

ideal?: CreateSourceData.DeprecatedMethodData;

property klarna

klarna?: CreateSourceData.DeprecatedMethodData;

property sepa_debit

sepa_debit?: CreateSourceData.DeprecatedMethodData;

property sofort

sofort?: CreateSourceData.DeprecatedMethodData;

interface CreateTokenBankAccountData

interface CreateTokenBankAccountData {}

property account_holder_name

account_holder_name?: string;

property account_holder_type

account_holder_type: string;

property account_number

account_number: string;

property account_type

account_type?: string;

property country

country: string;

property currency

currency: string;

property routing_number

routing_number?: string;

interface CreateTokenCardData

interface CreateTokenCardData {}

An object containing additional payment information you might have collected.
Although these fields are optional, we highly recommend collecting name and address. This information can be used to perform a number of verifications, such as CVC, ZIP, and address verification. Radar includes built-in rules that can block payments where the ZIP or CVC verifications with the cardholder’s bank failed.

property address_city

address_city?: string;

property address_country

address_country?: string;

A two character country code (for example, US).

property address_line1

address_line1?: string;

property address_line2

address_line2?: string;

property address_state

address_state?: string;

property address_zip

address_zip?: string;

property currency

currency?: string;

Required in order to [add the card to a Connect account](https://stripe.com/docs/connect/payouts#bank-accounts) (in all other cases, this parameter is not used). Currently, the only supported currency for debit card payouts is usd.

property name

name?: string;

interface CreateTokenIbanData

interface CreateTokenIbanData {}

property account_holder_name

account_holder_name: string;

property account_holder_type

account_holder_type: string;

property currency

currency: string;

Three character currency code (e.g., eur).

interface CreateTokenPiiData

interface CreateTokenPiiData {}

property personal_id_number

personal_id_number: string;

interface CreditBalance

interface CreditBalance {}

property credit

credit: {
    /**
     * The credit that has been used by the account holder.
     *
     * Each key is a three-letter ISO currency code, in lowercase
     *
     * Each value is a integer amount. A positive amount indicates money owed
     * to the account holder. A negative amount indicates money owed by the
     * account holder.
     */
    used: { [key: string]: number | undefined };
};

Information on a credit balance. Only set if balance.type is credit.

property type

type: 'credit';

interface CssFontSource

interface CssFontSource {}

property cssSrc

cssSrc: string;

A relative or absolute URL pointing to a CSS file with [@font-face](https://developer.mozilla.org/en/docs/Web/CSS/@font-face) definitions, for example:
https://fonts.googleapis.com/css?family=Open+Sans
Note that if you are using a [content security policy](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Content-Security-Policy) (CSP), [additional directives](https://stripe.com/docs/security#content-security-policy) may be necessary.

interface CustomerOptions

interface CustomerOptions {}

property customer

customer: string;

The Customer id.

property ephemeralKey

ephemeralKey: string;

The ephemeral key for a Customer that grants temporary access to Customer data.

interface CustomFontSource

interface CustomFontSource {}

property display

display?: string;

A valid [font-display](https://developer.mozilla.org/en-US/docs/Web/CSS/@font-face/font-display) value.

property family

family: string;

The name to give the font

property src

src: string;

A valid [src](https://developer.mozilla.org/en-US/docs/Web/CSS/@font-face/src) value pointing to your custom font file. This is usually (though not always) a link to a file with a .woff , .otf, or .svg suffix.

property style

style?: 'normal' | 'italic' | 'oblique';

Defaults to normal.

property unicodeRange

unicodeRange?: string;

A valid [unicode-range](https://developer.mozilla.org/en-US/docs/Web/CSS/@font-face/unicode-range) value.

property weight

weight?: string;

A valid [font-weight](https://developer.mozilla.org/en-US/docs/Web/CSS/font-weight), as a string.

interface CustomPaymentMethod

interface CustomPaymentMethod {}

property id

id: string;

The Custom Payment Method id, prefixed with cpmt_.

property options

options: {
    /**
     * The payment form type.
     */
    type: 'static';

    /**
     * Display additional information about the payment method, max 100 characters.
     */
    subtitle?: string;
};

Additional options to configure the Custom Payment Method.

interface DefaultValuesOption

interface DefaultValuesOption {}

property billingDetails

billingDetails?: {
    name?: string;
    email?: string;
    phone?: string;
    address?: {
        country?: string;
        postal_code?: string;
        state?: string;
        city?: string;
        line1?: string;
        line2?: string;
    };
};

property card

card?: {
    network?: CardNetworkBrand[];
};

interface EphemeralKeyNonceOptions

interface EphemeralKeyNonceOptions {}

property issuingCard

issuingCard: string;

interface FieldsOption

interface FieldsOption {}

property billingDetails

billingDetails?:
    | FieldOption
    | {
          name?: FieldOption;
          email?: FieldOption;
          phone?: FieldOption;
          address?:
              | FieldOption
              | 'if_required'
              | {
                    country?: FieldOption;
                    postalCode?: FieldOption;
                    state?: FieldOption;
                    city?: FieldOption;
                    line1?: FieldOption;
                    line2?: FieldOption;
                };
      };

interface FinancialConnectionsSession

interface FinancialConnectionsSession {}

The Financial Connections Session object

property accounts

accounts: FinancialConnectionsSession.Account[];

List of accounts collected by the Session

property filters

filters?: FinancialConnectionsSession.Filters;

Filters applied to the Session

property id

id: string;

Unique identifier for the object.

property permissions

permissions?: FinancialConnectionsSession.Permission[];

List of data permissions requested in the Session

property return_url

return_url?: string;

For webview integrations only. The user will be redirected to this URL to return to your app.

interface JapanAddressParam

interface JapanAddressParam {}

property city

city?: string;

City or ward.

property country

country?: string;

Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).

property line1

line1?: string;

Block or building number.

property line2

line2?: string;

Building details.

property postal_code

postal_code?: string;

Postal code.

property state

state?: string;

Prefecture.

property town

town?: string;

Town or cho-me.

interface LayoutObject

interface LayoutObject {}

property defaultCollapsed

defaultCollapsed?: boolean;

property paymentMethodLogoPosition

paymentMethodLogoPosition?: 'start' | 'end';

The position of the payment method logo in each accordion item.
By default, the logo is displayed at the start of each accordion item.

property radios

radios?: boolean;

property spacedAccordionItems

spacedAccordionItems?: boolean;

property type

type: Layout;

property visibleAccordionItemsCount

visibleAccordionItemsCount?: number;

interface Metadata

interface Metadata {}

Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.

index signature

[name: string]: string;

interface MetadataParam

interface MetadataParam {}

Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format. While you can send values as numbers, they will be returned as strings.

index signature

[name: string]: string | number | null;

interface Order

interface Order {}

The Order object.

property amount_subtotal

amount_subtotal: number;

Order cost before any discounts or taxes are applied. A positive integer representing how much to charge in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal) (e.g., 100 cents to charge $1.00 or 100 to charge ¥100, a zero-decimal currency).

property amount_total

amount_total: number;

Total order cost after discounts and taxes are applied. A positive integer representing how much to charge in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal) (e.g., 100 cents to charge $1.00 or 100 to charge ¥100, a zero-decimal currency). To submit an order, the total must be either 0 or at least $0.50 USD or [equivalent in charge currency](https://stripe.com/docs/currencies#minimum-and-maximum-charge-amounts).

property billing_details

billing_details: Order.Billing | null;

Customer billing details associated with the order.

property created

created: number;

Time at which the object was created. Measured in seconds since the Unix epoch.

property currency

currency: string;

Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).

property id

id: string;

Unique identifier for the object.

property livemode

livemode: boolean;

Has the value true if the object exists in live mode or the value false if the object exists in test mode.

property object

object: 'order';

String representing the object's type. Objects of the same type share the same value.

property payment

payment: Order.Payment;

Payment information associated with the order.

property shipping_details

shipping_details: Order.Shipping | null;

Customer shipping information associated with the order.

property status

status: Order.Status;

The overall status of the order.

interface OwnershipRefresh

interface OwnershipRefresh {}

property last_attempted_at

last_attempted_at: number;

Time at which the Ownersip Refresh was attempted. Measured in seconds since the Unix epoch.

property status

status: 'pending' | 'succeeded' | 'failed';

The status of the Ownership Refresh

interface PaymentIntent

interface PaymentIntent {}

The PaymentIntent object.

property amount

amount: number;

Amount intended to be collected by this PaymentIntent. A positive integer representing how much to charge in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal) (e.g., 100 cents to charge $1.00 or 100 to charge ¥100, a zero-decimal currency). The minimum amount is $0.50 US or [equivalent in charge currency](https://stripe.com/docs/currencies#minimum-and-maximum-charge-amounts). The amount value supports up to eight digits (e.g., a value of 99999999 for a USD charge of $999,999.99).

property canceled_at

canceled_at: number | null;

Populated when status is canceled, this is the time at which the PaymentIntent was canceled. Measured in seconds since the Unix epoch.

property cancellation_reason

cancellation_reason: PaymentIntent.CancellationReason | null;

Reason for cancellation of this PaymentIntent, either user-provided (duplicate, fraudulent, requested_by_customer, or abandoned) or generated by Stripe internally (failed_invoice, void_invoice, or automatic).

property capture_method

capture_method: PaymentIntent.CaptureMethod;

Controls when the funds will be captured from the customer's account.

property client_secret

client_secret: string | null;

The client secret of this PaymentIntent. Used for client-side retrieval using a publishable key.
The client secret can be used to complete a payment from your frontend. It should not be stored, logged, embedded in URLs, or exposed to anyone other than the customer. Make sure that you have TLS enabled on any page that includes the client secret.
Refer to our docs to [accept a payment](https://stripe.com/docs/payments/accept-a-payment) and learn about how client_secret should be handled.

property confirmation_method

confirmation_method: PaymentIntent.ConfirmationMethod;

property created

created: number;

Time at which the object was created. Measured in seconds since the Unix epoch.

property currency

currency: string;

Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).

property description

description: string | null;

An arbitrary string attached to the object. Often useful for displaying to users.

property id

id: string;

Unique identifier for the object.

property last_payment_error

last_payment_error: PaymentIntent.LastPaymentError | null;

The payment error encountered in the previous PaymentIntent confirmation. It will be cleared if the PaymentIntent is later updated for any reason.

property livemode

livemode: boolean;

Has the value true if the object exists in live mode or the value false if the object exists in test mode.

property next_action

next_action: PaymentIntent.NextAction | null;

If present, this property tells you what actions you need to take in order for your customer to fulfill a payment using the provided source.

property object

object: 'payment_intent';

String representing the object's type. Objects of the same type share the same value.

property payment_method

payment_method: string | null | PaymentMethod;

ID of the payment method used in this PaymentIntent, or the PaymentMethod itself if this field is expanded.

property payment_method_types

payment_method_types: Array<string>;

The list of payment method types (e.g. card) that this PaymentIntent is allowed to use.

property receipt_email

receipt_email: string | null;

Email address that the receipt for the resulting payment will be sent to.

property setup_future_usage

setup_future_usage: PaymentIntent.SetupFutureUsage | null;

Indicates that you intend to make future payments with this PaymentIntent's payment method.
If present, the payment method used with this PaymentIntent can be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer, even after the transaction completes.
For more, learn to [save card details after a payment](https://stripe.com/docs/payments/save-after-payment).
Stripe uses setup_future_usage to dynamically optimize your payment flow and comply with regional legislation and network rules. For example, if your customer is impacted by [SCA](https://stripe.com/docs/strong-customer-authentication), using off_session will ensure that they are authenticated while processing this PaymentIntent. You will then be able to collect [off-session payments](https://stripe.com/docs/payments/cards/charging-saved-cards#off-session-payments-with-saved-cards) for this customer.

property shipping

shipping: PaymentIntent.Shipping | null;

Shipping information for this PaymentIntent.

property status

status: PaymentIntent.Status;

Status of this PaymentIntent, one of requires_payment_method, requires_confirmation, requires_action, processing, requires_capture, canceled, or succeeded. Read more about each PaymentIntent [status](https://stripe.com/docs/payments/intents#intent-statuses).

interface PaymentIntentConfirmParams

interface PaymentIntentConfirmParams {}

property mandate_data

mandate_data?: { [k: string]: any };

This hash contains details about the Mandate to create

property receipt_email

receipt_email?: string | '';

Email address that the receipt for the resulting payment will be sent to.

property return_url

return_url?: string;

The URL to redirect your customer back to after they authenticate or cancel their payment on the payment method's app or site. If you'd prefer to redirect to a mobile application, you can alternatively supply an application URI scheme. This parameter is only used for cards and other redirect-based payment methods.

property save_payment_method

save_payment_method?: boolean;

If the PaymentIntent has a payment_method and a customer or if you're attaching a payment method to the PaymentIntent in this request, you can pass save_payment_method=true to save the payment method to the customer. Defaults to false.
If the payment method is already saved to a customer, this does nothing. If this type of payment method cannot be saved to a customer, the request will error.
_Note that saving a payment method using this parameter does not guarantee that the payment method can be charged._ To ensure that only payment methods which can be charged are saved to a customer, you can [manually save](https://stripe.com/docs/api/customers/create#create_customer-source) the payment method in response to the [payment_intent.succeeded webhook](https://stripe.com/docs/api/events/types#event_types-payment_intent.succeeded).

property setup_future_usage

setup_future_usage?: PaymentIntentConfirmParams.SetupFutureUsage | null;

Indicates that you intend to make future payments with this PaymentIntent's payment method.
If present, the payment method used with this PaymentIntent can be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer, even after the transaction completes.
Use on_session if you intend to only reuse the payment method when your customer is present in your checkout flow. Use off_session if your customer may or may not be in your checkout flow.
Stripe uses setup_future_usage to dynamically optimize your payment flow and comply with regional legislation and network rules. For example, if your customer is impacted by [SCA](https://stripe.com/docs/strong-customer-authentication), using off_session will ensure that they are authenticated while processing this PaymentIntent. You will then be able to collect [off-session payments](https://stripe.com/docs/payments/cards/charging-saved-cards#off-session-payments-with-saved-cards) for this customer.
If setup_future_usage is already set and you are performing a request using a publishable key, you may only update the value from on_session to off_session.

property shipping

shipping?: PaymentIntentConfirmParams.Shipping | null;

Shipping information for this PaymentIntent.

interface PaymentMethod

interface PaymentMethod {}

The PaymentMethod object.

property acss_debit

acss_debit?: PaymentMethod.AcssDebit;

property affirm

affirm?: PaymentMethod.Affirm;

property afterpay_clearpay

afterpay_clearpay?: PaymentMethod.AfterpayClearpay;

property alipay

alipay?: PaymentMethod.Alipay;

property allow_redisplay

allow_redisplay: string | null;

This field indicates whether this payment method can be shown again to its customer in a checkout flow. Stripe products such as Checkout and Elements use this field to determine whether a payment method can be shown as a saved payment method in a checkout flow. Can be always, limited or unspecified.

property alma

alma?: PaymentMethod.Alma;

property amazon_pay

amazon_pay?: PaymentMethod.AmazonPay;

property au_becs_debit

au_becs_debit?: PaymentMethod.AuBecsDebit;

property bacs_debit

bacs_debit?: PaymentMethod.BacsDebit;

property bancontact

bancontact?: PaymentMethod.Bancontact;

property billie

billie?: PaymentMethod.Billie;

property billing_details

billing_details: PaymentMethod.BillingDetails;

property blik

blik?: PaymentMethod.Blik;

property boleto

boleto?: PaymentMethod.Boleto;

property card

card?: PaymentMethod.Card;

property card_present

card_present?: PaymentMethod.CardPresent;

property created

created: number;

Time at which the object was created. Measured in seconds since the Unix epoch.

property crypto

crypto?: PaymentMethod.Crypto;

property customer

customer: string | null;

The ID of the Customer to which this PaymentMethod is saved. This will not be set when the PaymentMethod has not been saved to a Customer.

property eps

eps?: PaymentMethod.Eps;

property fpx

fpx?: PaymentMethod.Fpx;

property grabpay

grabpay?: PaymentMethod.GrabPay;

property id

id: string;

Unique identifier for the object.

property ideal

ideal?: PaymentMethod.Ideal;

property kakao_pay

kakao_pay?: PaymentMethod.KakaoPay;

property klarna

klarna?: PaymentMethod.Klarna;

property konbini

konbini?: PaymentMethod.Konbini;

property link

link?: PaymentMethod.Link;

property livemode

livemode: boolean;

Has the value true if the object exists in live mode or the value false if the object exists in test mode.

property metadata

metadata: Metadata;

Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.

property mobile_pay

mobile_pay?: PaymentMethod.MobilePay;

property multibanco

multibanco?: PaymentMethod.Multibanco;

property naver_pay

naver_pay?: PaymentMethod.NaverPay;

property nz_bank_account

nz_bank_account?: PaymentMethod.NzBankAccount;

property object

object: 'payment_method';

String representing the object's type. Objects of the same type share the same value.

property oxxo

oxxo?: PaymentMethod.Oxxo;

property p24

p24?: PaymentMethod.P24;

property pay_by_bank

pay_by_bank?: PaymentMethod.PayByBank;

property payco

payco?: PaymentMethod.Payco;

property paynow

paynow?: PaymentMethod.Paynow;

property paypal

paypal?: PaymentMethod.Paypal;

property pix

pix?: PaymentMethod.Pix;

property promptpay

promptpay?: PaymentMethod.PromptPay;

property revolut_pay

revolut_pay?: PaymentMethod.RevolutPay;

property samsun_pay

samsun_pay?: PaymentMethod.SamsungPay;

property satispay

satispay?: PaymentMethod.Satispay;

property sepa_debit

sepa_debit?: PaymentMethod.SepaDebit;

property swish

swish?: PaymentMethod.Swish;

property twint

twint?: PaymentMethod.Twint;

property type

type: string;

The type of the PaymentMethod. An additional hash is included on the PaymentMethod with a name matching this value. It contains additional information specific to the PaymentMethod type.

property us_bank_account

us_bank_account?: PaymentMethod.UsBankAccount;

property wechat_pay

wechat_pay?: PaymentMethod.WechatPay;

property zip

zip?: PaymentMethod.Zip;

interface PaymentMethodCreateParams

interface PaymentMethodCreateParams {}

property allow_redisplay

allow_redisplay?: 'always' | 'limited' | 'unspecified';

Specifies if the PaymentMethod should be redisplayed when using the Saved Payment Method feature.

property billing_details

billing_details?: PaymentMethodCreateParams.BillingDetails;

Billing information associated with the PaymentMethod that may be used or required by particular types of payment methods.

property metadata

metadata?: MetadataParam;

Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to metadata.

property payment_method

payment_method?: string;

The PaymentMethod to share.

property type

type?: string;

The type of the PaymentMethod. An additional hash is included on the PaymentMethod with a name matching this value. It contains additional information specific to the PaymentMethod type. Required unless payment_method is specified (see the [Cloning PaymentMethods](https://stripe.com/docs/payments/payment-methods/connect#cloning-payment-methods) guide)

interface PaymentRequest

interface PaymentRequest {}

property abort

abort: () => void;

Closes the browser’s payment interface.

property isShowing

isShowing: () => boolean;

true if the browser’s payment interface is showing. When using the PaymentRequestButtonElement, this is called for you automatically.

method canMakePayment

canMakePayment: () => Promise<CanMakePaymentResult | null>;

Returns a Promise that resolves with a truthy value if an enabled wallet is ready to pay. If no wallet is available, it resolves with null.

method off

off: {
    (
        eventType: 'token',
        handler?: (event: PaymentRequestTokenEvent) => any
    ): this;
    (
        eventType: 'paymentmethod',
        handler?: (event: PaymentRequestPaymentMethodEvent) => any
    ): this;
    (
        eventType: 'source',
        handler?: (event: PaymentRequestSourceEvent) => any
    ): this;
    (eventType: 'cancel', handler?: () => any): this;
    (
        eventType: 'shippingaddresschange',
        handler?: (event: PaymentRequestShippingAddressEvent) => any
    ): this;
    (
        eventType: 'shippingoptionchange',
        handler?: (event: PaymentRequestShippingOptionEvent) => any
    ): this;
};

method on

on: {
    (
        eventType: 'token',
        handler: (event: PaymentRequestTokenEvent) => any
    ): this;
    (
        eventType: 'paymentmethod',
        handler: (event: PaymentRequestPaymentMethodEvent) => any
    ): this;
    (
        eventType: 'source',
        handler: (event: PaymentRequestSourceEvent) => any
    ): this;
    (eventType: 'cancel', handler: () => any): this;
    (
        eventType: 'shippingaddresschange',
        handler: (event: PaymentRequestShippingAddressEvent) => any
    ): this;
    (
        eventType: 'shippingoptionchange',
        handler: (event: PaymentRequestShippingOptionEvent) => any
    ): this;
};

Stripe.js automatically creates a Token after the customer is done interacting with the browser’s payment interface. To access the created Token, listen for this event.
Stripe.js automatically creates a PaymentMethod after the customer is done interacting with the browser’s payment interface. To access the created PaymentMethod, listen for this event.
Stripe.js automatically creates a Source after the customer is done interacting with the browser’s payment interface. To access the created Source, listen for this event.
The cancel event is emitted from a PaymentRequest when the browser's payment interface is dismissed.
Note that in some browsers, the payment interface may be dismissed by the customer even after they authorize the payment. This means that you may receive a cancel event on your PaymentRequest object after receiving a token, paymentmethod, or source 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.
The shippingaddresschange event is emitted from a PaymentRequest whenever the customer selects a new address in the browser's payment interface.
The shippingoptionchange event is emitted from a PaymentRequest whenever the customer selects a new shipping option in the browser's payment interface.

method once

once: {
    (
        eventType: 'token',
        handler: (event: PaymentRequestTokenEvent) => any
    ): this;
    (
        eventType: 'paymentmethod',
        handler: (event: PaymentRequestPaymentMethodEvent) => any
    ): this;
    (
        eventType: 'source',
        handler: (event: PaymentRequestSourceEvent) => any
    ): this;
    (eventType: 'cancel', handler: () => any): this;
    (
        eventType: 'shippingaddresschange',
        handler: (event: PaymentRequestShippingAddressEvent) => any
    ): this;
    (
        eventType: 'shippingoptionchange',
        handler: (event: PaymentRequestShippingOptionEvent) => any
    ): this;
};

method show

show: () => void;

Shows the browser’s payment interface. When using the PaymentRequestButtonElement, this is called for you automatically. This method must be called as the result of a user interaction (for example, in a click handler).

method update

update: (options: PaymentRequestUpdateOptions) => void;

PaymentRequest instances can be updated with an options object.
paymentRequest.update can only be called when the browser payment interface is not showing. Listen to the [click](https://stripe.com/docs/js/element/events) and [cancel](https://stripe.com/docs/js/element/events) events to detect if the payment interface has been initiated. To update the PaymentRequest right before the payment interface is initiated, call paymentRequest.update in your click event handler.

interface PaymentRequestEvent

interface PaymentRequestEvent {}

property complete

complete: (status: PaymentRequestCompleteStatus) => void;

Call this function with a CompleteStatus when you have processed the token data provided by the API. Note that you must must call complete within 30 seconds.

property methodName

methodName: string;

Deprecated
Use walletName instead.

property payerEmail

payerEmail?: string;

The customer's email. Only present if it was explicitly asked for [creating the PaymentRequest object](https://stripe.com/docs/js/payment_request/create).

property payerName

payerName?: string;

The customer's name. Only present if it was explicitly asked for [creating the PaymentRequest object](https://stripe.com/docs/js/payment_request/create).

property payerPhone

payerPhone?: string;

The customer's phone. Only present if it was explicitly asked for [creating the PaymentRequest object](https://stripe.com/docs/js/payment_request/create).

property shippingAddress

shippingAddress?: PaymentRequestShippingAddress;

The final ShippingAddress the customer selected. Only present when requestShipping is true when [creating the PaymentRequest object](https://stripe.com/docs/js/payment_request/create), and you've supplied at least one ShippingOption.

property shippingOption

shippingOption?: PaymentRequestShippingOption;

The final ShippingOption the customer selected. Only present when requestShipping is true when [creating the PaymentRequest object](https://stripe.com/docs/js/payment_request/create), and you've supplied at least one ShippingOption.

property walletName

walletName: PaymentRequestWallet | string;

The unique name of the wallet the customer chose to authorize payment. For example, browserCard.

interface PaymentRequestItem

interface PaymentRequestItem {}

A PaymentRequestItem object is used to configure a PaymentRequest.

property amount

amount: number;

The amount in the currency's subunit (e.g. cents, yen, etc.)

property label

label: string;

A name that the browser shows the customer in the payment interface.

property pending

pending?: boolean;

If you might change this amount later (for example, after you have calcluated shipping costs), set this to true. Note that browsers treat this as a hint for how to display things, and not necessarily as something that will prevent submission.

interface PaymentRequestOptions

interface PaymentRequestOptions {}

An set of options to create this PaymentRequest instance with. These options can be updated using paymentRequest.update.

property applePay

applePay?: ApplePayOption & {
    cardFunding?: 'supportsCredit' | 'supportsDebit';
};

Specify the options to be used when the Apple Pay payment interface opens.

property country

country: string;

The two-letter country code of your Stripe account (e.g., US).

property currency

currency: string;

Three character currency code (e.g., usd).

property disableWallets

disableWallets?: PaymentRequestWallet[];

An array of wallet strings. Can be one or more of applePay, googlePay, link and browserCard. Use this option to disable Apple Pay, Google Pay, Link and/or browser-saved cards.

property displayItems

displayItems?: PaymentRequestItem[];

An array of PaymentRequestItem objects. These objects are shown as line items in the browser’s payment interface. Note that the sum of the line item amounts does not need to add up to the total amount above.

property onBehalfOf

onBehalfOf?: string;

The Stripe account ID which is the business of record.

property requestPayerEmail

requestPayerEmail?: boolean;

See the requestPayerName option.

property requestPayerName

requestPayerName?: boolean;

By default, the browser's payment interface only asks the customer for actual payment information. A customer name can be collected by setting this option to true. This collected name will appears in the PaymentRequestEvent object.
We highly recommend you collect at least one of name, email, or phone as this also results in collection of billing address for Apple Pay. The billing address can be used to perform address verification and block fraudulent payments. For all other payment methods, the billing address is automatically collected when available.

property requestPayerPhone

requestPayerPhone?: boolean;

See the requestPayerName option.

property requestShipping

requestShipping?: boolean;

Collect shipping address by setting this option to true. The address appears in the PaymentRequestEvent.
You must also supply a valid PaymentRequestShippingOption to the shippingOptions property. This can be up front at the time stripe.paymentRequest is called, or in response to a shippingaddresschange event using the updateWith callback.

property shippingOptions

shippingOptions?: PaymentRequestShippingOption[];

An array of ShippingOption objects. The first shipping option listed appears in the browser payment interface as the default option.

property total

total: PaymentRequestItem;

This PaymentRequestItem is shown to the customer in the browser’s payment interface.

property wallets

wallets?: PaymentRequestWallet[];

Deprecated
Use disableWallets instead.

interface PaymentRequestPaymentMethodEvent

interface PaymentRequestPaymentMethodEvent extends PaymentRequestEvent {}

property paymentMethod

paymentMethod: PaymentMethod;

interface PaymentRequestShippingAddress

interface PaymentRequestShippingAddress {}

Describes a shipping address collected with a PaymentRequest.

property addressLine

addressLine?: string[];

An array of address line items. For example, 185 Berry St., Suite 500, P.O. Box 12345, etc.

property city

city?: string;

The name of a city, town, village, etc.

property country

country?: string;

Two-letter country code, capitalized. Valid two-letter country codes are specified by ISO3166 alpha-2.

property dependentLocality

dependentLocality?: string;

A logical subdivision of a city. Can be used for things like neighborhoods, boroughs, districts, or UK dependent localities. Not present on Apple platforms.

property phone

phone?: string;

The phone number of the recipient. Note that this might be different from any phone number you collect with requestPayerPhone.

property postalCode

postalCode?: string;

The postal code or ZIP code, also known as PIN code in India.

property recipient

recipient?: string;

The name of the recipient. This might be a person, a business name, or contain “care of” (c/o) instructions.

property region

region?: string;

The most coarse subdivision of a country. Depending on the country, this might correspond to a state, a province, an oblast, a prefecture, or something else along these lines.

property sortingCode

sortingCode?: string;

The sorting code as used in, for example, France. Not present on Apple platforms.

interface PaymentRequestShippingAddressEvent

interface PaymentRequestShippingAddressEvent {}

property shippingAddress

shippingAddress: PaymentRequestShippingAddress;

The customer's selected ShippingAddress. To maintain privacy, browsers may anonymize the shipping address by removing sensitive information that is not necessary to calculate shipping costs. Depending on the country, some fields can be missing or partially redacted. For example, the shipping address in the U.S. may only contain a city, state, and ZIP code. The full shipping address appears in the PaymentRequestEvent object after the purchase is confirmed in the browser’s payment interface

property updateWith

updateWith: (details: PaymentRequestUpdateDetails) => void;

Call this with an UpdateDetails object to merge updates into the current PaymentRequest object. Note that if you subscribe to shippingaddresschange events, then you must call updateWith within 30 seconds.

interface PaymentRequestShippingOption

interface PaymentRequestShippingOption {}

The ShippingOption object describes a shipping method used with a PaymentRequest.

property amount

amount: number;

The amount to show for this shipping option. If the cost of this shipping option depends on the shipping address the customer enters, listen for the shippingaddresschange event.

property detail

detail: string;

A longer description of this shipping option.

property id

id: string;

A unique ID you create to keep track of this shipping option. You’ll be told the ID of the selected option on changes and on completion.

property label

label: string;

A short label for this shipping option.

interface PaymentRequestShippingOptionEvent

interface PaymentRequestShippingOptionEvent {}

property shippingOption

shippingOption: PaymentRequestShippingOption;

The customer's selected ShippingOption.

property updateWith

updateWith: (details: PaymentRequestUpdateDetails) => void;

Call this with an UpdateDetails object to merge updates into the current PaymentRequest object. Note that if you subscribe to shippingaddresschange events, then you must call updateWith within 30 seconds.

interface PaymentRequestSourceEvent

interface PaymentRequestSourceEvent extends PaymentRequestEvent {}

property source

source: Source;

interface PaymentRequestTokenEvent

interface PaymentRequestTokenEvent extends PaymentRequestEvent {}

property token

token: Token;

interface PaymentRequestUpdateDetails

interface PaymentRequestUpdateDetails {}

An object to pass to the updateWith callback on shippingaddresschange and shippingoptionchange events.

property applePay

applePay?: ApplePayUpdateOption;

Specify new options to refresh the Apple Pay payment interface.

property displayItems

displayItems?: PaymentRequestItem[];

These PaymentRequestItems are shown as line items in the browser's payment interface. Note that the sum of the line item amounts does not need to add up to the total amount.

property shippingOptions

shippingOptions?: PaymentRequestShippingOption[];

The first shipping option listed appears in the browser payment interface as the default option.

property status

status?: PaymentRequestUpdateDetailsStatus;

The browser uses this value to show an error message to the customer if they've taken an action that invalidates the payment request.

property total

total?: PaymentRequestItem;

The new total amount, if applicable.

interface PaymentRequestUpdateOptions

interface PaymentRequestUpdateOptions {}

property applePay

applePay?: ApplePayOption & {
    cardFunding?: 'supportsCredit' | 'supportsDebit';
};

Specify the options to be used when the Apple Pay payment interface opens.

property currency

currency?: string;

Three character currency code (e.g., usd).

property displayItems

displayItems?: PaymentRequestItem[];

An array of PaymentRequestItem objects. These objects are shown as line items in the browser’s payment interface. Note that the sum of the line item amounts does not need to add up to the total amount above.

property shippingOptions

shippingOptions?: PaymentRequestShippingOption[];

An array of ShippingOption objects. The first shipping option listed appears in the browser payment interface as the default option.

property total

total?: PaymentRequestItem;

This PaymentRequestItem is shown to the customer in the browser’s payment interface.

interface PaymentWalletsOption

interface PaymentWalletsOption {}

property applePay

applePay?: PaymentWalletOption;

property googlePay

googlePay?: PaymentWalletOption;

property link

link?: PaymentWalletOption;

interface ProcessOrderParams

interface ProcessOrderParams {}

Parameters that will be passed on to the Stripe API to confirm payment for an Order's PaymentIntent.

property return_url

return_url: string;

The url your customer will be directed to after they complete payment.

interface RetrieveSourceParam

interface RetrieveSourceParam {}

An object containing the unique ID and client secret for a Source.
You can use a Source object created with stripe.createSource as the argument to stripe.retrieveSource, as every Source object has both id and client_secret keys.

property client_secret

client_secret: string;

A secret available to the web client that created the Source, for purposes of retrieving the Source later from that same client.

property id

id: string;

Unique identifier of the Source.

interface SetupIntent

interface SetupIntent {}

The SetupIntent object.

property cancellation_reason

cancellation_reason: SetupIntent.CancellationReason | null;

Reason for cancellation of this SetupIntent, one of abandoned, requested_by_customer, or duplicate.

property client_secret

client_secret: string | null;

The client secret of this SetupIntent. Used for client-side retrieval using a publishable key.
The client secret can be used to complete payment setup from your frontend. It should not be stored, logged, embedded in URLs, or exposed to anyone other than the customer. Make sure that you have TLS enabled on any page that includes the client secret.

property created

created: number;

Time at which the object was created. Measured in seconds since the Unix epoch.

property description

description: string | null;

An arbitrary string attached to the object. Often useful for displaying to users.

property id

id: string;

Unique identifier for the object.

property last_setup_error

last_setup_error: SetupIntent.LastSetupError | null;

The error encountered in the previous SetupIntent confirmation.

property livemode

livemode: boolean;

Has the value true if the object exists in live mode or the value false if the object exists in test mode.

property next_action

next_action: SetupIntent.NextAction | null;

If present, this property tells you what actions you need to take in order for your customer to continue payment setup.

property object

object: 'setup_intent';

String representing the object's type. Objects of the same type share the same value.

property payment_method

payment_method: string | null | PaymentMethod;

ID of the payment method used with this SetupIntent, or the PaymentMethod itself if this field is expanded.

property payment_method_types

payment_method_types: Array<string>;

The list of payment method types (e.g. card) that this SetupIntent is allowed to set up.

property status

status: SetupIntent.Status;

[Status](https://stripe.com/docs/payments/intents#intent-statuses) of this SetupIntent, one of requires_payment_method, requires_confirmation, requires_action, processing, canceled, or succeeded.

property usage

usage: string;

Indicates how the payment method is intended to be used in the future.
Use on_session if you intend to only reuse the payment method when the customer is in your checkout flow. Use off_session if your customer may or may not be in your checkout flow. If not provided, this value defaults to off_session.

interface SetupIntentConfirmParams

interface SetupIntentConfirmParams {}

property mandate_data

mandate_data?: { [k: string]: any };

This hash contains details about the Mandate to create

property return_url

return_url?: string;

The URL to redirect your customer back to after they authenticate on the payment method's app or site. If you'd prefer to redirect to a mobile application, you can alternatively supply an application URI scheme. This parameter is only used for cards and other redirect-based payment methods.

interface Source

interface Source {}

The Source object.

property ach_credit_transfer

ach_credit_transfer?: Source.AchCreditTransfer;

property ach_debit

ach_debit?: Source.AchDebit;

property acss_debit

acss_debit?: Source.AcssDebit;

property alipay

alipay?: Source.Alipay;

property amount

amount: number | null;

A positive integer in the smallest currency unit (that is, 100 cents for $1.00, or 1 for ¥1, Japanese Yen being a zero-decimal currency) representing the total amount associated with the source. This is the amount for which the source will be chargeable once ready. Required for single_use sources.

property au_becs_debit

au_becs_debit?: Source.AuBecsDebit;

property bancontact

bancontact?: Source.Bancontact;

property card

card?: Source.Card;

property card_present

card_present?: Source.CardPresent;

property client_secret

client_secret: string;

The client secret of the source. Used for client-side retrieval using a publishable key.

property code_verification

code_verification?: Source.CodeVerification;

property created

created: number;

Time at which the object was created. Measured in seconds since the Unix epoch.

property currency

currency: string | null;

Three-letter [ISO code for the currency](https://stripe.com/docs/currencies) associated with the source. This is the currency for which the source will be chargeable once ready. Required for single_use sources.

property customer

customer?: string;

The ID of the customer to which this source is attached. This will not be present when the source has not been attached to a customer.

property eps

eps?: Source.Eps;

property flow

flow: string;

The authentication flow of the source. flow is one of redirect, receiver, code_verification, none.

property giropay

giropay?: Source.Giropay;

property id

id: string;

Unique identifier for the object.

property ideal

ideal?: Source.Ideal;

property klarna

klarna?: Source.Klarna;

property livemode

livemode: boolean;

Has the value true if the object exists in live mode or the value false if the object exists in test mode.

property metadata

metadata: Metadata | null;

Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.

property multibanco

multibanco?: Source.Multibanco;

property object

object: 'source';

String representing the object's type. Objects of the same type share the same value.

property owner

owner: Source.Owner | null;

Information about the owner of the payment instrument that may be used or required by particular source types.

property p24

p24?: Source.P24;

property receiver

receiver?: Source.Receiver;

property redirect

redirect?: Source.Redirect;

property sepa_credit_transfer

sepa_credit_transfer?: Source.SepaCreditTransfer;

property sepa_debit

sepa_debit?: Source.SepaDebit;

property sofort

sofort?: Source.Sofort;

property source_order

source_order?: Source.SourceOrder;

property statement_descriptor

statement_descriptor: string | null;

Extra information about a source. This will appear on your customer's statement every time you charge the source.

property status

status: string;

The status of the source, one of canceled, chargeable, consumed, failed, or pending. Only chargeable sources can be used to create a charge.

property three_d_secure

three_d_secure?: Source.ThreeDSecure;

property type

type: Source.Type;

The type of the source. The type is a payment method, one of ach_credit_transfer, ach_debit, alipay, bancontact, card, card_present, eps, giropay, ideal, multibanco, klarna, p24, sepa_debit, sofort, three_d_secure, or wechat. An additional hash is included on the source with a name matching this value. It contains additional information specific to the [payment method](https://stripe.com/docs/sources) used.

property usage

usage: string | null;

Either reusable or single_use. Whether this source should be reusable or not. Some source types may or may not be reusable by construction, while others may leave the option at creation. If an incompatible value is passed, an error will be returned.

property wechat

wechat?: Source.Wechat;

interface SourceCreateParams

interface SourceCreateParams {}

property amount

amount?: number;

Amount associated with the source. This is the amount for which the source will be chargeable once ready. Required for single_use sources. Not supported for receiver type sources, where charge amount may not be specified until funds land.

property currency

currency?: string;

Three-letter [ISO code for the currency](https://stripe.com/docs/currencies) associated with the source. This is the currency for which the source will be chargeable once ready.

property customer

customer?: string;

The Customer to whom the original source is attached to. Must be set when the original source is not a Source (e.g., Card).

property expand

expand?: Array<string>;

Specifies which fields in the response should be expanded.

property flow

flow?: SourceCreateParams.Flow;

The authentication flow of the source to create. flow is one of redirect, receiver, code_verification, none. It is generally inferred unless a type supports multiple flows.

property mandate

mandate?: SourceCreateParams.Mandate;

Information about a mandate possibility attached to a source object (generally for bank debits) as well as its acceptance status.

property metadata

metadata?: MetadataParam;

property original_source

original_source?: string;

The source to share.

property owner

owner?: SourceCreateParams.Owner;

Information about the owner of the payment instrument that may be used or required by particular source types.

property receiver

receiver?: SourceCreateParams.Receiver;

Optional parameters for the receiver flow. Can be set only if the source is a receiver (flow is receiver).

property redirect

redirect?: SourceCreateParams.Redirect;

Parameters required for the redirect flow. Required if the source is authenticated by a redirect (flow is redirect).

property source_order

source_order?: SourceCreateParams.SourceOrder;

Information about the items and shipping associated with the source. Required for transactional credit (for example Klarna) sources before you can charge it.

property statement_descriptor

statement_descriptor?: string;

An arbitrary string to be displayed on your customer's statement. As an example, if your website is RunClub and the item you're charging for is a race ticket, you may want to specify a statement_descriptor of RunClub 5K race ticket. While many payment types will display this information, some may not display it at all.

property token

token?: string;

An optional token used to create the source. When passed, token properties will override source parameters.

property type

type?: string;

The type of the source to create. Required unless customer and original_source are specified (see the [Cloning card Sources](https://stripe.com/docs/sources/connect#cloning-card-sources) guide)

property usage

usage?: SourceCreateParams.Usage;

interface Stripe

interface Stripe {}

method collectBankAccountForPayment

collectBankAccountForPayment: (
    options: paymentIntents.CollectBankAccountForPaymentOptions
) => Promise<PaymentIntentResult>;

Use stripe.collectBankAccountForPayment in the [Accept a payment flow](https://stripe.com/docs/payments/ach-debit/accept-a-payment) for the [ACH Direct Debit](https://stripe.com/docs/payments/ach-debit) payment method to collect the customer’s bank account in your payment form.
https://stripe.com/docs/js/payment_intents/collect_bank_account_for_payment

method collectBankAccountForSetup

collectBankAccountForSetup: (
    options: setupIntents.CollectBankAccountForSetupOptions
) => Promise<SetupIntentResult>;

Use stripe.collectBankAccountForSetup in the [Save bank details](https://stripe.com/docs/payments/ach-debit/set-up-payment) flow for the [ACH Direct Debit](https://stripe.com/docs/payments/ach-debit) payment method to collect the customer’s bank account in your payment form.
https://stripe.com/docs/js/setup_intents/collect_bank_account_for_setup

method collectBankAccountToken

collectBankAccountToken: (
    options: financialConnections.CollectBankAccountTokenOptions
) => Promise<CollectBankAccountTokenResult>;

Use stripe.collectBankAccountToken to display a [Financial Connections](https://stripe.com/docs/financial-connections) modal that lets you securely collect a [Bank Account Token](https://stripe.com/docs/api/tokens/object).
* https://stripe.com/docs/js/financial_connections/collect_bank_account_token

method collectFinancialConnectionsAccounts

collectFinancialConnectionsAccounts: (
    options: financialConnections.CollectFinancialConnectionsAccountsOptions
) => Promise<FinancialConnectionsSessionResult>;

Use stripe.collectFinancialConnectionsAccounts to display a [Financial Connections](https://stripe.com/docs/financial-connections) modal that lets you securely collect financial accounts.
* https://stripe.com/docs/js/financial_connections/collect_financial_connections_accounts

method confirmAcssDebitPayment

confirmAcssDebitPayment: (
    clientSecret: string,
    data?: paymentIntents.ConfirmAcssDebitPaymentData,
    options?: paymentIntents.ConfirmAcssDebitPaymentOptions
) => Promise<PaymentIntentResult>;

Use stripe.confirmAcssDebitPayment in the [Accept a Canadian pre-authorized debit payment](https://stripe.com/docs/payments/acss-debit/accept-a-payment) flow when the customer submits your payment form. When called, it will automatically pop up a modal to collect bank account details and verification, accept the mandate, and confirm the [PaymentIntent](https://stripe.com/docs/api/payment_intents) when the user submits the form.
When you confirm a PaymentIntent, it needs to have an attached [PaymentMethod](https://stripe.com/docs/api/payment_methods). stripe.confirmAcssDebitPayment automatically creates a new PaymentMethod for you when your customer completes the modal UI. It can also be called with an existing PaymentMethod which will load the modal UI to collect a new mandate agreement. If you have already attached a PaymentMethod, you can call this method without needing to provide any additional data.
https://stripe.com/docs/js/payment_intents/confirm_acss_debit_payment

method confirmAcssDebitSetup

confirmAcssDebitSetup: (
    clientSecret: string,
    data?: setupIntents.ConfirmAcssDebitSetupData,
    options?: setupIntents.ConfirmAcssDebitSetupOptions
) => Promise<SetupIntentResult>;

Use stripe.confirmAcssDebitSetup to [save details for future payments with pre-authorized debit in Canada](https://stripe.com/docs/payments/acss-debit/set-up-payment). When called, it will automatically pop up a modal to collect bank account details and verification, accept the mandate, and confirm the [SetupIntent](https://stripe.com/docs/api/setup_intents) when the user submits the form.
When you confirm a SetupIntent, it needs to have an attached [PaymentMethod](https://stripe.com/docs/api/payment_methods). stripe.confirmAcssDebitSetup automatically creates a new PaymentMethod for you when your customer completes the modal UI. It can also be called with an existing PaymentMethod which will load the modal UI to collect a new mandate agreement. If you have already attached a PaymentMethod, you can call this method without needing to provide any additional data.
https://stripe.com/docs/js/setup_intents/confirm_acss_debit_setup

method confirmAffirmPayment

confirmAffirmPayment: (
    clientSecret: string,
    data?: paymentIntents.ConfirmAffirmPaymentData,
    options?: paymentIntents.ConfirmAffirmPaymentOptions
) => Promise<PaymentIntentResult>;

Use stripe.confirmAffirmPayment in the [Affirm payments](https://stripe.com/docs/payments/affirm) flow when the customer submits your payment form. When called, it will confirm the [PaymentIntent](https://stripe.com/docs/api/payment_intents). Refer to our [integration guide](https://stripe.com/docs/payments/affirm/accept-a-payment) for more details.
https://stripe.com/docs/js/payment_intents/confirm_affirm_payment

method confirmAfterpayClearpayPayment

confirmAfterpayClearpayPayment: (
    clientSecret: string,
    data?: paymentIntents.ConfirmAfterpayClearpayPaymentData,
    options?: paymentIntents.ConfirmAfterpayClearpayPaymentOptions
) => Promise<PaymentIntentResult>;

Use stripe.confirmAfterpayClearpayPayment in the [Afterpay / Clearpay payments](https://stripe.com/docs/payments/afterpay-clearpay) flow when the customer submits your payment form. When called, it will confirm the [PaymentIntent](https://stripe.com/docs/api/payment_intents). Refer to our [integration guide](https://stripe.com/docs/payments/afterpay-clearpay/accept-a-payment) for more details.
https://stripe.com/docs/js/payment_intents/confirm_afterpay_clearpay_payment

method confirmAlipayPayment

confirmAlipayPayment: (
    clientSecret: string,
    data?: paymentIntents.ConfirmAlipayPaymentData,
    options?: paymentIntents.ConfirmAlipayPaymentOptions
) => Promise<PaymentIntentResult>;

Use stripe.confirmAlipayPayment in the [Alipay Payments](https://stripe.com/docs/payments/alipay) with Payment Methods flow when the customer submits your payment form. When called, it will confirm the [PaymentIntent](https://stripe.com/docs/api/payment_intents) with data you provide, and it will automatically redirect the customer to authorize the transaction. Once authorization is complete, the customer will be redirected back to your specified return_url.
When you confirm a PaymentIntent, it needs to have an attached [PaymentMethod](https://stripe.com/docs/api/payment_methods). In addition to confirming the PaymentIntent, this method can automatically create and attach a new PaymentMethod for you. If you have already attached a PaymentMethod you can call this method without needing to provide any additional data.
https://stripe.com/docs/js/payment_intents/confirm_alipay_payment

method confirmAuBecsDebitPayment

confirmAuBecsDebitPayment: (
    clientSecret: string,
    data?: paymentIntents.ConfirmAuBecsDebitPaymentData
) => Promise<PaymentIntentResult>;

Requires beta access: Contact [Stripe support](https://support.stripe.com/) for more information.
Use stripe.confirmAuBecsDebitPayment in the [BECS Direct Debit Payments](https://stripe.com/docs/payments/payment-methods/au-becs-debit) with Payment Methods flow when the customer submits your payment form. When called, it will confirm the [PaymentIntent](https://stripe.com/docs/api/payment_intents) with data you provide. Note that there are some additional requirements to this flow that are not covered in this reference. Refer to our [integration guide](https://stripe.com/docs/payments/payment-methods/au-becs-debit-quickstart-payment-intents) for more details.
When you confirm a PaymentIntent, it needs to have an attached [PaymentMethod](https://stripe.com/docs/api/payment_methods). In addition to confirming the PaymentIntent, this method can automatically create and attach a new PaymentMethod for you. If you have already attached a PaymentMethod you can call this method without needing to provide any additional data.
https://stripe.com/docs/js/payment_intents/confirm_au_becs_debit_payment

method confirmAuBecsDebitSetup

confirmAuBecsDebitSetup: (
    clientSecret: string,
    data?: setupIntents.ConfirmAuBecsDebitSetupData
) => Promise<SetupIntentResult>;

Requires beta access: Contact [Stripe support](https://support.stripe.com/) for more information.
Use stripe.confirmAuBecsDebitSetup in the [BECS Direct Debit with Setup Intents](https://stripe.com/docs/payments/payment-methods/au-becs-debit-quickstart-setup-intents) flow when the customer submits your payment form. When called, it will confirm the SetupIntent with data you provide. Note that there are some additional requirements to this flow that are not covered in this reference. Refer to our [integration guide](https://stripe.com/docs/payments/payment-methods/au-becs-debit-quickstart-setup-intents) for more details.
When you confirm a SetupIntent, it needs to have an attached [PaymentMethod](https://stripe.com/docs/api/payment_methods). In addition to confirming the SetupIntent, this method can automatically create and attach a new PaymentMethod for you. It can also be called with an existing PaymentMethod, or if you have already attached a PaymentMethod you can call this method without needing to provide any additional data.
https://stripe.com/docs/js/setup_intents/confirm_au_becs_debit_setup

method confirmBacsDebitSetup

confirmBacsDebitSetup: (
    clientSecret: string,
    data?: setupIntents.ConfirmBacsDebitSetupData
) => Promise<SetupIntentResult>;

Use stripe.confirmBacsDebitSetup in the [Bacs Direct Debit Payments](https://stripe.com/docs/payments/payment-methods/bacs-debit) flow when the customer submits your payment form. When called, it will confirm the [SetupIntent](https://stripe.com/docs/api/setup_intents) with data you provide. Note that there are some additional requirements to this flow that are not covered in this reference. Refer to our [integration guide](https://stripe.com/docs/payments/payment-methods/bacs-debit) for more details.
When you confirm a SetupIntent, it needs to have an attached [PaymentMethod](https://stripe.com/docs/api/payment_methods). In addition to confirming the SetupIntent, this method can automatically create and attach a new PaymentMethod for you. It can also be called with an existing PaymentMethod, or if you have already attached a PaymentMethod you can call this method without needing to provide any additional data.
https://stripe.com/docs/js/setup_intents/confirm_bacs_debit_setup

method confirmBancontactPayment

confirmBancontactPayment: (
    clientSecret: string,
    data?: paymentIntents.ConfirmBancontactPaymentData,
    options?: paymentIntents.ConfirmBancontactPaymentOptions
) => Promise<PaymentIntentResult>;

Use stripe.confirmBancontactPayment in the [Bancontact Payments with Payment Methods](https://stripe.com/docs/payments/bancontact#web) flow when the customer submits your payment form. When called, it will confirm the PaymentIntent with data you provide, and it will automatically redirect the customer to authorize the transaction. Once authorization is complete, the customer will be redirected back to your specified return_url.
When you confirm a PaymentIntent, it needs to have an attached [PaymentMethod](https://stripe.com/docs/api/payment_methods). In addition to confirming the PaymentIntent, this method can automatically create and attach a new PaymentMethod for you. If you have already attached a PaymentMethod you can call this method without needing to provide any additional data.
https://stripe.com/docs/js/payment_intents/confirm_bancontact_payment

method confirmBancontactSetup

confirmBancontactSetup: (
    clientSecret: string,
    data?: setupIntents.ConfirmBancontactSetupData
) => Promise<SetupIntentResult>;

Use stripe.confirmBancontactSetup in the [Set up future payments](https://stripe.com/docs/payments/bancontact/set-up-payment) flow to use Bancontact bank details to set up a SEPA Direct Debit payment method for future payments. When called, it will confirm a SetupIntent with data you provide, and it will automatically redirect the customer to authorize the transaction. Once authorization is complete, the customer will be redirected back to your specified return_url. Note that there are some additional requirements to this flow that are not covered in this reference. Refer to our [integration guide](https://stripe.com/docs/payments/bancontact/set-up-payment) for more details.
When you confirm a SetupIntent, it needs to have an attached [PaymentMethod](https://stripe.com/docs/api/payment_methods). In addition to confirming the SetupIntent, this method can automatically create and attach a new PaymentMethod for you. It can also be called with an existing PaymentMethod, or if you have already attached a PaymentMethod you can call this method without needing to provide any additional data.
https://stripe.com/docs/js/payment_intents/confirm_bancontact_setup

method confirmBilliePayment

confirmBilliePayment: (
    clientSecret: string,
    data?: paymentIntents.ConfirmBilliePaymentData,
    options?: paymentIntents.ConfirmBilliePaymentOptions
) => Promise<PaymentIntentResult>;

Requires beta access: Contact [Stripe support](https://support.stripe.com/) for more information.
Use stripe.confirmBilliePayment in the [Billie Payments](https://stripe.com/docs/payments/billie) with Payment Methods flow when the customer submits your payment form. When called, it will confirm the [PaymentIntent](https://stripe.com/docs/api/payment_intents) with data you provide, and it will automatically redirect the customer to authorize the transaction. Once authorization is complete, the customer will be redirected back to your specified return_url.
When you confirm a PaymentIntent, it needs to have an attached [PaymentMethod](https://stripe.com/docs/api/payment_methods). In addition to confirming the PaymentIntent, this method can automatically create and attach a new PaymentMethod for you. If you have already attached a PaymentMethod you can call this method without needing to provide any additional data.

method confirmBlikPayment

confirmBlikPayment: (
    clientSecret: string,
    data: paymentIntents.ConfirmBlikPaymentData,
    options?: paymentIntents.ConfirmBlikPaymentOptions
) => Promise<PaymentIntentResult>;

Use stripe.confirmBlikPayment in the [BLIK Payments with Payment Methods](https://stripe.com/docs/payments/blik) flow when the customer submits your payment form. When called, it will confirm the PaymentIntent with data you provide, and it will automatically prompt the customer to authorize the transaction.
https://stripe.com/docs/js/payment_intents/confirm_blik_payment

method confirmBoletoPayment

confirmBoletoPayment: (
    clientSecret: string,
    data?: paymentIntents.ConfirmBoletoPaymentData,
    options?: paymentIntents.ConfirmBoletoPaymentOptions
) => Promise<PaymentIntentResult>;

Use stripe.confirmBoletoPayment in the [Boleto Payment](https://stripe.com/docs/payments/boleto) with Payment Methods flow when the customer submits your payment form. When called, it will confirm the [PaymentIntent](https://stripe.com/docs/api/payment_intents) with data you provide. Note that there are some additional requirements to this flow that are not covered in this reference. Refer to our [integration guide](https://stripe.com/docs/payments/boleto) for more details.
When you confirm a PaymentIntent, it needs to have an attached [PaymentMethod](https://stripe.com/docs/api/payment_methods). In addition to confirming the PaymentIntent, this method can automatically create and attach a new PaymentMethod for you. If you have already attached a PaymentMethod you can call this method without needing to provide any additional data.
https://stripe.com/docs/js/payment_intents/confirm_boleto_payment

method confirmCardPayment

confirmCardPayment: (
    clientSecret: string,
    data?: paymentIntents.ConfirmCardPaymentData,
    options?: paymentIntents.ConfirmCardPaymentOptions
) => Promise<PaymentIntentResult>;

Use stripe.confirmCardPayment when the customer submits your payment form. When called, it will confirm the [PaymentIntent](https://stripe.com/docs/api/payment_intents) with data you provide and carry out 3DS or other next actions if they are required.
If you are using [Dynamic 3D Secure](https://stripe.com/docs/payments/3d-secure#three-ds-radar), stripe.confirmCardPayment will trigger your Radar rules to execute and may open a dialog for your customer to authenticate their payment.
When you confirm a PaymentIntent, it needs to have an attached [PaymentMethod](https://stripe.com/docs/api/payment_methods). In addition to confirming the PaymentIntent, this method can automatically create and attach a new PaymentMethod for you. It can also be called with an existing PaymentMethod, or if you have already attached a PaymentMethod you can call this method without needing to provide any additional data.
https://stripe.com/docs/js/payment_intents/confirm_card_payment

method confirmCardSetup

confirmCardSetup: (
    clientSecret: string,
    data?: setupIntents.ConfirmCardSetupData,
    options?: setupIntents.ConfirmCardSetupOptions
) => Promise<SetupIntentResult>;

Use stripe.confirmCardSetup in the [Setup Intents API flow](https://stripe.com/docs/payments/save-and-reuse) when the customer submits your payment form. When called, it will confirm the [SetupIntent](https://stripe.com/docs/api/setup_intents) with data you provide and carry out 3DS or other next actions if they are required.
When you confirm a SetupIntent, it needs to have an attached [PaymentMethod](https://stripe.com/docs/api/payment_methods). In addition to confirming the SetupIntent, this method can automatically create and attach a new PaymentMethod for you. It can also be called with an existing PaymentMethod, or if you have already attached a PaymentMethod you can call this method without needing to provide any additional data.
https://stripe.com/docs/js/setup_intents/confirm_card_setup

method confirmCashappPayment

confirmCashappPayment: (
    clientSecret: string,
    data?: paymentIntents.ConfirmCashappPaymentData,
    options?: paymentIntents.ConfirmCashappPaymentOptions
) => Promise<PaymentIntentResult>;

Use stripe.confirmCashappPayment in the [Cash App Payments](https://stripe.com/docs/payments/cash-app-pay) with Payment Methods flow when the customer submits your payment form. When called, it will confirm the [PaymentIntent](https://stripe.com/docs/api/payment_intents) with data you provide. Refer to our [integration guide](https://stripe.com/docs/payments/cash-app-pay) for more details.
When you confirm a PaymentIntent, it needs to have an attached [PaymentMethod](https://stripe.com/docs/api/payment_methods). In addition to confirming the PaymentIntent, this method can automatically create and attach a new PaymentMethod for you. If you have already attached a PaymentMethod you can call this method without needing to provide any additional data.
https://stripe.com/docs/js/payment_intents/confirm_cashapp_payment

method confirmCashappSetup

confirmCashappSetup: (
    clientSecret: string,
    data?: setupIntents.ConfirmCashappSetupData,
    options?: setupIntents.ConfirmCashappSetupOptions
) => Promise<SetupIntentResult>;

Use stripe.confirmCashappSetup in the [Setup Intents API flow](https://stripe.com/docs/payments/save-and-reuse) when the customer submits your payment form. When called, it will confirm the [SetupIntent](https://stripe.com/docs/api/setup_intents) with data you provide. Refer to our [integration guide](https://stripe.com/docs/payments/cash-app-pay) for more details..
When you confirm a SetupIntent, it needs to have an attached [PaymentMethod](https://stripe.com/docs/api/payment_methods). In addition to confirming the SetupIntent, this method can automatically create and attach a new PaymentMethod for you. It can also be called with an existing PaymentMethod, or if you have already attached a PaymentMethod you can call this method without needing to provide any additional data.
https://stripe.com/docs/js/payment_intents/confirm_cashapp_setup

method confirmCustomerBalancePayment

confirmCustomerBalancePayment: (
    clientSecret: string,
    data: paymentIntents.ConfirmCustomerBalancePaymentData,
    options: paymentIntents.ConfirmCustomerBalancePaymentOptions
) => Promise<PaymentIntentResult>;

Requires beta access: Contact [Stripe support](https://support.stripe.com/) for more information.
Use stripe.confirmCustomerBalancePayment when the customer submits your payment form.
When called, it will confirm the PaymentIntent with data you provide. Refer to our [integration guide](https://stripe.com/docs/payments/bank-transfers) for more details.
Since the Customer Balance payment method draws from a balance, the attempt will succeed or fail depending on the current balance amount. To collect more funds from the customer when the cash balance is insufficient, use the customer balance with bank transfer funding parameters. The confirmation attempt will finish in one of the following result states: 1. If the customer balance was enough to pay the amount, the status is succeeded. The funding_type data is effectively ignored. 2. If the balance was not enough to pay the amount, and you didn't send the funding_type, the status is requires_payment_method. 3. If the balance was not enough to pay the amount, and you did send the funding_type, the status is requires_action. The paymentIntent.next_action.display_bank_transfer_instructions hash contains bank transfer details for funding the Customer Balance.
https://stripe.com/docs/js/payment_intents/confirm_customer_balance_payment

method confirmEpsPayment

confirmEpsPayment: (
    clientSecret: string,
    data?: paymentIntents.ConfirmEpsPaymentData,
    options?: paymentIntents.ConfirmEpsPaymentOptions
) => Promise<PaymentIntentResult>;

Use stripe.confirmEpsPayment in the [EPS Payments with Payment Methods](https://stripe.com/docs/payments/eps#web) flow when the customer submits your payment form. When called, it will confirm the PaymentIntent with data you provide, and it will automatically redirect the customer to authorize the transaction. Once authorization is complete, the customer will be redirected back to your specified return_url.
When you confirm a PaymentIntent, it needs to have an attached [PaymentMethod](https://stripe.com/docs/api/payment_methods). In addition to confirming the PaymentIntent, this method can automatically create and attach a new PaymentMethod for you. If you have already attached a PaymentMethod you can call this method without needing to provide any additional data.
https://stripe.com/docs/js/payment_intents/confirm_eps_payment

method confirmFpxPayment

confirmFpxPayment: (
    clientSecret: string,
    data?: paymentIntents.ConfirmFpxPaymentData,
    options?: paymentIntents.ConfirmFpxPaymentOptions
) => Promise<PaymentIntentResult>;

Use stripe.confirmFpxPayment in the [FPX Payments with Payment Methods](https://stripe.com/docs/payments/fpx#web) flow when the customer submits your payment form. When called, it will confirm the PaymentIntent with data you provide, and it will automatically redirect the customer to authorize the transaction. Once authorization is complete, the customer will be redirected back to your specified return_url.
When you confirm a PaymentIntent, it needs to have an attached [PaymentMethod](https://stripe.com/docs/api/payment_methods). In addition to confirming the PaymentIntent, this method can automatically create and attach a new PaymentMethod for you. If you have already attached a PaymentMethod you can call this method without needing to provide any additional data.
https://stripe.com/docs/js/payment_intents/confirm_fpx_payment

method confirmGiropayPayment

confirmGiropayPayment: (
    clientSecret: string,
    data?: paymentIntents.ConfirmGiropayPaymentData,
    options?: paymentIntents.ConfirmGiropayPaymentOptions
) => Promise<PaymentIntentResult>;

Use stripe.confirmGiropayPayment in the [giropay Payments with Payment Methods](https://stripe.com/docs/payments/giropay#web) flow when the customer submits your payment form. When called, it will confirm the PaymentIntent with data you provide, and it will automatically redirect the customer to authorize the transaction. Once authorization is complete, the customer will be redirected back to your specified return_url.
When you confirm a PaymentIntent, it needs to have an attached [PaymentMethod](https://stripe.com/docs/api/payment_methods). In addition to confirming the PaymentIntent, this method can automatically create and attach a new PaymentMethod for you. If you have already attached a PaymentMethod you can call this method without needing to provide any additional data.
https://stripe.com/docs/js/payment_intents/confirm_giropay_payment

method confirmGrabPayPayment

confirmGrabPayPayment: (
    clientSecret: string,
    data?: paymentIntents.ConfirmGrabPayPaymentData,
    options?: paymentIntents.ConfirmGrabPayPaymentOptions
) => Promise<PaymentIntentResult>;

Use stripe.confirmGrabPayPayment in the [GrabPay payments](https://stripe.com/docs/payments/grabpay) flow when the customer submits your payment form. When called, it will confirm the [PaymentIntent](https://stripe.com/docs/api/payment_intents). Refer to our [integration guide](https://stripe.com/docs/payments/grabpay/accept-a-payment) for more details.
https://stripe.com/docs/js/payment_intents/confirm_grabpay_payment

method confirmIdealPayment

confirmIdealPayment: (
    clientSecret: string,
    data?: paymentIntents.ConfirmIdealPaymentData,
    options?: paymentIntents.ConfirmIdealPaymentOptions
) => Promise<PaymentIntentResult>;

Use stripe.confirmIdealPayment in the [iDEAL Payments with Payment Methods](https://stripe.com/docs/payments/ideal) flow when the customer submits your payment form. When called, it will confirm the PaymentIntent with data you provide, and it will automatically redirect the customer to authorize the transaction. Once authorization is complete, the customer will be redirected back to your specified return_url.
When you confirm a PaymentIntent, it needs to have an attached [PaymentMethod](https://stripe.com/docs/api/payment_methods). In addition to confirming the PaymentIntent, this method can automatically create and attach a new PaymentMethod for you. If you have already attached a PaymentMethod you can call this method without needing to provide any additional data.
https://stripe.com/docs/js/payment_intents/confirm_ideal_payment

method confirmIdealSetup

confirmIdealSetup: (
    clientSecret: string,
    data?: setupIntents.ConfirmIdealSetupData
) => Promise<SetupIntentResult>;

Use stripe.confirmIdealSetup in the [Set up future payments](https://stripe.com/docs/payments/ideal/set-up-payment) flow to use iDEAL bank details to set up a SEPA Direct Debit payment method for future payments. When called, it will confirm a SetupIntent with data you provide, and it will automatically redirect the customer to authorize the transaction. Once authorization is complete, the customer will be redirected back to your specified return_url. Note that there are some additional requirements to this flow that are not covered in this reference. Refer to our [integration guide](https://stripe.com/docs/payments/ideal/set-up-payment) for more details.
When you confirm a SetupIntent, it needs to have an attached [PaymentMethod](https://stripe.com/docs/api/payment_methods). In addition to confirming the SetupIntent, this method can automatically create and attach a new PaymentMethod for you. It can also be called with an existing PaymentMethod, or if you have already attached a PaymentMethod you can call this method without needing to provide any additional data.
https://stripe.com/docs/js/setup_intents/confirm_ideal_setup

method confirmKlarnaPayment

confirmKlarnaPayment: (
    clientSecret: string,
    data?: paymentIntents.ConfirmKlarnaPaymentData,
    options?: paymentIntents.ConfirmKlarnaPaymentOptions
) => Promise<PaymentIntentResult>;

Requires beta access: Contact [Stripe support](https://support.stripe.com/) for more information.
Use stripe.confirmKlarnaPayment in the [Klarna Payments](https://stripe.com/docs/payments/klarna) with Payment Methods flow when the customer submits your payment form. When called, it will confirm the [PaymentIntent](https://stripe.com/docs/api/payment_intents) with data you provide, and it will automatically redirect the customer to authorize the transaction. Once authorization is complete, the customer will be redirected back to your specified return_url.
When you confirm a PaymentIntent, it needs to have an attached [PaymentMethod](https://stripe.com/docs/api/payment_methods). In addition to confirming the PaymentIntent, this method can automatically create and attach a new PaymentMethod for you. If you have already attached a PaymentMethod you can call this method without needing to provide any additional data.
https://stripe.com/docs/js/payment_intents/confirm_klarna_payment

method confirmKonbiniPayment

confirmKonbiniPayment: (
    clientSecret: string,
    data?: paymentIntents.ConfirmKonbiniPaymentData,
    options?: paymentIntents.ConfirmKonbiniPaymentOptions
) => Promise<PaymentIntentResult>;

Use stripe.confirmKonbiniPayment in the [Konbini](https://stripe.com/docs/payments/konbini) payment flow when the customer submits your payment form. When called, it will confirm the [PaymentIntent](https://stripe.com/docs/api/payment_intents) with data you provide. Note that there are some additional requirements to this flow that are not covered in this reference. Refer to our [integration guide](https://stripe.com/docs/payments/konbini/accept-a-payment) for more details.
When you confirm a PaymentIntent, it needs to have an attached [PaymentMethod](https://stripe.com/docs/api/payment_methods). In addition to confirming the PaymentIntent, this method can automatically create and attach a new PaymentMethod for you. If you have already attached a PaymentMethod you can call this method without needing to provide any additional data.
https://stripe.com/docs/js/payment_intents/confirm_konbini_payment

method confirmMobilepayPayment

confirmMobilepayPayment: (
    clientSecret: string,
    data?: paymentIntents.ConfirmMobilepayPaymentData,
    options?: paymentIntents.ConfirmMobilepayPaymentOptions
) => Promise<PaymentIntentResult>;

Use stripe.confirmMobilepayPayment in the [Mobilepay Payments](https://docs.stripe.com/payments/mobilepay) with Payment Methods flow when the customer submits your payment form. When called, it will confirm the [PaymentIntent](https://stripe.com/docs/api/payment_intents) with data you provide. Refer to our [integration guide](https://docs.stripe.com/payments/mobilepay) for more details.
When you confirm a PaymentIntent, it needs to have an attached [PaymentMethod](https://stripe.com/docs/api/payment_methods). In addition to confirming the PaymentIntent, this method can automatically create and attach a new PaymentMethod for you. If you have already attached a PaymentMethod you can call this method without needing to provide any additional data.
https://stripe.com/docs/js/payment_intents/confirm_mobilepay_payment

method confirmMultibancoPayment

confirmMultibancoPayment: (
    clientSecret: string,
    data?: paymentIntents.ConfirmMultibancoPaymentData,
    options?: paymentIntents.ConfirmMultibancoPaymentOptions
) => Promise<PaymentIntentResult>;

Use stripe.confirmMultibancoPayment in the [Multibanco Payment](https://stripe.com/docs/payments/multibanco) with Payment Methods flow when the customer submits your payment form. When called, it will confirm the [PaymentIntent](https://stripe.com/docs/api/payment_intents) with data you provide. Note that there are some additional requirements to this flow that are not covered in this reference. Refer to our [integration guide](https://stripe.com/docs/payments/multibanco) for more details.
When you confirm a PaymentIntent, it needs to have an attached [PaymentMethod](https://stripe.com/docs/api/payment_methods). In addition to confirming the PaymentIntent, this method can automatically create and attach a new PaymentMethod for you. If you have already attached a PaymentMethod you can call this method without needing to provide any additional data.
https://stripe.com/docs/js/payment_intents/confirm_multibanco_payment

method confirmOxxoPayment

confirmOxxoPayment: (
    clientSecret: string,
    data?: paymentIntents.ConfirmOxxoPaymentData,
    options?: paymentIntents.ConfirmOxxoPaymentOptions
) => Promise<PaymentIntentResult>;

Use stripe.confirmOxxoPayment in the [OXXO Payment](https://stripe.com/docs/payments/oxxo) with Payment Methods flow when the customer submits your payment form. When called, it will confirm the [PaymentIntent](https://stripe.com/docs/api/payment_intents) with data you provide. Note that there are some additional requirements to this flow that are not covered in this reference. Refer to our [integration guide](https://stripe.com/docs/payments/oxxo) for more details.
When you confirm a PaymentIntent, it needs to have an attached [PaymentMethod](https://stripe.com/docs/api/payment_methods). In addition to confirming the PaymentIntent, this method can automatically create and attach a new PaymentMethod for you. If you have already attached a PaymentMethod you can call this method without needing to provide any additional data.
https://stripe.com/docs/js/payment_intents/confirm_oxxo_payment

method confirmP24Payment

confirmP24Payment: (
    clientSecret: string,
    data?: paymentIntents.ConfirmP24PaymentData,
    options?: paymentIntents.ConfirmP24PaymentOptions
) => Promise<PaymentIntentResult>;

Use stripe.confirmP24Payment in the [Przelewy24 Payments with Payment Methods](https://stripe.com/docs/payments/p24#web) flow when the customer submits your payment form. When called, it will confirm the PaymentIntent with data you provide, and it will automatically redirect the customer to authorize the transaction. Once authorization is complete, the customer will be redirected back to your specified return_url.
When you confirm a PaymentIntent, it needs to have an attached [PaymentMethod](https://stripe.com/docs/api/payment_methods). In addition to confirming the PaymentIntent, this method can automatically create and attach a new PaymentMethod for you. If you have already attached a PaymentMethod you can call this method without needing to provide any additional data.
https://stripe.com/docs/js/payment_intents/confirm_p24_payment

method confirmPayment

confirmPayment: {
    (options: {
        elements: StripeElements;
        confirmParams?: Partial<paymentIntents.ConfirmPaymentData>;
        redirect: 'if_required';
    }): Promise<PaymentIntentResult>;
    (options: {
        elements?: StripeElements;
        clientSecret: string;
        confirmParams?: Partial<paymentIntents.ConfirmPaymentData>;
        redirect: 'if_required';
    }): Promise<PaymentIntentResult>;
    (options: {
        elements: StripeElements;
        confirmParams: paymentIntents.ConfirmPaymentData;
        redirect?: 'always';
    }): Promise<{ error: StripeError }>;
    (options: {
        elements?: StripeElements;
        clientSecret: string;
        confirmParams: paymentIntents.ConfirmPaymentData;
        redirect?: 'always';
    }): Promise<{ error: StripeError }>;
};

Use stripe.confirmPayment to confirm a PaymentIntent using data collected by the [Payment Element](https://stripe.com/docs/js/element/payment_element). When called, stripe.confirmPayment will attempt to complete any [required actions](https://stripe.com/docs/payments/intents), such as authenticating your user by displaying a 3DS dialog or redirecting them to a bank authorization page. Your user will be redirected to the return_url you pass once the confirmation is complete.
By default, stripe.confirmPayment will always redirect to your return_url after a successful confirmation. If you set redirect: "if_required", then stripe.confirmPayment will only redirect if your user chooses a redirect-based payment method. Setting if_required requires that you handle successful confirmations for redirect-based and non-redirect based payment methods separately.
https://stripe.com/docs/js/payment_intents/confirm_payment
Use stripe.confirmPayment to confirm a PaymentIntent using data collected by the [Payment Element](https://stripe.com/docs/js/element/payment_element). When called, stripe.confirmPayment will attempt to complete any [required actions](https://stripe.com/docs/payments/intents), such as authenticating your user by displaying a 3DS dialog or redirecting them to a bank authorization page. Your user will be redirected to the return_url you pass once the confirmation is complete.
https://stripe.com/docs/js/payment_intents/confirm_payment

method confirmPayNowPayment

confirmPayNowPayment: (
    clientSecret: string,
    data?: paymentIntents.ConfirmPayNowPaymentData,
    options?: paymentIntents.ConfirmPayNowPaymentOptions
) => Promise<PaymentIntentResult>;

Requires beta access: Contact [Stripe support](https://support.stripe.com/) for more information.
Use stripe.confirmPayNowPayment in the [PayNow Payments](https://stripe.com/docs/payments/paynow) with Payment Methods flow when the customer submits your payment form. When called, it will confirm the [PaymentIntent](https://stripe.com/docs/api/payment_intents) with data you provide. Refer to our [integration guide](https://stripe.com/docs/payments/paynow) for more details.
When you confirm a PaymentIntent, it needs to have an attached [PaymentMethod](https://stripe.com/docs/api/payment_methods). In addition to confirming the PaymentIntent, this method can automatically create and attach a new PaymentMethod for you. If you have already attached a PaymentMethod you can call this method without needing to provide any additional data.

method confirmPayPalPayment

confirmPayPalPayment: (
    clientSecret: string,
    data?: paymentIntents.ConfirmPayPalPaymentData
) => Promise<PaymentIntentResult>;

Requires beta access: Contact [Stripe support](https://support.stripe.com/) for more information.
Use stripe.confirmPayPalPayment in the [PayPal Payments](https://stripe.com/docs/payments/paypal) with Payment Methods flow when the customer submits your payment form. When called, it will confirm the [PaymentIntent](https://stripe.com/docs/api/payment_intents) with data you provide, and it will automatically redirect the customer to authorize the transaction. Once authorization is complete, the customer will be redirected back to your specified return_url.
When you confirm a PaymentIntent, it needs to have an attached [PaymentMethod](https://stripe.com/docs/api/payment_methods). In addition to confirming the PaymentIntent, this method can automatically create and attach a new PaymentMethod for you. If you have already attached a PaymentMethod you can call this method without needing to provide any additional data.
https://stripe.com/docs/js/payment_intents/confirm_paypal_payment

method confirmPayPalSetup

confirmPayPalSetup: (
    clientSecret: string,
    data?: setupIntents.ConfirmPayPalSetupData
) => Promise<SetupIntentResult>;

Use stripe.confirmPayPalSetup in the [Set up future payments](https://stripe.com/docs/payments/paypal/set-up-future-payments) flow when the customer submits your payment form. When called, it will confirm a SetupIntent with data you provide, and it will automatically redirect the customer to authorize the transaction. Once authorization is complete, the customer will be redirected back to your specified return_url. Note that there are some additional requirements to this flow that are not covered in this reference. Refer to our [integration guide](https://stripe.com/docs/payments/paypal/set-up-future-payments) for more details.
When you confirm a SetupIntent, it needs to have an attached [PaymentMethod](https://stripe.com/docs/api/payment_methods). In addition to confirming the SetupIntent, this method can automatically create and attach a new PaymentMethod for you. It can also be called with an existing PaymentMethod, or if you have already attached a PaymentMethod you can call this method without needing to provide any additional data.
https://stripe.com/docs/js/setup_intents/confirm_paypal_setup

method confirmPixPayment

confirmPixPayment: (
    clientSecret: string,
    data?: paymentIntents.ConfirmPixPaymentData,
    options?: paymentIntents.ConfirmPixPaymentOptions
) => Promise<PaymentIntentResult>;

Use stripe.confirmPixPayment in the [Pix Payments](https://stripe.com/docs/payments/pix) with Payment Methods flow when the customer submits your payment form. When called, it will confirm the [PaymentIntent](https://stripe.com/docs/api/payment_intents) with data you provide. Refer to our [integration guide](https://stripe.com/docs/payments/pix) for more details.
When you confirm a PaymentIntent, it needs to have an attached [PaymentMethod](https://stripe.com/docs/api/payment_methods). In addition to confirming the PaymentIntent, this method can automatically create and attach a new PaymentMethod for you. If you have already attached a PaymentMethod you can call this method without needing to provide any additional data.
https://stripe.com/docs/js/payment_intents/confirm_pix_payment

method confirmPromptPayPayment

confirmPromptPayPayment: (
    clientSecret: string,
    data?: paymentIntents.ConfirmPromptPayPaymentData,
    options?: paymentIntents.ConfirmPromptPayPaymentOptions
) => Promise<PaymentIntentResult>;

Requires beta access: Contact [Stripe support](https://support.stripe.com/) for more information.
Use stripe.confirmPromptPayPayment in the [PromptPay Payments](https://stripe.com/docs/payments/promptpay) with Payment Methods flow when the customer submits your payment form. When called, it will confirm the [PaymentIntent](https://stripe.com/docs/api/payment_intents) with data you provide. Refer to our [integration guide](https://stripe.com/docs/payments/promptpay) for more details.
When you confirm a PaymentIntent, it needs to have an attached [PaymentMethod](https://stripe.com/docs/api/payment_methods). In addition to confirming the PaymentIntent, this method can automatically create and attach a new PaymentMethod for you. If you have already attached a PaymentMethod you can call this method without needing to provide any additional data.

method confirmSepaDebitPayment

confirmSepaDebitPayment: (
    clientSecret: string,
    data?: paymentIntents.ConfirmSepaDebitPaymentData
) => Promise<PaymentIntentResult>;

Use stripe.confirmSepaDebitPayment in the [SEPA Direct Debit Payments](https://stripe.com/docs/payments/sepa-debit) with Payment Methods flow when the customer submits your payment form. When called, it will confirm the [PaymentIntent](https://stripe.com/docs/api/payment_intents) with data you provide. Note that there are some additional requirements to this flow that are not covered in this reference. Refer to our [integration guide](https://stripe.com/docs/payments/sepa-debit) for more details.
When you confirm a PaymentIntent, it needs to have an attached [PaymentMethod](https://stripe.com/docs/api/payment_methods). In addition to confirming the PaymentIntent, this method can automatically create and attach a new PaymentMethod for you. If you have already attached a PaymentMethod you can call this method without needing to provide any additional data.
https://stripe.com/docs/js/payment_intents/confirm_sepa_debit_payment

method confirmSepaDebitSetup

confirmSepaDebitSetup: (
    clientSecret: string,
    data?: setupIntents.ConfirmSepaDebitSetupData
) => Promise<SetupIntentResult>;

Use stripe.confirmSepaDebitSetup in the [SEPA Direct Debit with Setup Intents](https://stripe.com/docs/payments/sepa-debit-setup-intents) flow when the customer submits your payment form. When called, it will confirm the SetupIntent with data you provide. Note that there are some additional requirements to this flow that are not covered in this reference. Refer to our [integration guide](https://stripe.com/docs/payments/sepa-debit-setup-intents) for more details.
When you confirm a SetupIntent, it needs to have an attached [PaymentMethod](https://stripe.com/docs/api/payment_methods). In addition to confirming the SetupIntent, this method can automatically create and attach a new PaymentMethod for you. It can also be called with an existing PaymentMethod, or if you have already attached a PaymentMethod you can call this method without needing to provide any additional data.
https://stripe.com/docs/js/setup_intents/confirm_sepa_debit_setup

method confirmSetup

confirmSetup: {
    (options: {
        elements: StripeElements;
        confirmParams?: Partial<setupIntents.ConfirmSetupData>;
        redirect: 'if_required';
    }): Promise<SetupIntentResult>;
    (options: {
        elements?: StripeElements;
        clientSecret: string;
        confirmParams?: Partial<setupIntents.ConfirmSetupData>;
        redirect: 'if_required';
    }): Promise<SetupIntentResult>;
    (options: {
        elements: StripeElements;
        confirmParams: setupIntents.ConfirmSetupData;
        redirect?: 'always';
    }): Promise<{ error: StripeError }>;
    (options: {
        elements?: StripeElements;
        clientSecret: string;
        confirmParams: setupIntents.ConfirmSetupData;
        redirect?: 'always';
    }): Promise<{ error: StripeError }>;
};

Use stripe.confirmSetup to confirm a SetupIntent using data collected by the [Payment Element](https://stripe.com/docs/js/element/payment_element). When called, stripe.confirmSetup will attempt to complete any [required actions](https://stripe.com/docs/payments/intents), such as authenticating your user by displaying a 3DS dialog or redirecting them to a bank authorization page. Your user will be redirected to the return_url you pass once the confirmation is complete.
By default, stripe.confirmSetup will always redirect to your return_url after a successful confirmation. If you set redirect: "if_required", then stripe.confirmSetup will only redirect if your user chooses a redirect-based payment method. Setting if_required requires that you handle successful confirmations for redirect-based and non-redirect based payment methods separately.
https://stripe.com/docs/js/setup_intents/confirm_setup
Use stripe.confirmSetup to confirm a SetupIntent using data collected by the [Payment Element](https://stripe.com/docs/js/element/payment_element). When called, stripe.confirmSetup will attempt to complete any [required actions](https://stripe.com/docs/payments/intents), such as authenticating your user by displaying a 3DS dialog or redirecting them to a bank authorization page. Your user will be redirected to the return_url you pass once the confirmation is complete.
https://stripe.com/docs/js/setup_intents/confirm_setup

method confirmSofortPayment

confirmSofortPayment: (
    clientSecret: string,
    data?: paymentIntents.ConfirmSofortPaymentData,
    options?: paymentIntents.ConfirmSofortPaymentOptions
) => Promise<PaymentIntentResult>;

Use stripe.confirmSofortPayment in the [Sofort Payments with Payment Methods](https://stripe.com/docs/payments/sofort) flow when the customer submits your payment form. When called, it will confirm the PaymentIntent with data you provide. It will then automatically redirect the customer to authorize the transaction. Once authorization is complete, the customer will be redirected back to your specified return_url.
When you confirm a PaymentIntent, it needs to have an attached [PaymentMethod](https://stripe.com/docs/api/payment_methods). In addition to confirming the PaymentIntent, this method can automatically create and attach a new PaymentMethod for you. If you have already attached a PaymentMethod you can call this method without needing to provide any additional data.
https://stripe.com/docs/js/payment_intents/confirm_sofort_payment

method confirmSofortSetup

confirmSofortSetup: (
    clientSecret: string,
    data?: setupIntents.ConfirmSofortSetupData,
    options?: setupIntents.ConfirmSofortSetupOptions
) => Promise<SetupIntentResult>;

method confirmTwintPayment

confirmTwintPayment: (
    clientSecret: string,
    data?: paymentIntents.ConfirmTwintPaymentData,
    options?: paymentIntents.ConfirmTwintPaymentOptions
) => Promise<PaymentIntentResult>;

Use stripe.confirmTwintPayment in the [TWINT Payments with Payment Methods](https://stripe.com/docs/payments/twint) flow when the customer submits your payment form. When called, it will confirm the PaymentIntent with data you provide, and it will automatically redirect the customer to authorize the transaction. Once authorization is complete, the customer will be redirected back to your specified return_url.
When you confirm a PaymentIntent, it needs to have an attached [PaymentMethod](https://stripe.com/docs/api/payment_methods). In addition to confirming the PaymentIntent, this method can automatically create and attach a new PaymentMethod for you. If you have already attached a PaymentMethod you can call this method without needing to provide any additional data.
https://stripe.com/docs/js/payment_intents/confirm_twint_payment

method confirmUsBankAccountPayment

confirmUsBankAccountPayment: (
    clientSecret: string,
    data?: paymentIntents.ConfirmUsBankAccountPaymentData
) => Promise<PaymentIntentResult>;

Use stripe.confirmUsBankAccountPayment in the [Accept a payment](https://stripe.com/docs/payments/ach-debit/accept-a-payment) flow for the [ACH Direct Debit]((https://stripe.com/docs/payments/ach-debit) payment method to record the customer’s authorization for payment.
When you confirm a [PaymentIntent](https://stripe.com/docs/api/payment_intents), it needs to have an attached PaymentMethod. Use stripe.collectBankAccountForPayment to collect and attach a [PaymentMethod](https://stripe.com/docs/api/payment_methods), or provide bank account details using the data parameter if a PaymentMethod was not already provided.
https://stripe.com/docs/js/payment_intents/confirm_us_bank_account_payment

method confirmUsBankAccountSetup

confirmUsBankAccountSetup: (
    clientSecret: string,
    data?: setupIntents.ConfirmUsBankAccountSetupData
) => Promise<SetupIntentResult>;

Use stripe.confirmUsBankAccountSetup in the [Save bank details](https://stripe.com/docs/payments/ach-debit/set-up-payment) flow for the [ACH Direct Debit payment](https://stripe.com/docs/payments/ach-debit) method to record the customer’s authorization for future payments.
When you confirm a [SetupIntent](https://stripe.com/docs/api/setup_intents), it needs to have an attached PaymentMethod. Use stripe.collectBankAccountForSetup to collect and attach a [PaymentMethod](https://stripe.com/docs/api/payment_methods), or provide bank account details using the data parameter if a PaymentMethod was not already provided.
https://stripe.com/docs/js/setup_intents/confirm_us_bank_account_setup

method confirmWechatPayPayment

confirmWechatPayPayment: (
    clientSecret: string,
    data?: paymentIntents.ConfirmWechatPayPaymentData,
    options?: paymentIntents.ConfirmWechatPayPaymentOptions
) => Promise<PaymentIntentResult>;

Requires beta access: Contact [Stripe support](https://support.stripe.com/) for more information.
Use stripe.confirmWechatPayPayment in the [Wechat Pay Payments](https://stripe.com/docs/payments/wechat-pay) with Payment Methods flow when the customer submits your payment form. When called, it will confirm the [PaymentIntent](https://stripe.com/docs/api/payment_intents) with data you provide. Refer to our [integration guide](https://stripe.com/docs/payments/wechat-pay/accept-a-payment) for more details.
When you confirm a PaymentIntent, it needs to have an attached [PaymentMethod](https://stripe.com/docs/api/payment_methods). In addition to confirming the PaymentIntent, this method can automatically create and attach a new PaymentMethod for you. If you have already attached a PaymentMethod you can call this method without needing to provide any additional data.
https://stripe.com/docs/js/payment_intents/confirm_wechat_pay_payment

method createConfirmationToken

createConfirmationToken: (
    options: confirmationTokens.CreateConfirmationToken
) => Promise<ConfirmationTokenResult>;

Use stripe.createConfirmationToken to convert payment information collected by elements into a [ConfirmationToken](https://stripe.com/docs/api/confirmation_tokens) object that you safely pass to your server to use in an API call.
https://stripe.com/docs/js/confirmation_tokens/create_confirmation_token

method createEphemeralKeyNonce

createEphemeralKeyNonce: (
    options: ephemeralKeys.EphemeralKeyNonceOptions
) => Promise<EphemeralKeyNonceResult>;

Use stripe.createEphemeralKeyNonce to create an ephemeral key nonce that lets you securely create ephemeral keys
* https://stripe.com/docs/js/issuing/create_ephemeral_key_nonce

method createPaymentMethod

createPaymentMethod: {
    (
        paymentMethodData: paymentIntents.CreatePaymentMethodData
    ): Promise<PaymentMethodResult>;
    (options: api.CreatePaymentMethodFromElements): Promise<PaymentMethodResult>;
    (options: api.CreatePaymentMethodFromElement): Promise<PaymentMethodResult>;
};

Use stripe.createPaymentMethod to convert payment information collected by elements into a [PaymentMethod](https://stripe.com/docs/api/payment_methods) object that you safely pass to your server to use in an API call.
https://stripe.com/docs/js/payment_methods/create_payment_method
Use stripe.createPaymentMethod to convert payment information collected by elements into a [PaymentMethod](https://stripe.com/docs/api/payment_methods) object that you safely pass to your server to use in an API call.
https://stripe.com/docs/js/payment_methods/create_payment_method_elements

method createRadarSession

createRadarSession: () => Promise<RadarSessionPayload>;

Use stripe.createRadarSession to create a [Radar Session](https://stripe.com/docs/radar/radar-session) in your checkout flow or when saving card details. A Radar Session is a snapshot of the browser metadata and device details that helps Radar make more accurate predictions on your payments. This metadata includes information like IP address, browser, screen or device information, and other device characteristics. By using Radar Sessions, you can capture critical fraud information without tokenizing on Stripe.

method createSource

createSource: {
    (
        element: StripeElement,
        sourceData: tokens.CreateSourceData
    ): Promise<SourceResult>;
    (sourceData: tokens.CreateSourceData): Promise<SourceResult>;
};

Use stripe.createSource to convert payment information collected by elements into a Source object that you safely pass to your server to use in an API call. See the [Sources documentation](https://stripe.com/docs/sources) for more information about sources.
Use stripe.createSource to convert raw payment information into a Source object that you safely pass to your server to use in an API call. See the [Sources documentation](https://stripe.com/docs/sources) for more information about sources.

method createToken

createToken: {
    (
        tokenType: elements.StripeIbanElement,
        data: tokens.CreateTokenIbanData
    ): Promise<TokenResult>;
    (
        tokenType: elements.StripeCardElement | elements.StripeCardNumberElement,
        data?: tokens.CreateTokenCardData
    ): Promise<TokenResult>;
    (tokenType: 'pii', data: tokens.CreateTokenPiiData): Promise<TokenResult>;
    (
        tokenType: 'bank_account',
        data: tokens.CreateTokenBankAccountData
    ): Promise<TokenResult>;
    (
        tokenType: 'cvc_update',
        element: elements.StripeCardCvcElement
    ): Promise<TokenResult>;
    (
        tokenType: 'account',
        data: api.TokenCreateParams.Account
    ): Promise<TokenResult>;
    (
        tokenType: 'person',
        data: api.TokenCreateParams.Person
    ): Promise<TokenResult>;
};

Use stripe.createToken to convert information collected by an IbanElement into a single-use [Token](https://stripe.com/docs/api#tokens) that you safely pass to your server to use in an API call.
https://stripe.com/docs/js/tokens_sources/create_token?type=ibanElement
Use stripe.createToken to convert information collected by card elements into a single-use [Token](https://stripe.com/docs/api#tokens) that you safely pass to your server to use in an API call.
https://stripe.com/docs/js/tokens_sources/create_token?type=cardElement
Use stripe.createToken to convert personally identifiable information (PII) into a single-use [Token](https://stripe.com/docs/api#tokens) for account identity verification.
https://stripe.com/docs/js/tokens_sources/create_token?type=pii
Use stripe.createToken to convert bank account information into a single-use token that you safely pass to your server to use in an API call.
https://stripe.com/docs/js/tokens_sources/create_token?type=bank_account
Use stripe.createToken to tokenize the recollected CVC for a saved card.
First, render a CardCvcElement to collect the data. Then pass the CardCvcElement to stripe.createToken to tokenize the collected data.
https://stripe.com/docs/js/tokens_sources/create_token?type=cvc_update
Use stripe.createToken to create a single-use token that wraps a user’s legal entity information. Use this when creating or updating a Connect account. See the [account tokens documentation](https://stripe.com/docs/connect/account-tokens) to learn more.
Use stripe.createToken to create a single-use token that represents the details for a person. Use this when creating or updating persons associated with a Connect account. See the [documentation](https://stripe.com/docs/connect/account-tokens) to learn more.

method elements

elements: {
    (options?: StripeElementsOptionsClientSecret): StripeElements;
    (options?: StripeElementsOptionsMode): StripeElements;
};

Create an Elements instance, which manages a group of elements.
https://stripe.com/docs/js/elements_object/create
Create an Elements instance, which manages a group of elements.
https://stripe.com/docs/js/elements_object/create_without_intent

method handleCardAction

handleCardAction: (clientSecret: string) => Promise<PaymentIntentResult>;

Use stripe.handleCardAction in the Payment Intents API [manual confirmation](https://stripe.com/docs/payments/payment-intents/web-manual) flow to handle a [PaymentIntent](https://stripe.com/docs/api/payment_intents) with the requires_action status. It will throw an error if the PaymentIntent has a different status.
Note that stripe.handleCardAction 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.
Additionally, stripe.handleCardAction may trigger a [3D Secure](https://stripe.com/docs/payments/3d-secure) authentication challenge. The authentication challenge requires a context switch that can be hard to follow on a screen-reader. Ensure that your form is accessible by ensuring that success or error messages are clearly read out.
https://stripe.com/docs/js/payment_intents/handle_card_action

method handleNextAction

handleNextAction: (options: {
    clientSecret: string;
}) => Promise<PaymentIntentOrSetupIntentResult>;

Use stripe.handleNextAction in the [finalizing payments on the server](https://stripe.com/docs/payments/finalize-payments-on-the-server) flow to finish confirmation of a [PaymentIntent](https://stripe.com/docs/api/payment_intents) or [SetupIntent](https://stripe.com/docs/api/setup_intents) with the requires_action status. It will throw an error if the PaymentIntent or SetupIntent has a different status.
Note that stripe.handleNextAction 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.
Additionally, stripe.handleNextAction may trigger a [3D Secure](https://stripe.com/docs/payments/3d-secure) authentication challenge. The authentication challenge requires a context switch that can be hard to follow on a screen-reader. Ensure that your form is accessible by ensuring that success or error messages are clearly read out.
https://stripe.com/docs/js/payment_intents/handle_next_action

method initCheckout

initCheckout: (options: StripeCheckoutOptions) => StripeCheckout;

Use stripe.initCheckout to initialize a Checkout instance
* https://docs.stripe.com/payments/accept-a-payment?platform=web&ui=embedded-components

method initEmbeddedCheckout

initEmbeddedCheckout: (
    options: StripeEmbeddedCheckoutOptions
) => Promise<StripeEmbeddedCheckout>;

Use stripe.initEmbeddedCheckout to initialize an embedded Checkout instance
* https://stripe.com/docs/payments/accept-a-payment?platform=web&ui=embedded-checkout

method paymentRequest

paymentRequest: (options: PaymentRequestOptions) => PaymentRequest;

Use stripe.paymentRequest to create a PaymentRequest object. Creating a PaymentRequest requires that you configure it with an options object.
In Safari, stripe.paymentRequest uses Apple Pay, and in other browsers it uses the [Payment Request API standard](https://www.w3.org/TR/payment-request/).

method processOrder

processOrder: {
    (options: {
        elements: StripeElements;
        confirmParams?: Partial<orders.ProcessOrderParams>;
        redirect: 'if_required';
    }): Promise<ProcessOrderResult>;
    (options: {
        elements: StripeElements;
        confirmParams: orders.ProcessOrderParams;
        redirect?: 'always';
    }): Promise<{ error: StripeError }>;
};

Use stripe.processOrder to submit and confirm payment for an [Order](https://stripe.com/docs/api/orders_v2) using data collected by the [Payment Element](https://stripe.com/docs/js/element/payment_element). When called, stripe.processOrder will attempt to complete any required actions, such as authenticating your user by displaying a 3DS dialog or redirecting them to a bank authorization page. Your user will be redirected to the return_url you pass once the confirmation is complete.
By default, stripe.processOrder will always redirect to your return_url after a successful confirmation. If you set redirect: "if_required", then stripe.processOrder will only redirect if your user chooses a redirect-based method. Setting if_required requires that you handle successful confirmations for redirect-based and non-redirect based payment methods separately.
https://stripe.com/docs/js/orders/process_order
Use stripe.processOrder to submit and confirm payment for an [Order](https://stripe.com/docs/api/orders_v2) using data collected by the [Payment Element](https://stripe.com/docs/js/element/payment_element). When called, stripe.processOrder will attempt to complete any required actions, such as authenticating your user by displaying a 3DS dialog or redirecting them to a bank authorization page. Your user will be redirected to the return_url you pass once the confirmation is complete.
https://stripe.com/docs/js/orders/process_order

method registerAppInfo

registerAppInfo: (wrapperLibrary: WrapperLibrary) => void;

Use stripe.registerAppInfo to register a frontend open source library.

method retrieveOrder

retrieveOrder: (clientSecret: string) => Promise<RetrieveOrderResult>;

Retrieve an [Order](https://stripe.com/docs/api/orders_v2) using its [client secret](https://stripe.com/docs/api/orders_v2/object#order_v2_object-client_secret).
https://stripe.com/docs/js/orders/retrieve_order

method retrievePaymentIntent

retrievePaymentIntent: (clientSecret: string) => Promise<PaymentIntentResult>;

Retrieve a [PaymentIntent](https://stripe.com/docs/api/payment_intents) using its [client secret](https://stripe.com/docs/api/payment_intents/object#payment_intent_object-client_secret).
https://stripe.com/docs/js/payment_intents/retrieve_payment_intent

method retrieveSetupIntent

retrieveSetupIntent: (clientSecret: string) => Promise<SetupIntentResult>;

Retrieve a [SetupIntent](https://stripe.com/docs/api/setup_intents) using its client secret.
https://stripe.com/docs/js/setup_intents/retrieve_setup_intent

method retrieveSource

retrieveSource: (source: tokens.RetrieveSourceParam) => Promise<SourceResult>;

Retrieve a [Source](https://stripe.com/docs/api#sources) using its unique ID and client secret.
https://stripe.com/docs/js/tokens_sources/retrieve_source

method verifyIdentity

verifyIdentity: (clientSecret: string) => Promise<VerificationSessionResult>;

Use stripe.verifyIdentity to display an [Identity](https://stripe.com/docs/identity) modal that securely collects verification information.
* https://stripe.com/docs/js/identity/modal

method verifyMicrodepositsForPayment

verifyMicrodepositsForPayment: (
    clientSecret: string,
    data?: paymentIntents.VerifyMicrodepositsForPaymentData
) => Promise<PaymentIntentResult>;

Use stripe.verifyMicrodepositsForPayment in the [Accept a Canadian pre-authorized debit payment](https://stripe.com/docs/payments/acss-debit/accept-a-payment) flow to verify a customer's bank account with micro-deposits.
https://stripe.com/docs/js/payment_intents/verify_microdeposits_for_payment

method verifyMicrodepositsForSetup

verifyMicrodepositsForSetup: (
    clientSecret: string,
    data?: setupIntents.VerifyMicrodepositsForSetupData
) => Promise<SetupIntentResult>;

Use stripe.verifyMicrodepositsForSetup in the [Save details for future payments with pre-authorized debit in Canada](https://stripe.com/docs/payments/acss-debit/set-up-payment) flow to verify customer's bank account with micro-deposits.
https://stripe.com/docs/js/payment_intents/verify_microdeposits_for_setup

interface StripeAddressElementChangeEvent

interface StripeAddressElementChangeEvent {}

property complete

complete: boolean;

Whether or not the AddressElement is complete.

property elementMode

elementMode: AddressMode;

The mode of the AddressElement that emitted this event.

property elementType

elementType: 'address';

The type of element that emitted this event.

property empty

empty: boolean;

Whether or not the AddressElement is currently empty.

property isNewAddress

isNewAddress: boolean;

Whether or not the address is new.

property value

value: {
    name: string;
    firstName?: string;
    lastName?: string;
    address: {
        line1: string;
        line2: string | null;
        city: string;
        state: string;
        postal_code: string;
        country: string;
    };
    phone?: string;
};

An object containing the current address.

interface StripeAddressElementGetElementOptions

interface StripeAddressElementGetElementOptions {}

property mode

mode: AddressMode;

interface StripeAddressElementOptions

interface StripeAddressElementOptions {}

property allowedCountries

allowedCountries?: string[] | null;

An array of two-letter ISO country codes representing which countries are displayed in the AddressElement.

property autocomplete

autocomplete?:
    | { mode: 'automatic' }
    | { mode: 'disabled' }
    | { mode: 'google_maps_api'; apiKey: string };

Control autocomplete settings in the AddressElement.

property blockPoBox

blockPoBox?: boolean;

Whether or not AddressElement accepts PO boxes

property contacts

contacts?: ContactOption[];

An array of saved addresses.

property defaultValues

defaultValues?: {
    name?: string | null;
    firstName?: string | null;
    lastName?: string | null;
    address?: {
        line1?: string | null;
        line2?: string | null;
        city?: string | null;
        state?: string | null;
        postal_code?: string | null;
        country: string;
    };
    phone?: string | null;
};

Default value for AddressElement fields

property display

display?: {
    name?: 'full' | 'split' | 'organization';
};

Specify display options in the AddressElement

property fields

fields?: {
    phone?: 'always' | 'never' | 'auto';
};

Control which additional fields to display in the AddressElement.

property mode

mode: AddressMode;

Control which mode the AddressElement will be used for.

property validation

validation?: {
    phone?: {
        required: 'always' | 'never' | 'auto';
    };
};

Specify validation rules for the above additional fields.

interface StripeAuBankAccountElementChangeEvent

interface StripeAuBankAccountElementChangeEvent extends StripeElementChangeEvent {}

property bankName

bankName?: string;

The bank name corresponding to the entered BSB.

property branchName

branchName?: string;

The branch name corresponding to the entered BSB.

property elementType

elementType: 'auBankAccount';

The type of element that emitted this event.

interface StripeAuBankAccountElementOptions

interface StripeAuBankAccountElementOptions {}

property classes

classes?: StripeElementClasses;

property disabled

disabled?: boolean;

Applies a disabled state to the Element such that user input is not accepted. Default is false.

property hideIcon

hideIcon?: boolean;

Hides the icon in the Element. Default is false.

property iconStyle

iconStyle?: 'default' | 'solid';

Appearance of the icon in the Element.

property style

style?: StripeElementStyle;

interface StripeCardCvcElementChangeEvent

interface StripeCardCvcElementChangeEvent extends StripeElementChangeEvent {}

property elementType

elementType: 'cardCvc';

The type of element that emitted this event.

interface StripeCardCvcElementOptions

interface StripeCardCvcElementOptions {}

property classes

classes?: StripeElementClasses;

property disabled

disabled?: boolean;

Applies a disabled state to the Element such that user input is not accepted. Default is false.

property placeholder

placeholder?: string;

property style

style?: StripeElementStyle;

interface StripeCardElementChangeEvent

interface StripeCardElementChangeEvent extends StripeElementChangeEvent {}

property brand

brand:
    | 'visa'
    | 'mastercard'
    | 'amex'
    | 'discover'
    | 'diners'
    | 'jcb'
    | 'unionpay'
    | 'unknown';

property elementType

elementType: 'card';

The type of element that emitted this event.

property value

value: { postalCode: string };

An object containing the currently entered postalCode.

interface StripeCardElementOptions

interface StripeCardElementOptions {}

property classes

classes?: StripeElementClasses;

property disabled

disabled?: boolean;

Applies a disabled state to the Element such that user input is not accepted. Default is false.

property disableLink

disableLink?: boolean;

Hides and disables the Link Button in the Card Element. Default is false.

property hideIcon

hideIcon?: boolean;

Hides the icon in the Element. Default is false.

property hidePostalCode

hidePostalCode?: boolean;

Hide the postal code field. Default is false. If you are already collecting a full billing address or postal code elsewhere, set this to true.

property iconStyle

iconStyle?: 'default' | 'solid';

Appearance of the icon in the Element.

property preferredNetwork

preferredNetwork?: Array<CardNetworkBrand>;

Specifies a network preference for Card Brand Choice. The first network in the array which is a valid network on the entered card will be selected as the default in the Card Brand Choice dropdown upon entry of a co-branded card.
Default is an empty array, meaning no default selection will be made in the Card Brand choice dropdown.

property style

style?: StripeElementStyle;

property value

value?: { postalCode?: string };

A pre-filled set of values to include in the input (e.g., {postalCode: '94110'}). Note that sensitive card information (card number, CVC, and expiration date) cannot be pre-filled.

interface StripeCardElementUpdateOptions

interface StripeCardElementUpdateOptions {}

property classes

classes?: StripeElementClasses;

property disabled

disabled?: boolean;

Applies a disabled state to the Element such that user input is not accepted. Default is false.

property hideIcon

hideIcon?: boolean;

Hides the icon in the Element. Default is false.

property hidePostalCode

hidePostalCode?: boolean;

Hide the postal code field. Default is false. If you are already collecting a full billing address or postal code elsewhere, set this to true.

property iconStyle

iconStyle?: 'default' | 'solid';

Appearance of the icon in the Element.

property style

style?: StripeElementStyle;

property value

value?: { postalCode?: string };

A pre-filled set of values to include in the input (e.g., {postalCode: '94110'}). Note that sensitive card information (card number, CVC, and expiration date) cannot be pre-filled.

interface StripeCardExpiryElementChangeEvent

interface StripeCardExpiryElementChangeEvent extends StripeElementChangeEvent {}

property elementType

elementType: 'cardExpiry';

The type of element that emitted this event.

interface StripeCardExpiryElementOptions

interface StripeCardExpiryElementOptions {}

property classes

classes?: StripeElementClasses;

property disabled

disabled?: boolean;

Applies a disabled state to the Element such that user input is not accepted. Default is false.

property placeholder

placeholder?: string;

property style

style?: StripeElementStyle;

interface StripeCardNumberElementChangeEvent

interface StripeCardNumberElementChangeEvent extends StripeElementChangeEvent {}

property brand

brand:
    | 'visa'
    | 'mastercard'
    | 'amex'
    | 'discover'
    | 'diners'
    | 'jcb'
    | 'unionpay'
    | 'unknown';

property elementType

elementType: 'cardNumber';

The type of element that emitted this event.

interface StripeCardNumberElementOptions

interface StripeCardNumberElementOptions {}

property classes

classes?: StripeElementClasses;

property disabled

disabled?: boolean;

Applies a disabled state to the Element such that user input is not accepted. Default is false.

property disableLink

disableLink?: boolean;

Hides and disables the Link Button in the Card Element. Default is false.

property iconStyle

iconStyle?: 'default' | 'solid';

Appearance of the brand icon in the Element.

property placeholder

placeholder?: string;

property preferredNetwork

preferredNetwork?: Array<CardNetworkBrand>;

Specifies a network preference for Card Brand Choice. The first network in the array which is a valid network on the entered card will be selected as the default in the Card Brand Choice dropdown upon entry of a co-branded card.
Default is an empty array, meaning no default selection will be made in the Card Brand choice dropdown.

property showIcon

showIcon?: boolean;

Show a card brand icon in the Element. Default is false.

property style

style?: StripeElementStyle;

interface StripeCardNumberElementUpdateOptions

interface StripeCardNumberElementUpdateOptions {}

property classes

classes?: StripeElementClasses;

property disabled

disabled?: boolean;

Applies a disabled state to the Element such that user input is not accepted. Default is false.

property iconStyle

iconStyle?: 'default' | 'solid';

Appearance of the brand icon in the Element.

property placeholder

placeholder?: string;

property showIcon

showIcon?: boolean;

Show a card brand icon in the Element. Default is false.

property style

style?: StripeElementStyle;

interface StripeCheckout

interface StripeCheckout {}

property changeAppearance

changeAppearance: (appearance: Appearance) => void;

property loadActions

loadActions: () => Promise<StripeCheckoutLoadActionsResult>;

property loadFonts

loadFonts: (fonts: Array<CssFontSource | CustomFontSource>) => void;

property on

on: (event: 'change', handler: StripeCheckoutUpdateHandler) => void;

method createBillingAddressElement

createBillingAddressElement: (
    options?: StripeCheckoutAddressElementOptions
) => StripeAddressElement;

method createCurrencySelectorElement

createCurrencySelectorElement: () => StripeCurrencySelectorElement;

method createExpressCheckoutElement

createExpressCheckoutElement: (
    options?: StripeCheckoutExpressCheckoutElementOptions
) => StripeCheckoutExpressCheckoutElement;

method createPaymentElement

createPaymentElement: (
    options?: StripeCheckoutPaymentElementOptions
) => StripePaymentElement;

method createShippingAddressElement

createShippingAddressElement: (
    options?: StripeCheckoutAddressElementOptions
) => StripeAddressElement;

method createTaxIdElement

createTaxIdElement: (options?: StripeTaxIdElementOptions) => StripeTaxIdElement;

method getBillingAddressElement

getBillingAddressElement: () => StripeAddressElement | null;

method getCurrencySelectorElement

getCurrencySelectorElement: () => StripeCurrencySelectorElement | null;

method getExpressCheckoutElement

getExpressCheckoutElement: () => StripeCheckoutExpressCheckoutElement | null;

method getPaymentElement

getPaymentElement: () => StripePaymentElement | null;

method getShippingAddressElement

getShippingAddressElement: () => StripeAddressElement | null;

method getTaxIdElement

getTaxIdElement: () => StripeTaxIdElement | null;

interface StripeCheckoutElementsOptions

interface StripeCheckoutElementsOptions {}

property appearance

appearance?: Appearance;

property fonts

fonts?: Array<CssFontSource | CustomFontSource>;

property loader

loader?: 'auto' | 'always' | 'never';

property savedPaymentMethod

savedPaymentMethod?: SavedPaymentMethodOption;

interface StripeCheckoutOptions

interface StripeCheckoutOptions {}

property clientSecret

clientSecret: Promise<string> | string;

property elementsOptions

elementsOptions?: StripeCheckoutElementsOptions;

interface StripeCheckoutSession

interface StripeCheckoutSession {}

property billingAddress

billingAddress: StripeCheckoutContact | null;

property businessName

businessName: string | null;

property canConfirm

canConfirm: boolean;

property currency

currency: string;

property currencyOptions

currencyOptions: Array<StripeCheckoutCurrencyOption> | null;

property discountAmounts

discountAmounts: Array<StripeCheckoutDiscountAmount> | null;

property email

email: string | null;

property id

id: string;

property lastPaymentError

lastPaymentError: StripeCheckoutLastPaymentError | null;

property lineItems

lineItems: Array<StripeCheckoutLineItem>;

property livemode

livemode: boolean;

property minorUnitsAmountDivisor

minorUnitsAmountDivisor: number;

property phoneNumber

phoneNumber: string | null;

property recurring

recurring: StripeCheckoutRecurring | null;

property savedPaymentMethods

savedPaymentMethods: Array<StripeCheckoutSavedPaymentMethod> | null;

property shipping

shipping: StripeCheckoutShipping | null;

property shippingAddress

shippingAddress: StripeCheckoutContact | null;

property shippingOptions

shippingOptions: Array<StripeCheckoutShippingOption>;

property status

status: StripeCheckoutStatus;

property tax

tax: StripeCheckoutTaxStatus;

property taxAmounts

taxAmounts: Array<StripeCheckoutTaxAmount> | null;

property taxIdInfo

taxIdInfo: StripeCheckoutTaxIdInfo | null;

property total

total: StripeCheckoutTotalSummary;

interface StripeConstructor

interface StripeConstructor {}

Use Stripe(publishableKey, options?) to create an instance of the Stripe object. The Stripe object is your entrypoint to the rest of the Stripe.js SDK.
Your Stripe publishable [API key](https://stripe.com/docs/keys) is required when calling this function, as it identifies your website to Stripe.
When you’re ready to accept live payments, replace the test key with your live key in production. Learn more about how API keys work in [test mode and live mode](https://stripe.com/docs/dashboard#viewing-test-data).

call signature

(
    /**
     * Your publishable key.
     */
    publishableKey: string,

    /**
     * Initialization options.
     */
    options?: StripeConstructorOptions
): Stripe;

interface StripeConstructorOptions

interface StripeConstructorOptions {}

property apiVersion

apiVersion?: string;

Override your account's [API version](https://stripe.com/docs/api/versioning).

property betas

betas?: string[];

Opt-in to prerelease Stripe.js features by passing betas when instantiating a Stripe object.
Supported values for the betas option can be found in integration guides for prerelease features. Most users of Stripe.js do not pass this option.

property developerTools

developerTools?: {
    assistant?: {
        enabled?: boolean;
    };
};

Stripe.js developer tooling [options](https://docs.corp.stripe.com/js/initializing#init_stripe_js-options-developerTools).

property locale

locale?: StripeElementLocale | CheckoutLocale;

The [IETF language tag](https://en.wikipedia.org/wiki/IETF_language_tag) used to globally configure localization in Stripe.js. Setting the locale here will localize error strings for all Stripe.js methods. It will also configure the locale for [Elements](#element_mount) and [Checkout](https://stripe.com/docs/js/checkout/redirect_to_checkout). Default is auto (Stripe detects the locale of the browser).
Supported values depend on which features you are using. Checkout supports a slightly different set of locales than the rest of Stripe.js. If you are planning on using Checkout, make sure to use a [value](#checkout_redirect_to_checkout-options-locale) that it supports.

property stripeAccount

stripeAccount?: string;

For usage with [Connect](https://stripe.com/docs/connect) only. Specifying a connected account ID (e.g., acct_24BFMpJ1svR5A89k) allows you to perform actions on behalf of that account.

interface StripeElementChangeEvent

interface StripeElementChangeEvent {}

property complete

complete: boolean;

true if the value is well-formed and potentially complete. The complete value can be used to progressively disclose the next parts of your form or to enable form submission.
It is not an indicator of whether a customer is done with their input—it only indicates that the Element contains a potentially complete, well-formed value. In many cases the customer could still add further input.
The complete value should not be used to perform an action such as advancing the cursor to a subsequent field or performing a tokenization request.

property elementType

elementType: StripeElementType;

The type of element that emitted this event.

property empty

empty: boolean;

true if the value is empty.

property error

error:
    | undefined
    | {
          type: 'validation_error';
          code: string;
          message: string;
      };

The current validation error, if any.

interface StripeElementClasses

interface StripeElementClasses {}

Use Classes to set custom class names on the container DOM element when the Stripe element is in a particular state.

property base

base?: string;

The base class applied to the container. Defaults to StripeElement.

property complete

complete?: string;

The class name to apply when the Element is complete. Defaults to StripeElement--complete.

property empty

empty?: string;

The class name to apply when the Element is empty. Defaults to StripeElement--empty.

property focus

focus?: string;

The class name to apply when the Element is focused. Defaults to StripeElement--focus.

property invalid

invalid?: string;

The class name to apply when the Element is invalid. Defaults to StripeElement--invalid.

property webkitAutofill

webkitAutofill?: string;

The class name to apply when the Element has its value autofilled by the browser (only on Chrome and Safari). Defaults to StripeElement--webkit-autofill.

interface StripeElementCSSProperties

interface StripeElementCSSProperties {}

CSS properties supported by Stripe.js.

property backgroundColor

backgroundColor?: string;

The [background-color](https://developer.mozilla.org/en-US/docs/Web/CSS/background-color) CSS property.
This property works best with the ::selection pseudo-class. In other cases, consider setting the background color on the element's container instaed.

property color

color?: string;

The [color](https://developer.mozilla.org/en-US/docs/Web/CSS/color) CSS property.

property fontFamily

fontFamily?: string;

The [font-family](https://developer.mozilla.org/en-US/docs/Web/CSS/font-family) CSS property.

property fontSize

fontSize?: string;

The [font-size](https://developer.mozilla.org/en-US/docs/Web/CSS/font-size) CSS property.

property fontSmoothing

fontSmoothing?: string;

The [font-smoothing](https://developer.mozilla.org/en-US/docs/Web/CSS/font-smoothing) CSS property.

property fontStyle

fontStyle?: string;

The [font-style](https://developer.mozilla.org/en-US/docs/Web/CSS/font-style) CSS property.

property fontVariant

fontVariant?: string;

The [font-variant](https://developer.mozilla.org/en-US/docs/Web/CSS/font-variant) CSS property.

property fontWeight

fontWeight?: string | number;

The [font-weight](https://developer.mozilla.org/en-US/docs/Web/CSS/font-weight) CSS property.

property iconColor

iconColor?: string;

A custom property, used to set the color of the icons that are rendered in an element.

property letterSpacing

letterSpacing?: string;

The [letter-spacing](https://developer.mozilla.org/en-US/docs/Web/CSS/letter-spacing) CSS property.

property lineHeight

lineHeight?: string;

The [line-height](https://developer.mozilla.org/en-US/docs/Web/CSS/line-height) CSS property.
To avoid cursors being rendered inconsistently across browsers, consider using a padding on the element's container instead.

property padding

padding?: string;

The [padding](https://developer.mozilla.org/en-US/docs/Web/CSS/padding) CSS property.
Available for the idealBank element. Accepts integer length with px unit as values.

property textAlign

textAlign?: string;

The [text-align](https://developer.mozilla.org/en-US/docs/Web/CSS/text-align) CSS property.
Available for the cardNumber, cardExpiry, and cardCvc elements.

property textDecoration

textDecoration?: string;

The [text-decoration](https://developer.mozilla.org/en-US/docs/Web/CSS/text-decoration) CSS property.

property textShadow

textShadow?: string;

The [text-shadow](https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow) CSS property.

property textTransform

textTransform?: string;

The [text-transform](https://developer.mozilla.org/en-US/docs/Web/CSS/text-transform) CSS property.

interface StripeElements

interface StripeElements {}

method create

create: {
    (
        elementType: 'address',
        options: StripeAddressElementOptions
    ): StripeAddressElement;
    (
        elementType: 'paymentMethodMessaging',
        options: StripePaymentMethodMessagingElementOptions
    ): StripePaymentMethodMessagingElement;
    (
        elementType: 'auBankAccount',
        options?: StripeAuBankAccountElementOptions
    ): StripeAuBankAccountElement;
    (elementType: 'card', options?: StripeCardElementOptions): StripeCardElement;
    (
        elementType: 'cardNumber',
        options?: StripeCardNumberElementOptions
    ): StripeCardNumberElement;
    (
        elementType: 'cardExpiry',
        options?: StripeCardExpiryElementOptions
    ): StripeCardExpiryElement;
    (
        elementType: 'cardCvc',
        options?: StripeCardCvcElementOptions
    ): StripeCardCvcElement;
    (elementType: 'iban', options?: StripeIbanElementOptions): StripeIbanElement;
    (
        elementType: 'linkAuthentication',
        options?: StripeLinkAuthenticationElementOptions
    ): StripeLinkAuthenticationElement;
    (
        elementType: 'expressCheckout',
        options?: StripeExpressCheckoutElementOptions
    ): StripeExpressCheckoutElement;
    (
        elementType: 'payment',
        options?: StripePaymentElementOptions
    ): StripePaymentElement;
    (
        elementType: 'paymentRequestButton',
        options: StripePaymentRequestButtonElementOptions
    ): StripePaymentRequestButtonElement;
    (
        elementType: 'shippingAddress',
        options?: StripeShippingAddressElementOptions
    ): StripeShippingAddressElement;
    (
        elementType: 'issuingCardNumberDisplay',
        options: StripeIssuingCardNumberDisplayElementOptions
    ): StripeIssuingCardNumberDisplayElement;
    (
        elementType: 'issuingCardCvcDisplay',
        options: StripeIssuingCardCvcDisplayElementOptions
    ): StripeIssuingCardCvcDisplayElement;
    (
        elementType: 'issuingCardExpiryDisplay',
        options: StripeIssuingCardExpiryDisplayElementOptions
    ): StripeIssuingCardExpiryDisplayElement;
    (
        elementType: 'issuingCardPinDisplay',
        options: StripeIssuingCardPinDisplayElementOptions
    ): StripeIssuingCardPinDisplayElement;
    (
        elementType: 'issuingCardCopyButton',
        options: StripeIssuingCardCopyButtonElementOptions
    ): StripeIssuingCardCopyButtonElement;
};

Creates an AddressElement.
Creates an paymentMethodMessagingElement.
Requires beta access: Contact [Stripe support](https://support.stripe.com/) for more information.
Creates an AuBankAccountElement.
Creates a CardElement.
Creates a CardNumberElement.
Creates a CardExpiryElement.
Creates a CardCvcElement.
Creates an IbanElement.
Creates a LinkAuthenticationElement.
Creates an ExpressCheckoutElement.
Creates a PaymentElement.
https://stripe.com/docs/payments/payment-element
Creates a PaymentRequestButtonElement.
https://stripe.com/docs/stripe-js/elements/payment-request-button
Deprecated
Use Address element instead.
Creates a ShippingAddressElement.
Creates an issuingCardNumberDisplay Element
https://stripe.com/docs/js/issuing_elements/create?type=issuingCardNumberDisplay
Creates an issuingCardCvcDisplay Element
https://stripe.com/docs/js/issuing_elements/create?type=issuingCardCvcDisplay
Creates an issuingCardExpiryDisplay Element
https://stripe.com/docs/js/issuing_elements/create?type=issuingCardExpiryDisplay
Creates an issuingCardPinDisplay Element
https://stripe.com/docs/js/issuing_elements/create?type=issuingCardPinDisplay
Creates an issuingCardCopyButton Element
https://stripe.com/docs/js/issuing_elements/create?type=issuingCardCopyButton

method fetchUpdates

fetchUpdates: () => Promise<{ error?: { message: string; status?: string } }>;

Fetches updates from the associated PaymentIntent or SetupIntent on an existing instance of Elements, and reflects these updates in the Payment Element.

method getElement

getElement: {
    (
        elementType: 'address',
        options?: StripeAddressElementGetElementOptions
    ): StripeAddressElement | null;
    (elementType: 'paymentMethodMessaging'): StripePaymentMethodMessagingElement;
    (elementType: 'auBankAccount'): StripeAuBankAccountElement;
    (elementType: 'card'): StripeCardElement;
    (elementType: 'cardNumber'): StripeCardNumberElement;
    (elementType: 'cardExpiry'): StripeCardExpiryElement;
    (elementType: 'cardCvc'): StripeCardCvcElement;
    (elementType: 'iban'): StripeIbanElement;
    (elementType: 'linkAuthentication'): StripeLinkAuthenticationElement;
    (elementType: 'expressCheckout'): StripeExpressCheckoutElement;
    (elementType: 'payment'): StripePaymentElement;
    (elementType: 'paymentRequestButton'): StripePaymentRequestButtonElement;
    (elementType: 'shippingAddress'): StripeShippingAddressElement;
};

Looks up a previously created Element by its type.
Requires beta access: Contact [Stripe support](https://support.stripe.com/) for more information.
Looks up a previously created Element by its type.
Deprecated
Use Address element instead.
Looks up a previously created Element by its type.

method on

on: (eventType: 'update-end', handler: () => void) => void;

Triggered when the call to elements.update() is complete.

method submit

submit: () => Promise<
    | { error?: StripeError; selectedPaymentMethod?: undefined }
    | { selectedPaymentMethod: string; error?: undefined }
>;

Before confirming payment, call elements.submit() to validate the state of the Payment Element and collect any data required for wallets.

method update

update: (options: StripeElementsUpdateOptions) => void;

Updates the options that Elements was initialized with. Updates are shallowly merged into the existing configuration.

interface StripeElementsOptionsClientSecret

interface StripeElementsOptionsClientSecret extends BaseStripeElementsOptions {}

property clientSecret

clientSecret?: string;

The client secret for a PaymentIntent or SetupIntent used by the Payment Element.
https://stripe.com/docs/api/payment_intents/object#payment_intent_object-client_secret

property currency

currency?: string;

Influences available payment methods when creating SetupIntents with automatic_payment_methods. Payment Element renders the payment methods enabled in the Stripe Dashboard that support the provided currency.
Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).

property mode

mode?: never;

Either use mode or clientSecret when creating an Elements group

interface StripeElementsOptionsModeBase

interface StripeElementsOptionsModeBase extends BaseStripeElementsOptions {}

property allowedPaymentMethodTypes

allowedPaymentMethodTypes?: string[];

The list of payment method types to allow for use with this payment. From this list, Stripe will automatically render the relevant payment methods for this payment.
https://stripe.com/docs/payments/payment-methods/overview

property capture_method

capture_method?: 'manual' | 'automatic' | 'automatic_async';

Controls when the funds will be captured from the customer’s account.
https://stripe.com/docs/api/payment_intents/create#create_payment_intent-capture_method

property captureMethod

captureMethod?: 'manual' | 'automatic' | 'automatic_async';

Controls when the funds will be captured from the customer’s account.
https://stripe.com/docs/api/payment_intents/create#create_payment_intent-capture_method

property clientSecret

clientSecret?: never;

Either use mode or clientSecret when creating an Elements group

property excludedPaymentMethodTypes

excludedPaymentMethodTypes?: string[];

The list of payment method types to exclude from use with this payment.
https://stripe.com/docs/payments/payment-methods/overview

property externalPaymentMethodTypes

externalPaymentMethodTypes?: string[];

The external payment methods to be displayed in the Payment Element that you are already integrated with.
https://stripe.com/docs/js/elements_object/create#stripe_elements-options-externalPaymentMethodTypes

property on_behalf_of

on_behalf_of?: string;

The Stripe account ID which is the business of record.
https://stripe.com/docs/js/elements_object/create_without_intent#stripe_elements_no_intent-options-onBehalfOf

property onBehalfOf

onBehalfOf?: string;

The Stripe account ID which is the business of record.
https://stripe.com/docs/js/elements_object/create_without_intent#stripe_elements_no_intent-options-onBehalfOf

property payment_method_configuration

payment_method_configuration?: string;

When using automatic payment methods (omitting payment_method_types), provide a payment method configuration ID for deriving payment methods.
https://stripe.com/docs/connect/payment-method-configurations

property payment_method_options

payment_method_options?: PaymentMethodOptions;

Additional payment-method-specific options for configuring Payment Element behavior.
https://stripe.com/docs/js/elements_object/create_without_intent#stripe_elements_no_intent-options-paymentMethodOptions

property payment_method_types

payment_method_types?: string[];

Instead of using automatic payment methods, declare specific payment methods to enable.
https://stripe.com/docs/payments/payment-methods/overview

property paymentMethodConfiguration

paymentMethodConfiguration?: string;

When using automatic payment methods (omitting paymentMethodTypes), provide a payment method configuration ID for deriving payment methods.
https://stripe.com/docs/connect/payment-method-configurations

property paymentMethodCreation

paymentMethodCreation?: 'manual';

Allows PaymentMethods to be created from the Elements instance.

property paymentMethodOptions

paymentMethodOptions?: PaymentMethodOptions;

Additional payment-method-specific options for configuring Payment Element behavior.
https://stripe.com/docs/js/elements_object/create_without_intent#stripe_elements_no_intent-options-paymentMethodOptions

property paymentMethodTypes

paymentMethodTypes?: string[];

Instead of using automatic payment methods, declare specific payment methods to enable.
https://stripe.com/docs/payments/payment-methods/overview

property setup_future_usage

setup_future_usage?: 'off_session' | 'on_session' | null;

Indicates that you intend to make future payments with this PaymentIntent’s payment method.
https://stripe.com/docs/api/payment_intents/create#create_payment_intent-setup_future_usage

property setupFutureUsage

setupFutureUsage?: 'off_session' | 'on_session' | null;

Indicates that you intend to make future payments with this PaymentIntent’s payment method.
https://stripe.com/docs/api/payment_intents/create#create_payment_intent-setup_future_usage

interface StripeElementStyle

interface StripeElementStyle {}

Customize the appearance of an element using CSS properties passed in a Style object, which consists of CSS properties nested under objects for each variant.

property base

base?: StripeElementStyleVariant;

Base variant—all other variants inherit from these styles.

property complete

complete?: StripeElementStyleVariant;

Applied when the element has valid input.

property empty

empty?: StripeElementStyleVariant;

Applied when the element has no customer input.

property invalid

invalid?: StripeElementStyleVariant;

Applied when the element has invalid input.

interface StripeElementStyleVariant

interface StripeElementStyleVariant extends StripeElementCSSProperties {}

An object with CSSProperties supported by Stripe.js. Pseudo-classes and pseudo-elements can also be styled using a nested object inside of a variant.

property ':-webkit-autofill'

':-webkit-autofill'?: StripeElementCSSProperties;

property '::-ms-clear'

'::-ms-clear'?: StripeElementCSSProperties & { display: string };

Available for the cardNumber, cardExpiry, and cardCvc elements.

property '::placeholder'

'::placeholder'?: StripeElementCSSProperties;

property '::selection'

'::selection'?: StripeElementCSSProperties;

property ':disabled'

':disabled'?: StripeElementCSSProperties;

Available for all elements except the paymentRequestButton element

property ':focus'

':focus'?: StripeElementCSSProperties;

property ':hover'

':hover'?: StripeElementCSSProperties;

interface StripeElementsUpdateOptions

interface StripeElementsUpdateOptions {}

property allowedPaymentMethodTypes

allowedPaymentMethodTypes?: string[];

The list of payment method types to allow for use with this payment. From this list, Stripe will automatically render the relevant payment methods for this payment.
https://stripe.com/docs/payments/payment-methods/overview

property amount

amount?: number;

The amount to be charged. Shown in Apple Pay, Google Pay, or Buy now pay later UIs, and influences available payment methods.

property appearance

appearance?: Appearance;

Match the design of your site with the appearance option. The layout of each Element stays consistent, but you can modify colors, fonts, borders, padding, and more.
https://stripe.com/docs/stripe-js/appearance-api

property capture_method

capture_method?: 'manual' | 'automatic' | 'automatic_async';

Controls when the funds will be captured from the customer’s account.
https://stripe.com/docs/api/payment_intents/create#create_payment_intent-capture_method

property captureMethod

captureMethod?: 'manual' | 'automatic' | 'automatic_async';

Controls when the funds will be captured from the customer’s account.
https://stripe.com/docs/api/payment_intents/create#create_payment_intent-capture_method

property currency

currency?: string;

Three character currency code (e.g., usd).

property customerSessionClientSecret

customerSessionClientSecret?: string;

Display saved PaymentMethods and Customer information.

property customPaymentMethods

customPaymentMethods?: CustomPaymentMethod[];

Display Custom Payment Methods in the Payment Element that you are already registered with.
https://docs.stripe.com/js/elements_object/update#elements_update-options-customPaymentMethods

property excludedPaymentMethodTypes

excludedPaymentMethodTypes?: string[];

The list of payment method types to exclude from use with this payment.
https://stripe.com/docs/payments/payment-methods/overview

property fonts

fonts?: Array<CssFontSource | CustomFontSource>;

An array of custom fonts to update, which elements created from the Elements object can use.

property locale

locale?: StripeElementLocale;

The [IETF language tag](https://en.wikipedia.org/wiki/IETF_language_tag) of the locale to display placeholders and error strings in. Default is auto (Stripe detects the locale of the browser). Setting the locale does not affect the behavior of postal code validation—a valid postal code for the billing country of the card is still required.

property mode

mode?: 'payment' | 'setup' | 'subscription';

Whether the Payment Element will be used to create a PaymentIntent, SetupIntent, or Subscription.

property on_behalf_of

on_behalf_of?: string;

The Stripe account ID which is the business of record.
https://stripe.com/docs/js/elements_object/create_without_intent#stripe_elements_no_intent-options-onBehalfOf

property onBehalfOf

onBehalfOf?: string;

The Stripe account ID which is the business of record.
https://stripe.com/docs/js/elements_object/create_without_intent#stripe_elements_no_intent-options-onBehalfOf

property payment_method_types

payment_method_types?: string[];

Instead of using automatic payment methods, declare specific payment methods to enable.
https://stripe.com/docs/payments/payment-methods/overview

property paymentMethodTypes

paymentMethodTypes?: string[];

Instead of using automatic payment methods, declare specific payment methods to enable.
https://stripe.com/docs/payments/payment-methods/overview

property setup_future_usage

setup_future_usage?: 'off_session' | 'on_session' | null;

Indicates that you intend to make future payments with this PaymentIntent’s payment method.
https://stripe.com/docs/api/payment_intents/update#update_payment_intent-setup_future_usage

property setupFutureUsage

setupFutureUsage?: 'off_session' | 'on_session' | null;

Indicates that you intend to make future payments with this PaymentIntent’s payment method.
https://stripe.com/docs/api/payment_intents/update#update_payment_intent-setup_future_usage

interface StripeEmbeddedCheckout

interface StripeEmbeddedCheckout {}

method destroy

destroy: () => void;

Removes Embedded Checkout from the DOM and destroys it. Once destroyed it not be re-mounted to the DOM. Use this if you want to create a new Embedded Checkout instance.

method mount

mount: (location: string | HTMLElement) => void;

The embeddedCheckout.mount method attaches your Embedded Checkout to the DOM. mount accepts either a CSS Selector (e.g., '#checkout') or a DOM element.

method unmount

unmount: () => void;

Unmounts Embedded Checkout from the DOM. Call embeddedCheckout.mount to re-attach it to the DOM.

interface StripeEmbeddedCheckoutOptions

interface StripeEmbeddedCheckoutOptions {}

property clientSecret

clientSecret?: string;

The client secret of the [Checkout Session](https://stripe.com/docs/api/checkout/sessions).

property fetchClientSecret

fetchClientSecret?: () => Promise<string>;

A function that returns a Promise which resolves with the client secret of the [Checkout Session](https://stripe.com/docs/api/checkout/sessions).

property onComplete

onComplete?: () => void;

onComplete is called when the Checkout Session completes successfully. You can use it to unmount Embedded Checkout and render a custom success UI.

property onLineItemsChange

onLineItemsChange?: (
    event: StripeEmbeddedCheckoutLineItemsChangeEvent
) => Promise<ResultAction>;

onLineItemsChange is called when the customer adds, removes, or modifies a line item. The callback is required when [permissions.update.line_items](https://docs.stripe.com/api/checkout/sessions/create#create_checkout_session-permissions-update-line_items) is set to server_only.

property onShippingDetailsChange

onShippingDetailsChange?: (
    event: StripeEmbeddedCheckoutShippingDetailsChangeEvent
) => Promise<ResultAction>;

onShippingDetailsChange is called when the customer completes the shipping details form.
The callback is required when [permissions.update.shipping_details](https://docs.stripe.com/api/checkout/sessions/create#create_checkout_session-permissions-update-shipping_details) is set to server_only. For a step-by-step guide on using this callback to customize shipping options during checkout, see [Customize Shipping Options](https://docs.stripe.com/payments/checkout/custom-shipping-options).

interface StripeError

interface StripeError {}

property charge

charge?: string;

For card errors, the ID of the failed charge

property code

code?: string;

For some errors that could be handled programmatically, a short string indicating the [error code](https://stripe.com/docs/error-codes) reported.

property decline_code

decline_code?: string;

For card errors resulting from a card issuer decline, a short string indicating the [card issuer’s reason for the decline](https://stripe.com/docs/declines#issuer-declines) if they provide one.

property doc_url

doc_url?: string;

A URL to more information about the [error code](https://stripe.com/docs/error-codes) reported.

property message

message?: string;

A human-readable message providing more details about the error. For card errors, these messages can be shown to your users.

property param

param?: string;

If the error is parameter-specific, the parameter related to the error. For example, you can use this to display a message near the correct form field.

property payment_intent

payment_intent?: api.PaymentIntent;

The PaymentIntent object for errors returned on a request involving a PaymentIntent.

property payment_method

payment_method?: api.PaymentMethod;

The PaymentMethod object for errors returned on a request involving a PaymentMethod.

property request_log_url

request_log_url?: string;

A URL to the request log entry in your dashboard.

property setup_intent

setup_intent?: api.SetupIntent;

The SetupIntent object for errors returned on a request involving a SetupIntent.

property source

source?: api.Source;

The Source object for errors returned on a request involving a Source.

property type

type: StripeErrorType;

The type of error.

interface StripeExpressCheckoutElementClickEvent

interface StripeExpressCheckoutElementClickEvent {}

property elementType

elementType: 'expressCheckout';

The type of element that emitted this event.

property expressPaymentType

expressPaymentType: ExpressPaymentType;

The payment method associated with the button that was clicked.

property reject

reject: () => void;

Callback to allow for cancellation of the payment interface. This must be called within 1 second of the 'click' event being emitted.

property resolve

resolve: (resolveDetails?: ClickResolveDetails) => void;

Callback to configure the details shown on a payment interface, including which fields to collect. This must be called within 1 second of the 'click' event being emitted.

interface StripeExpressCheckoutElementConfirmEvent

interface StripeExpressCheckoutElementConfirmEvent {}

property billingDetails

billingDetails?: BillingDetails;

property expressPaymentType

expressPaymentType: ExpressPaymentType;

property paymentFailed

paymentFailed: (payload?: {
    reason?:
        | 'fail'
        | 'invalid_shipping_address'
        | 'invalid_billing_address'
        | 'invalid_payment_data'
        | 'address_unserviceable';
    message?: string;
}) => void;

Callback when a payment is unsuccessful. Optionally, specifying a reason will show a more detailed error in the payment interface.

property shippingAddress

shippingAddress?: ShippingAddress;

property shippingRate

shippingRate?: ShippingRate;

interface StripeExpressCheckoutElementOptions

interface StripeExpressCheckoutElementOptions {}

property allowedShippingCountries

allowedShippingCountries?: string[];

An array of two-letter ISO country codes representing which countries are eligible shipping locations.

property applePay

applePay?: ApplePayOption;

property billingAddressRequired

billingAddressRequired?: boolean;

Whether the billing address should be collected in the payment interface.

property business

business?: { name: string };

Provide information about your business that will be displayed in the payment interface. This information will be retrieved from your Stripe account if not provided.

property buttonHeight

buttonHeight?: number;

Manually sets the height of the buttons shown.

property buttonTheme

buttonTheme?: ButtonThemeOption;

Controls the color of each button.

property buttonType

buttonType?: ButtonTypeOption;

Specifies the type of each button.

property emailRequired

emailRequired?: boolean;

Whether the email address should be collected in the payment interface.

property layout

layout?: LayoutOption;

Specifies how buttons should be laid out in relation to each other.

property lineItems

lineItems?: Array<LineItem>;

property paymentMethodOrder

paymentMethodOrder?: string[];

Override the order in which payment methods are displayed in the Express Checkout Element. By default, the Express Checkout Element will use a dynamic ordering that optimizes payment method display for each user.

property paymentMethods

paymentMethods?: ExpressCheckoutPaymentMethodsOption;

Control payment method display in the Express Checkout Element.

property phoneNumberRequired

phoneNumberRequired?: boolean;

Whether the phone number should be collected in the payment interface.

property shippingAddressRequired

shippingAddressRequired?: boolean;

Whether the shipping address should be collected in the payment interface.

property shippingRates

shippingRates?: Array<ShippingRate>;

property wallets

wallets?: ExpressCheckoutWalletsOption;

Deprecated
Use paymentMethods instead.
Control wallets display in the Express Checkout Element.

interface StripeExpressCheckoutElementReadyEvent

interface StripeExpressCheckoutElementReadyEvent {}

property availablePaymentMethods

availablePaymentMethods: undefined | AvailablePaymentMethods;

The list of payment methods that could possibly show in the element, or undefined if no payment methods can show.

property elementType

elementType: 'expressCheckout';

The type of element that emitted this event.

interface StripeExpressCheckoutElementShippingAddressChangeEvent

interface StripeExpressCheckoutElementShippingAddressChangeEvent {}

property address

address: ExpressCheckoutPartialAddress;

property name

name: string;

property reject

reject: () => void;

property resolve

resolve: (resolveDetails?: ChangeResolveDetails) => void;

interface StripeExpressCheckoutElementShippingRateChangeEvent

interface StripeExpressCheckoutElementShippingRateChangeEvent {}

property reject

reject: () => void;

property resolve

resolve: (resolveDetails?: ChangeResolveDetails) => void;

property shippingRate

shippingRate: ShippingRate;

interface StripeExpressCheckoutElementUpdateOptions

interface StripeExpressCheckoutElementUpdateOptions {}

property allowedShippingCountries

allowedShippingCountries?: string[];

An array of two-letter ISO country codes representing which countries are eligible shipping locations.

property billingAddressRequired

billingAddressRequired?: boolean;

Whether the billing address should be collected in the payment interface.

property buttonHeight

buttonHeight?: number;

Manually sets the height of the buttons shown.

property emailRequired

emailRequired?: boolean;

Whether the email address should be collected in the payment interface.

property layout

layout?: LayoutOption;

Specifies how buttons should be laid out in relation to each other.

property paymentMethodOrder

paymentMethodOrder?: string[];

Override the order in which payment methods are displayed in the Pay Button Element. By default, the Express Checkout Element will use a dynamic ordering that optimizes payment method display for each user.

property phoneNumberRequired

phoneNumberRequired?: boolean;

Whether the phone number should be collected in the payment interface.

property shippingAddressRequired

shippingAddressRequired?: boolean;

Whether the shipping address should be collected in the payment interface.

interface StripeIbanElementChangeEvent

interface StripeIbanElementChangeEvent extends StripeElementChangeEvent {}

property bankName

bankName: string;

property country

country: string;

property elementType

elementType: 'iban';

The type of element that emitted this event.

interface StripeIbanElementOptions

interface StripeIbanElementOptions {}

property classes

classes?: StripeElementClasses;

property disabled

disabled?: boolean;

Applies a disabled state to the Element such that user input is not accepted. Default is false.

property hideIcon

hideIcon?: boolean;

Hides the icon in the Element. Default is false.

property iconStyle

iconStyle?: 'default' | 'solid';

Appearance of the icon in the Element.

property placeholderCountry

placeholderCountry?: string;

property style

style?: StripeElementStyle;

property supportedCountries

supportedCountries?: string[];

interface StripeIssuingAddToWalletButtonElementOptions

interface StripeIssuingAddToWalletButtonElementOptions {}

property buttonHeight

buttonHeight?: number;

The height of the button in pixels. Defaults to 44px. Must be between 36px and 55px.

property ephemeralKeySecret

ephemeralKeySecret: string;

The secret component of the ephemeral key with which to authenticate this sensitive card provisioning request

property issuingCard

issuingCard: string;

The token (e.g. ic_abc123) of the issued card to add to the user's wallet.

property nonce

nonce: string;

The nonce used to mint the ephemeral key provided in ephemeralKeySecret

property wallet

wallet: 'apple';

The type of Add to Wallet button to display. For now, only 'apple' is supported.

interface StripeIssuingCardCopyButtonElementOptions

interface StripeIssuingCardCopyButtonElementOptions {}

property style

style?: StripeElementStyle;

property toCopy

toCopy: 'expiry' | 'cvc' | 'number' | 'pin';

The issued card data element to copy to the user's clipboard

interface StripeIssuingCardCvcDisplayElementOptions

interface StripeIssuingCardCvcDisplayElementOptions {}

property ephemeralKeySecret

ephemeralKeySecret?: string;

The secret component of the ephemeral key with which to authenticate this sensitive card details request

property issuingCard

issuingCard: string;

The token (e.g. ic_abc123) of the issued card to display in this Element

property nonce

nonce?: string;

The nonce used to mint the ephemeral key provided in ephemeralKeySecret

property style

style?: StripeElementStyle;

interface StripeIssuingCardExpiryDisplayElementOptions

interface StripeIssuingCardExpiryDisplayElementOptions {}

property ephemeralKeySecret

ephemeralKeySecret?: string;

The secret component of the ephemeral key with which to authenticate this sensitive card details request

property issuingCard

issuingCard: string;

The token (e.g. ic_abc123) of the issued card to display in this Element

property nonce

nonce?: string;

The nonce used to mint the ephemeral key provided in ephemeralKeySecret

property style

style?: StripeElementStyle;

interface StripeIssuingCardNumberDisplayElementOptions

interface StripeIssuingCardNumberDisplayElementOptions {}

property ephemeralKeySecret

ephemeralKeySecret?: string;

The secret component of the ephemeral key with which to authenticate this sensitive card details request

property issuingCard

issuingCard: string;

The token (e.g. ic_abc123) of the issued card to display in this Element

property nonce

nonce?: string;

The nonce used to mint the ephemeral key provided in ephemeralKeySecret

property style

style?: StripeElementStyle;

interface StripeIssuingCardPinDisplayElementOptions

interface StripeIssuingCardPinDisplayElementOptions {}

property ephemeralKeySecret

ephemeralKeySecret?: string;

The secret component of the ephemeral key with which to authenticate this sensitive card details request

property issuingCard

issuingCard: string;

The token (e.g. ic_abc123) of the issued card to display in this Element

property nonce

nonce?: string;

The nonce used to mint the ephemeral key provided in ephemeralKeySecret

property style

style?: StripeElementStyle;

interface StripeLinkAuthenticationElementChangeEvent

interface StripeLinkAuthenticationElementChangeEvent {}

property complete

complete: boolean;

Whether or not the LinkAuthentication Element is complete.

property elementType

elementType: 'linkAuthentication';

The type of element that emitted this event.

property empty

empty: boolean;

Whether or not the LinkAuthentication Element is currently empty.

property value

value: {
    email: string;
};

An object containing the current email.

interface StripeLinkAuthenticationElementOptions

interface StripeLinkAuthenticationElementOptions {}

property defaultValues

defaultValues?: {
    email: string;
};

Default value for LinkAuthenticationElement fields

interface StripePaymentElementCardDetailsChangeEvent

interface StripePaymentElementCardDetailsChangeEvent {}

property details

details?: {
    brands: CardBrand[] | null;
    funding: CardFunding | null;
};

The card details for the selected payment method. Undefined while loading and for non card payment methods.

property elementType

elementType: 'payment';

The type of element that emitted this event.

property loading

loading: boolean;

true when the card details are loading.

interface StripePaymentElementChangeEvent

interface StripePaymentElementChangeEvent {}

property collapsed

collapsed: boolean;

Whether or not the Payment Element is currently collapsed.

property complete

complete: boolean;

true if the every input in the Payment Element is well-formed and potentially complete.

property elementType

elementType: 'payment';

The type of element that emitted this event.

property empty

empty: boolean;

true if the all inputs in the Payment Element are empty.

property value

value: {
    type: string;
    billingDetails?: {
        address: {
            country?: null | string;
            postalCode?: null | string;
        };
    };
    payment_method?: {
        id: string;
        type: string;
        billing_details: {
            address: {
                city: null | string;
                country: null | string;
                line1: null | string;
                line2: null | string;
                postal_code: null | string;
                state: null | string;
            };
            name: null | string;
            email: null | string;
            phone: null | string;
        };
    };
};

An object containing the currently selected PaymentMethod type (in snake_case, for example "afterpay_clearpay"). If a payment method is selected, it will be included in the object.

interface StripePaymentElementOptions

interface StripePaymentElementOptions {}

property applePay

applePay?: ApplePayOption;

Specify the options to be used when the Apple Pay payment interface opens.

property business

business?: { name: string };

Override the business name displayed in the Payment Element. By default the PaymentElement will use your Stripe account or business name.

property defaultValues

defaultValues?: DefaultValuesOption;

Provide initial customer information that will be displayed in the Payment Element.

property fields

fields?: FieldsOption;

Control which fields are displayed in the Payment Element.

property layout

layout?: Layout | LayoutObject;

Specify a layout to use when rendering a Payment Element.

property paymentMethodOrder

paymentMethodOrder?: string[];

Override the order in which payment methods are displayed in the Payment Element. By default, the Payment Element will use a dynamic ordering that optimizes payment method display for each user.

property readOnly

readOnly?: boolean;

Apply a read-only state to the Payment Element so that payment details can’t be changed. Default is false.

property terms

terms?: TermsOption;

Control terms display in the Payment Element.

property wallets

wallets?: PaymentWalletsOption;

Control wallets display in the Payment Element.

interface StripePaymentElementSavedPaymentMethodRemoveEvent

interface StripePaymentElementSavedPaymentMethodRemoveEvent {}

property elementType

elementType: 'payment';

The type of element that emitted this event.

property error

error?: string;

Error message if the saved payment method removal fails.

property payment_method

payment_method: {
    id: string;
    type: string;
    billing_details: {
        address: {
            city: null | string;
            country: null | string;
            line1: null | string;
            line2: null | string;
            postal_code: null | string;
            state: null | string;
        };
        name: null | string;
        email: null | string;
        phone: null | string;
    };
};

The removed saved payment method.

property success

success: boolean;

true when the saved payment method is successfully removed.

interface StripePaymentElementSavedPaymentMethodUpdateEvent

interface StripePaymentElementSavedPaymentMethodUpdateEvent {}

property elementType

elementType: 'payment';

The type of element that emitted this event.

property error

error?: string;

Error message if the saved payment method update fails.

property payment_method

payment_method: {
    id: string;
    type: string;
    billing_details: {
        address: {
            city: null | string;
            country: null | string;
            line1: null | string;
            line2: null | string;
            postal_code: null | string;
            state: null | string;
        };
        name: null | string;
        email: null | string;
        phone: null | string;
    };
};

The updated saved payment method.

property success

success: boolean;

true when the saved payment method is successfully updated.

interface StripePaymentMethodMessagingElementOptions

interface StripePaymentMethodMessagingElementOptions {}

property amount

amount: number;

The total amount in the smallest currency unit.

property countryCode

countryCode?:
    | 'AT'
    | 'AU'
    | 'BE'
    | 'CA'
    | 'CH'
    | 'CZ'
    | 'DE'
    | 'DK'
    | 'ES'
    | 'FI'
    | 'FR'
    | 'GB'
    | 'GR'
    | 'IE'
    | 'IT'
    | 'NL'
    | 'NO'
    | 'NZ'
    | 'PL'
    | 'PT'
    | 'RO'
    | 'SE'
    | 'US';

The country the end-buyer is in.

property currency

currency:
    | 'AUD'
    | 'CAD'
    | 'CHF'
    | 'CZK'
    | 'DKK'
    | 'EUR'
    | 'GBP'
    | 'NOK'
    | 'NZD'
    | 'PLN'
    | 'SEK'
    | 'USD';

The currency to display.

property logoColor

logoColor?: 'black' | 'white' | 'color';

The logo color to display in the message. Defaults to black

property metaData

metaData?: {
    messagingClientReferenceId: string | null;
};

property paymentMethodOrder

paymentMethodOrder?: Array<'afterpay_clearpay' | 'klarna' | 'affirm'>;

Override the order in which payment methods are displayed in the Payment Method Messaging Element. By default, the Payment Method Messaging Element will use a dynamic ordering that optimizes payment method display for each user.

property paymentMethods

paymentMethods?: Array<'afterpay_clearpay' | 'klarna' | 'affirm'>;

Deprecated
Use paymentMethodTypes instead.

property paymentMethodTypes

paymentMethodTypes?: Array<'afterpay_clearpay' | 'klarna' | 'affirm'>;

Payment methods to show messaging for.

interface StripePaymentRequestButtonElementClickEvent

interface StripePaymentRequestButtonElementClickEvent {}

property preventDefault

preventDefault: () => void;

interface StripePaymentRequestButtonElementOptions

interface StripePaymentRequestButtonElementOptions {}

property classes

classes?: StripeElementClasses;

property disableMultipleButtons

disableMultipleButtons?: boolean;

Disable showing multiple buttons. Default is false.

property paymentRequest

paymentRequest: PaymentRequest;

A PaymentRequest object used to configure the element.

property style

style?: {
    paymentRequestButton: {
        /**
         * Preferred button type to display. Available types, by wallet:
         *
         * Browser card: default, book, buy, or donate.
         *
         * Google Pay: default, buy, or donate.
         *
         * Apple Pay: default, book, buy, donate, check-out, subscribe, reload, add-money, top-up, order, rent, support, contribute, tip
         *
         * When a wallet does not support the provided value, default is used as a fallback.
         */
        type?:
            | 'default'
            | 'book'
            | 'buy'
            | 'donate'
            | 'check-out'
            | 'subscribe'
            | 'reload'
            | 'add-money'
            | 'top-up'
            | 'order'
            | 'rent'
            | 'support'
            | 'contribute'
            | 'tip';

        /**
         * One of dark, light, or light-outline. The default is dark.
         */
        theme?: 'dark' | 'light' | 'light-outline';

        /**
         * The height of the Payment Request Button. Accepts px unit values.
         */
        height?: string;

        /**
         * The gap between buttons when multile buttons are shown. Accepts px unit values.
         */
        buttonSpacing?: string;
    };
};

An object used to customize the appearance of the Payment Request Button. The object must have a single paymentRequestButton field, containing any of the following sub-fields

interface StripeShippingAddressElementChangeEvent

interface StripeShippingAddressElementChangeEvent {}

property complete

complete: boolean;

Whether or not the shippingAddress Element is complete.

property elementType

elementType: 'shippingAddress';

The type of element that emitted this event.

property empty

empty: boolean;

Whether or not the shippingAddress Element is currently empty.

property isNewAddress

isNewAddress: boolean;

Whether or not the shipping address is new.

property value

value: {
    name: string;
    address: {
        line1: string;
        line2: string | null;
        city: string;
        state: string;
        postal_code: string;
        country: string;
    };
    phone?: string;
};

An object containing the current address.

interface StripeShippingAddressElementOptions

interface StripeShippingAddressElementOptions {}

property allowedCountries

allowedCountries?: string[] | null;

Control which countries are displayed in the shippingAddress Element.

property blockPoBox

blockPoBox?: boolean;

Whether or not ShippingAddressElement accepts PO boxes

property defaultValues

defaultValues?: {
    name?: string | null;
    address?: {
        line1?: string | null;
        line2?: string | null;
        city?: string | null;
        state?: string | null;
        postal_code?: string | null;
        country: string;
    };
    phone?: string | null;
};

Default value for ShippingAddressElement fields

property fields

fields?: {
    phone?: 'always' | 'never' | 'auto';
};

Control which additional fields to display in the shippingAddress Element.

property validation

validation?: {
    phone?: {
        required: 'always' | 'never' | 'auto';
    };
};

Specify validation rules for the above additional fields.

interface StripeTaxIdElementChangeEvent

interface StripeTaxIdElementChangeEvent {}

property complete

complete: boolean;

Whether or not the TaxIdElement is complete.

property elementType

elementType: 'taxId';

The type of element that emitted this event.

property empty

empty: boolean;

Whether or not the TaxIdElement is currently empty.

property value

value: {
    businessName: string;
    taxId: string;
    taxIdType: TaxIdType;
    externalTaxIdType: ExternalTaxIdType;
};

An object containing the current tax id information.

property visible

visible: boolean;

Whether or not the TaxIdElement is visible.

interface StripeTaxIdElementOptions

interface StripeTaxIdElementOptions {}

property defaultValues

defaultValues?: {
    businessName?: string;
    taxIdType?: TaxIdType;
    taxId?: string;
};

Default value for TaxIdElement fields

property fields

fields?: {
    businessName?: 'always' | 'never' | 'auto';
};

Control which fields to display in the TaxIdElement.

property validation

validation?: {
    businessName?: {
        required?: 'always' | 'never' | 'auto';
    };
    taxId?: {
        required?: 'always' | 'never' | 'auto';
    };
};

Specify validation rules for the given fields.

property visibility

visibility?: 'always' | 'never' | 'auto';

Control visibility of the TaxIdElement.

interface TermsOption

interface TermsOption {}

property applePay

applePay?: TermOption;

property auBecsDebit

auBecsDebit?: TermOption;

property bancontact

bancontact?: TermOption;

property card

card?: TermOption;

property cashapp

cashapp?: TermOption;

property googlePay

googlePay?: TermOption;

property ideal

ideal?: TermOption;

property paypal

paypal?: TermOption;

property sepaDebit

sepaDebit?: TermOption;

property sofort

sofort?: TermOption;

property usBankAccount

usBankAccount?: TermOption;

interface Token

interface Token {}

The Token object.

property bank_account

bank_account?: BankAccount;

property card

card?: Card;

property client_ip

client_ip: string | null;

IP address of the client that generated the token.

property created

created: number;

Time at which the object was created. Measured in seconds since the Unix epoch.

property id

id: string;

Unique identifier for the object.

property livemode

livemode: boolean;

Has the value true if the object exists in live mode or the value false if the object exists in test mode.

property object

object: 'token';

String representing the object's type. Objects of the same type share the same value.

property type

type: string;

Type of the token: account, bank_account, card, or pii.

property used

used: boolean;

Whether this token has already been used (tokens can be used only once).

interface VerificationSession

interface VerificationSession {}

The VerificationSession object.

property id

id: string;

Unique identifier for the object.

interface VerifyMicrodepositsForPaymentData

interface VerifyMicrodepositsForPaymentData {}

Data to be sent with a stripe.verifyMicrodepositsForPayment request.

property amounts

amounts?: Array<number>;

An array of two positive integers, in cents, equal to the values of the microdeposits sent to the bank account.

interface VerifyMicrodepositsForSetupData

interface VerifyMicrodepositsForSetupData {}

Data to be sent with a stripe.verifyMicrodepositsForSetup request.

property amounts

amounts?: Array<number>;

An array of two positive integers, in cents, equal to the values of the microdeposits sent to the bank account.

property descriptor_code

descriptor_code?: string;

A six-character code starting with SM present in the microdeposit sent to the bank account.

interface WrapperLibrary

interface WrapperLibrary {}

property name

name: string;

Your library’s name, maximum length is 30

property partner_id

partner_id?: string;

Required for Stripe Verified Partners, optional otherwise Your Partner ID from the Partners section of the Dashboard

property url

url?: string;

The URL for your library's website with your contact details

property version

version?: string;

Your library's version, in the format of x.x.x

Type Aliases

type AddressMode

type AddressMode = 'shipping' | 'billing';

type AnyBuyerError

type AnyBuyerError = { message: string; code: null };

type ApplePayButtonTheme

type ApplePayButtonTheme = 'black' | 'white' | 'white-outline';

type ApplePayButtonType

type ApplePayButtonType =
    | 'add-money'
    | 'book'
    | 'buy'
    | 'check-out'
    | 'contribute'
    | 'donate'
    | 'order'
    | 'plain'
    | 'reload'
    | 'rent'
    | 'subscribe'
    | 'support'
    | 'tip'
    | 'top-up';

type ApplyPromotionCodeError

type ApplyPromotionCodeError =
    | { message: string; code: 'invalidCode' }
    | AnyBuyerError;

type AvailablePaymentMethods

type AvailablePaymentMethods = {
    amazonPay: boolean;
    applePay: boolean;
    googlePay: boolean;
    link: boolean;
    paypal: boolean;
    klarna: boolean;
};

type Balance

type Balance = (CommonBalance & CashBalance) | (CommonBalance & CreditBalance);

type BankAccountToken

type BankAccountToken = Omit<Token, 'card'> & {
    bank_account: BankAccount;
};

type BillingDetails

type BillingDetails = {
    name: string;
    email?: string;
    phone?: string;
    address: ExpressCheckoutAddress;
};

type ButtonThemeOption

type ButtonThemeOption = {
    applePay?: ApplePayButtonTheme;
    googlePay?: GooglePayButtonTheme;
    paypal?: PayPalButtonTheme;
};

type ButtonTypeOption

type ButtonTypeOption = {
    applePay?: ApplePayButtonType;
    googlePay?: GooglePayButtonType;
    paypal?: PayPalButtonType;
};

type CanMakePaymentResult

type CanMakePaymentResult = Record<string, boolean>;

type CardBrand

type CardBrand =
    | 'amex'
    | 'diners'
    | 'discover'
    | 'eftpos_au'
    | 'jcb'
    | 'mastercard'
    | 'unionpay'
    | 'visa'
    | 'unknown';

type CardFunding

type CardFunding = 'credit' | 'debit' | 'prepaid' | 'unknown';

type CardNetworkBrand

type CardNetworkBrand =
    | 'accel'
    | 'amex'
    | 'carnet'
    | 'cartes_bancaires'
    | 'diners'
    | 'discover'
    | 'eftpos_au'
    | 'elo'
    | 'girocard'
    | 'interac'
    | 'jcb'
    | 'mastercard'
    | 'nyce'
    | 'pulse'
    | 'rupay'
    | 'star'
    | 'unionpay'
    | 'visa';

type ChangeResolveDetails

type ChangeResolveDetails = {
    lineItems?: Array<LineItem>;
    shippingRates?: Array<ShippingRate>;
    applePay?: ApplePayUpdateOption;
};

type CheckoutLocale

type CheckoutLocale =
    | 'auto'
    | 'bg'
    | 'cs'
    | 'da'
    | 'de'
    | 'el'
    | 'en'
    | 'en-GB'
    | 'es'
    | 'es-419'
    | 'et'
    | 'fi'
    | 'fil'
    | 'fr'
    | 'fr-CA'
    | 'hr'
    | 'hu'
    | 'id'
    | 'it'
    | 'ja'
    | 'lt'
    | 'lv'
    | 'ms'
    | 'mt'
    | 'nb'
    | 'nl'
    | 'pl'
    | 'pt'
    | 'pt-BR'
    | 'ro'
    | 'ru'
    | 'sk'
    | 'sl'
    | 'sv'
    | 'th'
    | 'tr'
    | 'zh'
    | 'zh-HK'
    | 'zh-TW';

type ClickResolveDetails

type ClickResolveDetails = {
    /**
     * @deprecated
     * An array of two-letter ISO country codes representing which countries
     * are eligible shipping locations.
     */
    allowedShippingCountries?: string[];

    /**
     * @deprecated
     * Whether the billing address should be collected in the payment interface.
     */
    billingAddressRequired?: boolean;

    /**
     * @deprecated
     * Provide information about your business that will be displayed in the payment interface.
     * This information will be retrieved from your Stripe account if not provided.
     */
    business?: { name: string };

    /**
     * @deprecated
     * Whether the email address should be collected in the payment interface.
     */
    emailRequired?: boolean;

    lineItems?: Array<LineItem>;

    /**
     * @deprecated
     * Whether the phone number should be collected in the payment interface.
     */
    phoneNumberRequired?: boolean;

    /**
     * @deprecated
     * Whether the shipping address should be collected in the payment interface.
     */
    shippingAddressRequired?: boolean;

    shippingRates?: Array<ShippingRate>;

    applePay?: ApplePayOption;
};

type CollectBankAccountTokenResult

type CollectBankAccountTokenResult =
    | {
          financialConnectionsSession: api.FinancialConnectionsSession;
          token: api.BankAccountToken;
          error?: undefined;
      }
    | {
          financialConnectionsSession: undefined;
          token: undefined;
          error: StripeError;
      };

type ConfirmationTokenResult

type ConfirmationTokenResult =
    | { confirmationToken: api.ConfirmationToken; error?: undefined }
    | { confirmationToken?: undefined; error: StripeError };

type ConfirmError

type ConfirmError =
    | {
          message: string;
          code: 'paymentFailed';
          paymentFailed: {
              declineCode: string | null;
          };
      }
    | AnyBuyerError;

type CreatePaymentMethodData

type CreatePaymentMethodData =
    | CreatePaymentMethodAcssDebitData
    | CreatePaymentMethodAffirmData
    | CreatePaymentMethodAfterpayClearpayData
    | CreatePaymentMethodAlipayData
    | CreatePaymentMethodAuBecsDebitData
    | CreatePaymentMethodBacsDebitData
    | CreatePaymentMethodBancontactData
    | CreatePaymentMethodBillieData
    | CreatePaymentMethodBlikData
    | CreatePaymentMethodBoletoData
    | CreatePaymentMethodCardData
    | CreatePaymentMethodCashappData
    | CreatePaymentMethodCustomerBalanceData
    | CreatePaymentMethodEpsData
    | CreatePaymentMethodGiropayData
    | CreatePaymentMethodGrabPayData
    | CreatePaymentMethodIdealData
    | CreatePaymentMethodKlarnaData
    | CreatePaymentMethodKonbiniData
    | CreatePaymentMethodP24Data
    | CreatePaymentMethodPayPalData
    | CreatePaymentMethodPayNowData
    | CreatePaymentMethodPixData
    | CreatePaymentMethodPromptPayData
    | CreatePaymentMethodFpxData
    | CreatePaymentMethodUsBankAccountData
    | CreatePaymentMethodSepaDebitData
    | CreatePaymentMethodSofortData
    | CreatePaymentMethodWechatPayData;

type DeliveryEstimate

type DeliveryEstimate = {
    unit: DeliveryUnit;
    value: number;
};

type DeliveryUnit

type DeliveryUnit = 'hour' | 'day' | 'business_day' | 'week' | 'month';

type EphemeralKeyNonceResult

type EphemeralKeyNonceResult =
    | { nonce: string; error?: undefined }
    | { nonce?: undefined; error: StripeError };

type ExpressCheckoutAddress

type ExpressCheckoutAddress = ExpressCheckoutPartialAddress & {
    line1: string;
    line2: string | null;
};

type ExpressCheckoutPartialAddress

type ExpressCheckoutPartialAddress = {
    city: string;
    state: string;
    postal_code: string;
    country: string;
};

type ExpressCheckoutPaymentMethodOption

type ExpressCheckoutPaymentMethodOption = 'auto' | 'never';

type ExpressCheckoutPaymentMethodOptionWithAlways

type ExpressCheckoutPaymentMethodOptionWithAlways =
    | 'always'
    | ExpressCheckoutPaymentMethodOption;

type ExpressCheckoutPaymentMethodsOption

type ExpressCheckoutPaymentMethodsOption = {
    amazonPay?: ExpressCheckoutPaymentMethodOption;
    applePay?: ExpressCheckoutPaymentMethodOptionWithAlways;
    googlePay?: ExpressCheckoutPaymentMethodOptionWithAlways;
    link?: ExpressCheckoutPaymentMethodOption;
    paypal?: ExpressCheckoutPaymentMethodOption;
    klarna?: ExpressCheckoutPaymentMethodOption;
};

type ExpressCheckoutWalletsOption

type ExpressCheckoutWalletsOption = {
    applePay?: ExpressCheckoutPaymentMethodOptionWithAlways;
    googlePay?: ExpressCheckoutPaymentMethodOptionWithAlways;
};

type ExpressPaymentType

type ExpressPaymentType =
    | 'google_pay'
    | 'apple_pay'
    | 'amazon_pay'
    | 'link'
    | 'paypal'
    | 'klarna';

type ExternalTaxIdType

type ExternalTaxIdType =
    | 'eu_vat'
    | 'al_tin'
    | 'am_tin'
    | 'ao_tin'
    | 'ba_tin'
    | 'bb_tin'
    | 'bs_tin'
    | 'cd_nif'
    | 'cl_tin'
    | 'tr_tin'
    | 'th_vat'
    | 'gn_nif'
    | 'kh_tin'
    | 'me_pib'
    | 'mk_vat'
    | 'mr_nif'
    | 'np_pan'
    | 'pe_ruc'
    | 'sa_vat'
    | 'sn_ninea'
    | 'sr_fin'
    | 'tj_tin'
    | 'ug_tin'
    | 'uy_ruc'
    | 'zm_tin'
    | 'zw_tin'
    | 'gb_vat'
    | 'nz_gst'
    | 'au_abn'
    | 'no_vat'
    | 'ch_vat'
    | 'mx_rfc'
    | 'ca_bn'
    | 'ca_qst'
    | 'ca_gst_hst'
    | 'ca_pst_bc'
    | 'ca_pst_mb'
    | 'ca_pst_sk'
    | 'sg_gst'
    | 'za_vat'
    | 'ru_inn'
    | 'ru_kpp'
    | 'ae_trn'
    | 'is_vat'
    | 'in_gst'
    | 'kr_brn'
    | 'es_cif'
    | 'bh_vat'
    | 'kz_bin'
    | 'ng_tin'
    | 'om_vat'
    | 'ge_vat'
    | 'ke_pin'
    | 'eg_tin'
    | 'tw_vat'
    | 'ua_vat'
    | 'ec_ruc'
    | 'cr_tin'
    | 'tz_vat'
    | 'rs_pib'
    | 'uz_vat'
    | 'uz_tin'
    | 'md_vat'
    | 'ma_vat'
    | 'by_tin'
    | 'li_vat'
    | 'aw_tin'
    | 'az_tin'
    | 'bd_bin'
    | 'bj_ifu'
    | 'et_tin'
    | 'kg_tin'
    | 'la_tin'
    | 'cm_niu'
    | 'cv_nif'
    | 'bf_ifu'
    | 'ph_tin';

type FieldOption

type FieldOption = 'auto' | 'never';

type FinancialConnectionsSessionResult

type FinancialConnectionsSessionResult =
    | {
          financialConnectionsSession: api.FinancialConnectionsSession;
          error?: undefined;
      }
    | { financialConnectionsSession: undefined; error: StripeError };

type GooglePayButtonTheme

type GooglePayButtonTheme = 'black' | 'white';

type GooglePayButtonType

type GooglePayButtonType =
    | 'book'
    | 'buy'
    | 'checkout'
    | 'donate'
    | 'order'
    | 'pay'
    | 'plain'
    | 'subscribe';

type Layout

type Layout = 'tabs' | 'accordion' | 'auto';

type LayoutOption

type LayoutOption = {
    maxColumns?: number;
    maxRows?: number;
    overflow?: 'auto' | 'never';
};

type LineItem

type LineItem = {
    name: string;
    amount: number;
};

type LoadActionsError

type LoadActionsError = { message: string; code: null };

type LoadActionsSuccess

type LoadActionsSuccess = {
    applyPromotionCode: (
        promotionCode: string
    ) => Promise<StripeCheckoutApplyPromotionCodeResult>;
    removePromotionCode: () => Promise<StripeCheckoutRemovePromotionCodeResult>;
    updateShippingAddress: (
        shippingAddress: StripeCheckoutContact | null
    ) => Promise<StripeCheckoutUpdateAddressResult>;
    updateBillingAddress: (
        billingAddress: StripeCheckoutContact | null
    ) => Promise<StripeCheckoutUpdateAddressResult>;
    updatePhoneNumber: (
        phoneNumber: string | null
    ) => Promise<StripeCheckoutUpdatePhoneNumberResult>;
    updateEmail: (email: string | null) => Promise<StripeCheckoutUpdateEmailResult>;
    updateLineItemQuantity: (args: {
        lineItem: string;
        quantity: number;
    }) => Promise<StripeCheckoutUpdateLineItemQuantityResult>;
    updateTaxIdInfo: (
        taxIdInfo: StripeCheckoutTaxIdInfo | null
    ) => Promise<StripeCheckoutUpdateTaxIdInfoResult>;
    updateShippingOption: (
        shippingOption: string
    ) => Promise<StripeCheckoutUpdateShippingOptionResult>;
    confirm: (args?: {
        returnUrl?: string;
        redirect?: StripeCheckoutRedirectBehavior;
        paymentMethod?: string;
        savePaymentMethod?: boolean;
        email?: string;
        phoneNumber?: string;
        billingAddress?: StripeCheckoutContact;
        shippingAddress?: StripeCheckoutContact;
        expressCheckoutConfirmEvent?: StripeExpressCheckoutElementConfirmEvent;
    }) => Promise<StripeCheckoutConfirmResult>;
    getSession: () => StripeCheckoutSession;
    runServerUpdate: (
        userFunction: RunServerUpdateFunction
    ) => Promise<StripeCheckoutRunServerUpdateResult>;
};

type PaymentIntentOrSetupIntentResult

type PaymentIntentOrSetupIntentResult =
    | {
          paymentIntent: api.PaymentIntent;
          setupIntent?: undefined;
          error?: undefined;
      }
    | { paymentIntent?: undefined; setupIntent: api.SetupIntent; error?: undefined }
    | { paymentIntent?: undefined; setupIntent?: undefined; error: StripeError };

type PaymentIntentResult

type PaymentIntentResult =
    | { paymentIntent: api.PaymentIntent; error?: undefined }
    | { paymentIntent?: undefined; error: StripeError };

type PaymentMethodOptions

type PaymentMethodOptions = {
    card?: { require_cvc_recollection?: boolean };
    us_bank_account?: {
        financial_connections?: {
            permissions?: Array<
                'balances' | 'ownership' | 'payment_method' | 'transactions'
            >;
        };
        verification_method?: 'automatic' | 'instant';
    };
};

type PaymentMethodResult

type PaymentMethodResult =
    | { paymentMethod: api.PaymentMethod; error?: undefined }
    | { paymentMethod?: undefined; error: StripeError };

type PaymentRequestCompleteStatus

type PaymentRequestCompleteStatus =
    /**
     * Report to the browser that the payment was successful, and that it can close any active payment interface.
     */
    | 'success'

    /**
     * Report to the browser that you were unable to process the customer‘s payment.
     * Browsers may re-show the payment interface, or simply show a message and close.
     */
    | 'fail'

    /**
     * Equivalent to `fail`, except that the browser can choose to show a more-specific error message.
     */
    | 'invalid_payer_name'

    /**
     * Equivalent to `fail`, except that the browser can choose to show a more-specific error message.
     */
    | 'invalid_payer_phone'

    /**
     * Equivalent to `fail`, except that the browser can choose to show a more-specific error message.
     */
    | 'invalid_payer_email'

    /**
     * Equivalent to `fail`, except that the browser can choose to show a more-specific error message.
     */
    | 'invalid_shipping_address';

type PaymentRequestUpdateDetailsStatus

type PaymentRequestUpdateDetailsStatus =
    /**
     * Let the customer proceed.
     */
    | 'success'

    /**
     * Prevent the customer from making the change they just made.
     */
    | 'fail'

    /**
     * Equivalent to `fail`, except we show a more specific error message.
     * Can only be used in a `shippingaddresschange` handler.
     */
    | 'invalid_shipping_address';

type PaymentRequestWallet

type PaymentRequestWallet = 'applePay' | 'googlePay' | 'link' | 'browserCard';

type PaymentWalletOption

type PaymentWalletOption = 'auto' | 'never';

type PayPalButtonTheme

type PayPalButtonTheme = 'gold' | 'blue' | 'silver' | 'white' | 'black';

type PayPalButtonType

type PayPalButtonType = 'paypal' | 'buynow' | 'checkout' | 'pay';

type ProcessOrderResult

type ProcessOrderResult =
    | { paymentIntent: api.PaymentIntent; order: api.Order; error?: undefined }
    | { paymentIntent?: undefined; order: api.Order; error?: undefined }
    | { paymentIntent?: undefined; order?: undefined; error: StripeError };

type RadarSessionPayload

type RadarSessionPayload =
    | { radarSession: Record<any, any>; error?: undefined }
    | { radarSession?: undefined; error: StripeError };

type ResultAction

type ResultAction = { type: 'accept' } | { type: 'reject'; errorMessage?: string };

type RetrieveOrderResult

type RetrieveOrderResult =
    | { order: api.Order; error?: undefined }
    | { order?: undefined; error: StripeError };

type RunServerUpdateFunction

type RunServerUpdateFunction = () => Promise<unknown>;

type SavedPaymentMethodOption

type SavedPaymentMethodOption = {
    enableSave?: 'auto' | 'never';
    enableRedisplay?: 'auto' | 'never';
};

type SetupIntentResult

type SetupIntentResult =
    | { setupIntent: api.SetupIntent; error?: undefined }
    | { setupIntent?: undefined; error: StripeError };

type ShippingAddress

type ShippingAddress = {
    name: string;
    address: ExpressCheckoutAddress;
};

type ShippingRate

type ShippingRate = {
    id: string;
    amount: number;
    displayName: string;
    deliveryEstimate?:
        | string
        | {
              maximum?: DeliveryEstimate;
              minimum?: DeliveryEstimate;
          };
};

type SourceResult

type SourceResult =
    | { source: api.Source; error?: undefined }
    | { source?: undefined; error: StripeError };

type StripeAddressElement

type StripeAddressElement = StripeElementBase & {
    /**
     * The change event is triggered when the `Element`'s value changes.
     */
    on(
        eventType: 'change',
        handler: (event: StripeAddressElementChangeEvent) => any
    ): StripeAddressElement;
    once(
        eventType: 'change',
        handler: (event: StripeAddressElementChangeEvent) => any
    ): StripeAddressElement;
    off(
        eventType: 'change',
        handler?: (event: StripeAddressElementChangeEvent) => any
    ): StripeAddressElement;

    /**
     * Triggered when the element is fully rendered and can accept `element.focus` calls.
     */
    on(
        eventType: 'ready',
        handler: (event: { elementType: 'address' }) => any
    ): StripeAddressElement;
    once(
        eventType: 'ready',
        handler: (event: { elementType: 'address' }) => any
    ): StripeAddressElement;
    off(
        eventType: 'ready',
        handler?: (event: { elementType: 'address' }) => any
    ): StripeAddressElement;

    /**
     * Triggered when the element gains focus.
     */
    on(
        eventType: 'focus',
        handler: (event: { elementType: 'address' }) => any
    ): StripeAddressElement;
    once(
        eventType: 'focus',
        handler: (event: { elementType: 'address' }) => any
    ): StripeAddressElement;
    off(
        eventType: 'focus',
        handler?: (event: { elementType: 'address' }) => any
    ): StripeAddressElement;

    /**
     * Triggered when the element loses focus.
     */
    on(
        eventType: 'blur',
        handler: (event: { elementType: 'address' }) => any
    ): StripeAddressElement;
    once(
        eventType: 'blur',
        handler: (event: { elementType: 'address' }) => any
    ): StripeAddressElement;
    off(
        eventType: 'blur',
        handler?: (event: { elementType: 'address' }) => any
    ): StripeAddressElement;

    /**
     * Triggered when the escape key is pressed within the element.
     */
    on(
        eventType: 'escape',
        handler: (event: { elementType: 'address' }) => any
    ): StripeAddressElement;
    once(
        eventType: 'escape',
        handler: (event: { elementType: 'address' }) => any
    ): StripeAddressElement;
    off(
        eventType: 'escape',
        handler?: (event: { elementType: 'address' }) => any
    ): StripeAddressElement;

    /**
     * Triggered when the element fails to load.
     */
    on(
        eventType: 'loaderror',
        handler: (event: { elementType: 'address'; error: StripeError }) => any
    ): StripeAddressElement;
    once(
        eventType: 'loaderror',
        handler: (event: { elementType: 'address'; error: StripeError }) => any
    ): StripeAddressElement;
    off(
        eventType: 'loaderror',
        handler?: (event: { elementType: 'address'; error: StripeError }) => any
    ): StripeAddressElement;

    /**
     * Triggered when the loader UI is mounted to the DOM and ready to be displayed.
     */
    on(
        eventType: 'loaderstart',
        handler: (event: { elementType: 'address' }) => any
    ): StripeAddressElement;
    once(
        eventType: 'loaderstart',
        handler: (event: { elementType: 'address' }) => any
    ): StripeAddressElement;
    off(
        eventType: 'loaderstart',
        handler?: (event: { elementType: 'address' }) => any
    ): StripeAddressElement;

    /**
     * Updates the options the `AddressElement` was initialized with.
     * Updates are merged into the existing configuration.
     */
    update(options: Partial<StripeAddressElementOptions>): StripeAddressElement;

    /**
     * Validates and retrieves form values from the `AddressElement`.
     */
    getValue(): Promise<
        Pick<StripeAddressElementChangeEvent, 'complete' | 'isNewAddress' | 'value'>
    >;
};

type StripeAuBankAccountElement

type StripeAuBankAccountElement = StripeElementBase & {
    /**
     * The change event is triggered when the `Element`'s value changes.
     */
    on(
        eventType: 'change',
        handler: (event: StripeAuBankAccountElementChangeEvent) => any
    ): StripeAuBankAccountElement;
    once(
        eventType: 'change',
        handler: (event: StripeAuBankAccountElementChangeEvent) => any
    ): StripeAuBankAccountElement;
    off(
        eventType: 'change',
        handler?: (event: StripeAuBankAccountElementChangeEvent) => any
    ): StripeAuBankAccountElement;

    /**
     * Triggered when the element is fully rendered and can accept `element.focus` calls.
     */
    on(
        eventType: 'ready',
        handler: (event: { elementType: 'auBankAccount' }) => any
    ): StripeAuBankAccountElement;
    once(
        eventType: 'ready',
        handler: (event: { elementType: 'auBankAccount' }) => any
    ): StripeAuBankAccountElement;
    off(
        eventType: 'ready',
        handler?: (event: { elementType: 'auBankAccount' }) => any
    ): StripeAuBankAccountElement;

    /**
     * Triggered when the element gains focus.
     */
    on(
        eventType: 'focus',
        handler: (event: { elementType: 'auBankAccount' }) => any
    ): StripeAuBankAccountElement;
    once(
        eventType: 'focus',
        handler: (event: { elementType: 'auBankAccount' }) => any
    ): StripeAuBankAccountElement;
    off(
        eventType: 'focus',
        handler?: (event: { elementType: 'auBankAccount' }) => any
    ): StripeAuBankAccountElement;

    /**
     * Triggered when the element loses focus.
     */
    on(
        eventType: 'blur',
        handler: (event: { elementType: 'auBankAccount' }) => any
    ): StripeAuBankAccountElement;
    once(
        eventType: 'blur',
        handler: (event: { elementType: 'auBankAccount' }) => any
    ): StripeAuBankAccountElement;
    off(
        eventType: 'blur',
        handler?: (event: { elementType: 'auBankAccount' }) => any
    ): StripeAuBankAccountElement;

    /**
     * Triggered when the escape key is pressed within the element.
     */
    on(
        eventType: 'escape',
        handler: (event: { elementType: 'auBankAccount' }) => any
    ): StripeAuBankAccountElement;
    once(
        eventType: 'escape',
        handler: (event: { elementType: 'auBankAccount' }) => any
    ): StripeAuBankAccountElement;
    off(
        eventType: 'escape',
        handler?: (event: { elementType: 'auBankAccount' }) => any
    ): StripeAuBankAccountElement;

    /**
     * Updates the options the `AuBankAccountElement` was initialized with.
     * Updates are merged into the existing configuration.
     *
     * The styles of an `AuBankAccountElement` can be dynamically changed using `element.update`.
     * This method can be used to simulate CSS media queries that automatically adjust the size of elements when viewed on different devices.
     */
    update(options: Partial<StripeAuBankAccountElementOptions>): void;
};

type StripeCardCvcElement

type StripeCardCvcElement = StripeElementBase & {
    /**
     * The change event is triggered when the `Element`'s value changes.
     */
    on(
        eventType: 'change',
        handler: (event: StripeCardCvcElementChangeEvent) => any
    ): StripeCardCvcElement;
    once(
        eventType: 'change',
        handler: (event: StripeCardCvcElementChangeEvent) => any
    ): StripeCardCvcElement;
    off(
        eventType: 'change',
        handler?: (event: StripeCardCvcElementChangeEvent) => any
    ): StripeCardCvcElement;

    /**
     * Triggered when the element is fully rendered and can accept `element.focus` calls.
     */
    on(
        eventType: 'ready',
        handler: (event: { elementType: 'cardCvc' }) => any
    ): StripeCardCvcElement;
    once(
        eventType: 'ready',
        handler: (event: { elementType: 'cardCvc' }) => any
    ): StripeCardCvcElement;
    off(
        eventType: 'ready',
        handler?: (event: { elementType: 'cardCvc' }) => any
    ): StripeCardCvcElement;

    /**
     * Triggered when the element gains focus.
     */
    on(
        eventType: 'focus',
        handler: (event: { elementType: 'cardCvc' }) => any
    ): StripeCardCvcElement;
    once(
        eventType: 'focus',
        handler: (event: { elementType: 'cardCvc' }) => any
    ): StripeCardCvcElement;
    off(
        eventType: 'focus',
        handler?: (event: { elementType: 'cardCvc' }) => any
    ): StripeCardCvcElement;

    /**
     * Triggered when the element loses focus.
     */
    on(
        eventType: 'blur',
        handler: (event: { elementType: 'cardCvc' }) => any
    ): StripeCardCvcElement;
    once(
        eventType: 'blur',
        handler: (event: { elementType: 'cardCvc' }) => any
    ): StripeCardCvcElement;
    off(
        eventType: 'blur',
        handler?: (event: { elementType: 'cardCvc' }) => any
    ): StripeCardCvcElement;

    /**
     * Triggered when the escape key is pressed within the element.
     */
    on(
        eventType: 'escape',
        handler: (event: { elementType: 'cardCvc' }) => any
    ): StripeCardCvcElement;
    once(
        eventType: 'escape',
        handler: (event: { elementType: 'cardCvc' }) => any
    ): StripeCardCvcElement;
    off(
        eventType: 'escape',
        handler?: (event: { elementType: 'cardCvc' }) => any
    ): StripeCardCvcElement;

    /**
     * Updates the options the `CardCvcElement` was initialized with.
     * Updates are merged into the existing configuration.
     *
     * The styles of an `CardCvcElement` can be dynamically changed using `element.update`.
     * This method can be used to simulate CSS media queries that automatically adjust the size of elements when viewed on different devices.
     */
    update(options: Partial<StripeCardCvcElementOptions>): void;
};

type StripeCardElement

type StripeCardElement = StripeElementBase & {
    /**
     * The change event is triggered when the `Element`'s value changes.
     */
    on(
        eventType: 'change',
        handler: (event: StripeCardElementChangeEvent) => any
    ): StripeCardElement;
    once(
        eventType: 'change',
        handler: (event: StripeCardElementChangeEvent) => any
    ): StripeCardElement;
    off(
        eventType: 'change',
        handler?: (event: StripeCardElementChangeEvent) => any
    ): StripeCardElement;

    /**
     * Triggered when the element is fully rendered and can accept `element.focus` calls.
     */
    on(
        eventType: 'ready',
        handler: (event: { elementType: 'card' }) => any
    ): StripeCardElement;
    once(
        eventType: 'ready',
        handler: (event: { elementType: 'card' }) => any
    ): StripeCardElement;
    off(
        eventType: 'ready',
        handler?: (event: { elementType: 'card' }) => any
    ): StripeCardElement;

    /**
     * Triggered when the element gains focus.
     */
    on(
        eventType: 'focus',
        handler: (event: { elementType: 'card' }) => any
    ): StripeCardElement;
    once(
        eventType: 'focus',
        handler: (event: { elementType: 'card' }) => any
    ): StripeCardElement;
    off(
        eventType: 'focus',
        handler?: (event: { elementType: 'card' }) => any
    ): StripeCardElement;

    /**
     * Triggered when the element loses focus.
     */
    on(
        eventType: 'blur',
        handler: (event: { elementType: 'card' }) => any
    ): StripeCardElement;
    once(
        eventType: 'blur',
        handler: (event: { elementType: 'card' }) => any
    ): StripeCardElement;
    off(
        eventType: 'blur',
        handler?: (event: { elementType: 'card' }) => any
    ): StripeCardElement;

    /**
     * Triggered when the escape key is pressed within the element.
     */
    on(
        eventType: 'escape',
        handler: (event: { elementType: 'card' }) => any
    ): StripeCardElement;
    once(
        eventType: 'escape',
        handler: (event: { elementType: 'card' }) => any
    ): StripeCardElement;
    off(
        eventType: 'escape',
        handler?: (event: { elementType: 'card' }) => any
    ): StripeCardElement;

    /**
     * Triggered when there is a change to the available networks the provided card can run on.
     */
    on(
        eventType: 'networkschange',
        handler: (event: { elementType: 'card' }) => any
    ): StripeCardElement;
    once(
        eventType: 'networkschange',
        handler: (event: { elementType: 'card' }) => any
    ): StripeCardElement;
    off(
        eventType: 'networkschange',
        handler?: (event: { elementType: 'card' }) => any
    ): StripeCardElement;

    /**
     * Triggered when the element fails to load.
     */
    on(
        eventType: 'loaderror',
        handler: (event: { elementType: 'card'; error: StripeError }) => any
    ): StripeCardElement;
    once(
        eventType: 'loaderror',
        handler: (event: { elementType: 'card'; error: StripeError }) => any
    ): StripeCardElement;
    off(
        eventType: 'loaderror',
        handler?: (event: { elementType: 'card'; error: StripeError }) => any
    ): StripeCardElement;

    /**
     * Updates the options the `CardElement` was initialized with.
     * Updates are merged into the existing configuration.
     *
     * The styles of an `CardElement` can be dynamically changed using `element.update`.
     * This method can be used to simulate CSS media queries that automatically adjust the size of elements when viewed on different devices.
     */
    update(options: StripeCardElementUpdateOptions): void;
};

type StripeCardExpiryElement

type StripeCardExpiryElement = StripeElementBase & {
    /**
     * The change event is triggered when the `Element`'s value changes.
     */
    on(
        eventType: 'change',
        handler: (event: StripeCardExpiryElementChangeEvent) => any
    ): StripeCardExpiryElement;
    once(
        eventType: 'change',
        handler: (event: StripeCardExpiryElementChangeEvent) => any
    ): StripeCardExpiryElement;
    off(
        eventType: 'change',
        handler?: (event: StripeCardExpiryElementChangeEvent) => any
    ): StripeCardExpiryElement;

    /**
     * Triggered when the element is fully rendered and can accept `element.focus` calls.
     */
    on(
        eventType: 'ready',
        handler: (event: { elementType: 'cardExpiry' }) => any
    ): StripeCardExpiryElement;
    once(
        eventType: 'ready',
        handler: (event: { elementType: 'cardExpiry' }) => any
    ): StripeCardExpiryElement;
    off(
        eventType: 'ready',
        handler?: (event: { elementType: 'cardExpiry' }) => any
    ): StripeCardExpiryElement;

    /**
     * Triggered when the element gains focus.
     */
    on(
        eventType: 'focus',
        handler: (event: { elementType: 'cardExpiry' }) => any
    ): StripeCardExpiryElement;
    once(
        eventType: 'focus',
        handler: (event: { elementType: 'cardExpiry' }) => any
    ): StripeCardExpiryElement;
    off(
        eventType: 'focus',
        handler?: (event: { elementType: 'cardExpiry' }) => any
    ): StripeCardExpiryElement;

    /**
     * Triggered when the element loses focus.
     */
    on(
        eventType: 'blur',
        handler: (event: { elementType: 'cardExpiry' }) => any
    ): StripeCardExpiryElement;
    once(
        eventType: 'blur',
        handler: (event: { elementType: 'cardExpiry' }) => any
    ): StripeCardExpiryElement;
    off(
        eventType: 'blur',
        handler?: (event: { elementType: 'cardExpiry' }) => any
    ): StripeCardExpiryElement;

    /**
     * Triggered when the escape key is pressed within the element.
     */
    on(
        eventType: 'escape',
        handler: (event: { elementType: 'cardExpiry' }) => any
    ): StripeCardExpiryElement;
    once(
        eventType: 'escape',
        handler: (event: { elementType: 'cardExpiry' }) => any
    ): StripeCardExpiryElement;
    off(
        eventType: 'escape',
        handler?: (event: { elementType: 'cardExpiry' }) => any
    ): StripeCardExpiryElement;

    /**
     * Updates the options the `CardExpiryElement` was initialized with.
     * Updates are merged into the existing configuration.
     *
     * The styles of an `CardExpiryElement` can be dynamically changed using `element.update`.
     * This method can be used to simulate CSS media queries that automatically adjust the size of elements when viewed on different devices.
     */
    update(options: Partial<StripeCardExpiryElementOptions>): void;
};

type StripeCardNumberElement

type StripeCardNumberElement = StripeElementBase & {
    /**
     * The change event is triggered when the `Element`'s value changes.
     */
    on(
        eventType: 'change',
        handler: (event: StripeCardNumberElementChangeEvent) => any
    ): StripeCardNumberElement;
    once(
        eventType: 'change',
        handler: (event: StripeCardNumberElementChangeEvent) => any
    ): StripeCardNumberElement;
    off(
        eventType: 'change',
        handler?: (event: StripeCardNumberElementChangeEvent) => any
    ): StripeCardNumberElement;

    /**
     * Triggered when the element is fully rendered and can accept `element.focus` calls.
     */
    on(
        eventType: 'ready',
        handler: (event: { elementType: 'cardNumber' }) => any
    ): StripeCardNumberElement;
    once(
        eventType: 'ready',
        handler: (event: { elementType: 'cardNumber' }) => any
    ): StripeCardNumberElement;
    off(
        eventType: 'ready',
        handler?: (event: { elementType: 'cardNumber' }) => any
    ): StripeCardNumberElement;

    /**
     * Triggered when the element gains focus.
     */
    on(
        eventType: 'focus',
        handler: (event: { elementType: 'cardNumber' }) => any
    ): StripeCardNumberElement;
    once(
        eventType: 'focus',
        handler: (event: { elementType: 'cardNumber' }) => any
    ): StripeCardNumberElement;
    off(
        eventType: 'focus',
        handler?: (event: { elementType: 'cardNumber' }) => any
    ): StripeCardNumberElement;

    /**
     * Triggered when the element loses focus.
     */
    on(
        eventType: 'blur',
        handler: (event: { elementType: 'cardNumber' }) => any
    ): StripeCardNumberElement;
    once(
        eventType: 'blur',
        handler: (event: { elementType: 'cardNumber' }) => any
    ): StripeCardNumberElement;
    off(
        eventType: 'blur',
        handler?: (event: { elementType: 'cardNumber' }) => any
    ): StripeCardNumberElement;

    /**
     * Triggered when the escape key is pressed within the element.
     */
    on(
        eventType: 'escape',
        handler: (event: { elementType: 'cardNumber' }) => any
    ): StripeCardNumberElement;
    once(
        eventType: 'escape',
        handler: (event: { elementType: 'cardNumber' }) => any
    ): StripeCardNumberElement;
    off(
        eventType: 'escape',
        handler?: (event: { elementType: 'cardNumber' }) => any
    ): StripeCardNumberElement;

    /**
     * Triggered when there is a change to the available networks the provided card can run on.
     */
    on(
        eventType: 'networkschange',
        handler: (event: { elementType: 'cardNumber' }) => any
    ): StripeCardNumberElement;
    once(
        eventType: 'networkschange',
        handler: (event: { elementType: 'cardNumber' }) => any
    ): StripeCardNumberElement;
    off(
        eventType: 'networkschange',
        handler?: (event: { elementType: 'cardNumber' }) => any
    ): StripeCardNumberElement;

    /**
     * Triggered when the element fails to load.
     */
    on(
        eventType: 'loaderror',
        handler: (event: { elementType: 'cardNumber'; error: StripeError }) => any
    ): StripeCardNumberElement;
    once(
        eventType: 'loaderror',
        handler: (event: { elementType: 'cardNumber'; error: StripeError }) => any
    ): StripeCardNumberElement;
    off(
        eventType: 'loaderror',
        handler?: (event: { elementType: 'cardNumber'; error: StripeError }) => any
    ): StripeCardNumberElement;

    /**
     * Updates the options the `CardNumberElement` was initialized with.
     * Updates are merged into the existing configuration.
     *
     * The styles of an `Element` can be dynamically changed using `element.update`.
     * This method can be used to simulate CSS media queries that automatically adjust the size of elements when viewed on different devices.
     */
    update(options: Partial<StripeCardNumberElementUpdateOptions>): void;
};

type StripeCheckoutAddress

type StripeCheckoutAddress = {
    country: string;
    line1?: string | null;
    line2?: string | null;
    city?: string | null;
    postal_code?: string | null;
    state?: string | null;
};

type StripeCheckoutAddressElementOptions

type StripeCheckoutAddressElementOptions = {
    contacts?: ContactOption[];
    display?: {
        name?: 'full' | 'split' | 'organization';
    };
};

type StripeCheckoutAdjustableQuantity

type StripeCheckoutAdjustableQuantity = {
    maximum: number;
    minimum: number;
};

type StripeCheckoutAmount

type StripeCheckoutAmount = { minorUnitsAmount: number; amount: string };

type StripeCheckoutApplyPromotionCodeResult

type StripeCheckoutApplyPromotionCodeResult =
    | { type: 'success'; session: StripeCheckoutSession }
    | { type: 'error'; error: ApplyPromotionCodeError };

type StripeCheckoutBillingInterval

type StripeCheckoutBillingInterval = 'day' | 'month' | 'week' | 'year';

type StripeCheckoutConfirmResult

type StripeCheckoutConfirmResult =
    | { type: 'success'; session: StripeCheckoutSession }
    | { type: 'error'; error: ConfirmError };

type StripeCheckoutContact

type StripeCheckoutContact = {
    name?: string | null;
    address: StripeCheckoutAddress;
};

type StripeCheckoutCurrencyOption

type StripeCheckoutCurrencyOption = StripeCheckoutAmount & {
    currency: string;
    currencyConversion?: { fxRate: number; sourceCurrency: string };
};

type StripeCheckoutDeliveryEstimate

type StripeCheckoutDeliveryEstimate = {
    maximum: StripeCheckoutEstimate | null;
    minimum: StripeCheckoutEstimate | null;
};

type StripeCheckoutDiscountAmount

type StripeCheckoutDiscountAmount = StripeCheckoutAmount & {
    displayName: string;
    promotionCode: string | null;
    recurring:
        | { type: 'forever' }
        | { type: 'repeating'; durationInMonths: number }
        | null;
    percentOff: number | null;
};

type StripeCheckoutDueNext

type StripeCheckoutDueNext = {
    subtotal: StripeCheckoutAmount;
    total: StripeCheckoutAmount;
    discount: StripeCheckoutAmount;
    taxInclusive: StripeCheckoutAmount;
    taxExclusive: StripeCheckoutAmount;
    billingCycleAnchor: number | null;
};

type StripeCheckoutEstimate

type StripeCheckoutEstimate = {
    unit: 'business_day' | 'day' | 'hour' | 'week' | 'month';
    value: number;
};

type StripeCheckoutExpressCheckoutElement

type StripeCheckoutExpressCheckoutElement = StripeElementBase & {
    /**
     * Triggered when the element is fully rendered.
     */
    on(
        eventType: 'ready',
        handler: (event: StripeExpressCheckoutElementReadyEvent) => any
    ): StripeCheckoutExpressCheckoutElement;
    once(
        eventType: 'ready',
        handler: (event: StripeExpressCheckoutElementReadyEvent) => any
    ): StripeCheckoutExpressCheckoutElement;
    off(
        eventType: 'ready',
        handler?: (event: StripeExpressCheckoutElementReadyEvent) => any
    ): StripeCheckoutExpressCheckoutElement;

    /**
     * Triggered when the element gains focus.
     */
    on(
        eventType: 'focus',
        handler: (event: { elementType: 'expressCheckout' }) => any
    ): StripeCheckoutExpressCheckoutElement;
    once(
        eventType: 'focus',
        handler: (event: { elementType: 'expressCheckout' }) => any
    ): StripeCheckoutExpressCheckoutElement;
    off(
        eventType: 'focus',
        handler?: (event: { elementType: 'expressCheckout' }) => any
    ): StripeCheckoutExpressCheckoutElement;

    /**
     * Triggered when the element loses focus.
     */
    on(
        eventType: 'blur',
        handler: (event: { elementType: 'expressCheckout' }) => any
    ): StripeCheckoutExpressCheckoutElement;
    once(
        eventType: 'blur',
        handler: (event: { elementType: 'expressCheckout' }) => any
    ): StripeCheckoutExpressCheckoutElement;
    off(
        eventType: 'blur',
        handler?: (event: { elementType: 'expressCheckout' }) => any
    ): StripeCheckoutExpressCheckoutElement;

    /**
     * Triggered when the escape key is pressed within the element.
     */
    on(
        eventType: 'escape',
        handler: (event: { elementType: 'expressCheckout' }) => any
    ): StripeCheckoutExpressCheckoutElement;
    once(
        eventType: 'escape',
        handler: (event: { elementType: 'expressCheckout' }) => any
    ): StripeCheckoutExpressCheckoutElement;
    off(
        eventType: 'escape',
        handler?: (event: { elementType: 'expressCheckout' }) => any
    ): StripeCheckoutExpressCheckoutElement;

    /**
     * Triggered when the element fails to load.
     */
    on(
        eventType: 'loaderror',
        handler: (event: {
            elementType: 'expressCheckout';
            error: StripeError;
        }) => any
    ): StripeCheckoutExpressCheckoutElement;
    once(
        eventType: 'loaderror',
        handler: (event: {
            elementType: 'expressCheckout';
            error: StripeError;
        }) => any
    ): StripeCheckoutExpressCheckoutElement;
    off(
        eventType: 'loaderror',
        handler?: (event: {
            elementType: 'expressCheckout';
            error: StripeError;
        }) => any
    ): StripeCheckoutExpressCheckoutElement;

    /**
     * Triggered when a buyer authorizes a payment within a supported payment method.
     */
    on(
        eventType: 'confirm',
        handler: (event: StripeExpressCheckoutElementConfirmEvent) => any
    ): StripeCheckoutExpressCheckoutElement;
    once(
        eventType: 'confirm',
        handler: (event: StripeExpressCheckoutElementConfirmEvent) => any
    ): StripeCheckoutExpressCheckoutElement;
    off(
        eventType: 'confirm',
        handler?: (event: StripeExpressCheckoutElementConfirmEvent) => any
    ): StripeCheckoutExpressCheckoutElement;

    /**
     * Triggered when a payment interface is dismissed (e.g., a buyer closes the payment interface)
     */
    on(
        eventType: 'cancel',
        handler: (event: { elementType: 'expressCheckout' }) => any
    ): StripeCheckoutExpressCheckoutElement;
    once(
        eventType: 'cancel',
        handler: (event: { elementType: 'expressCheckout' }) => any
    ): StripeCheckoutExpressCheckoutElement;
    off(
        eventType: 'cancel',
        handler?: (event: { elementType: 'expressCheckout' }) => any
    ): StripeCheckoutExpressCheckoutElement;

    /**
     * Updates the options the `ExpressCheckoutElement` was initialized with.
     * Updates are merged into the existing configuration.
     */
    update: StripeExpressCheckoutElement['update'];
};

type StripeCheckoutExpressCheckoutElementOptions

type StripeCheckoutExpressCheckoutElementOptions = {
    buttonHeight: StripeExpressCheckoutElementOptions['buttonHeight'];
    buttonTheme: StripeExpressCheckoutElementOptions['buttonTheme'];
    buttonType: StripeExpressCheckoutElementOptions['buttonType'];
    layout: StripeExpressCheckoutElementOptions['layout'];
    paymentMethodOrder: StripeExpressCheckoutElementOptions['paymentMethodOrder'];
    paymentMethods: StripeExpressCheckoutElementOptions['paymentMethods'];
};

type StripeCheckoutLastPaymentError

type StripeCheckoutLastPaymentError = {
    message: string;
};

type StripeCheckoutLineItem

type StripeCheckoutLineItem = {
    id: string;
    name: string;
    discount: StripeCheckoutAmount;
    subtotal: StripeCheckoutAmount;
    total: StripeCheckoutAmount;
    taxExclusive: StripeCheckoutAmount;
    taxInclusive: StripeCheckoutAmount;
    unitAmount: StripeCheckoutAmount;
    description: string | null;
    quantity: number;
    discountAmounts: Array<StripeCheckoutDiscountAmount> | null;
    taxAmounts: Array<StripeCheckoutTaxAmount> | null;
    recurring: {
        interval: StripeCheckoutBillingInterval;
        intervalCount: number;
        isProrated: boolean;
        usageType: 'metered' | 'licensed';
    } | null;
    adjustableQuantity: StripeCheckoutAdjustableQuantity | null;
    images: string[];
};

type StripeCheckoutLoadActionsResult

type StripeCheckoutLoadActionsResult =
    | { type: 'success'; actions: LoadActionsSuccess }
    | { type: 'error'; error: LoadActionsError };

type StripeCheckoutPaymentElementOptions

type StripeCheckoutPaymentElementOptions = {
    layout?: Layout | LayoutObject;
    paymentMethodOrder?: Array<string>;
    readOnly?: boolean;
    terms?: TermsOption;
    fields?: FieldsOption;
};

type StripeCheckoutRecurring

type StripeCheckoutRecurring = {
    interval: StripeCheckoutBillingInterval;
    intervalCount: number;
    dueNext: StripeCheckoutDueNext;
    trial: StripeCheckoutTrial | null;
};

type StripeCheckoutRedirectBehavior

type StripeCheckoutRedirectBehavior = 'always' | 'if_required';

type StripeCheckoutRemovePromotionCodeResult

type StripeCheckoutRemovePromotionCodeResult =
    | { type: 'success'; session: StripeCheckoutSession }
    | { type: 'error'; error: AnyBuyerError };

type StripeCheckoutRunServerUpdateResult

type StripeCheckoutRunServerUpdateResult =
    | { type: 'success'; session: StripeCheckoutSession }
    | { type: 'error'; error: AnyBuyerError };

type StripeCheckoutSavedPaymentMethod

type StripeCheckoutSavedPaymentMethod = {
    id: string;
    type: 'card';
    card: {
        brand: string;
        expMonth: number;
        expYear: number;
        last4: string;
    };
    billingDetails: {
        email?: string | null;
        name?: string | null;
        phone?: string | null;
        address?: {
            line1?: string | null;
            line2?: string | null;
            city?: string | null;
            postal_code?: string | null;
            state?: string | null;
            country?: string | null;
        } | null;
    };
};

type StripeCheckoutShipping

type StripeCheckoutShipping = {
    shippingOption: StripeCheckoutShippingOption;
    taxAmounts: Array<StripeCheckoutTaxAmount> | null;
};

type StripeCheckoutShippingOption

type StripeCheckoutShippingOption = StripeCheckoutAmount & {
    id: string;
    currency: string;
    displayName: string | null;
    deliveryEstimate: StripeCheckoutDeliveryEstimate | null;
};

type StripeCheckoutStatus

type StripeCheckoutStatus =
    | { type: 'open' }
    | { type: 'expired' }
    | {
          type: 'complete';
          paymentStatus: 'paid' | 'unpaid' | 'no_payment_required';
      };

type StripeCheckoutTaxAmount

type StripeCheckoutTaxAmount = StripeCheckoutAmount & {
    inclusive: boolean;
    displayName: string;
};

type StripeCheckoutTaxId

type StripeCheckoutTaxId = {
    type: StripeCheckoutTaxIdType;
    value: string;
};

type StripeCheckoutTaxIdInfo

type StripeCheckoutTaxIdInfo = {
    taxId: StripeCheckoutTaxId;
    businessName: string;
};

type StripeCheckoutTaxIdType

type StripeCheckoutTaxIdType =
    | 'ad_nrt'
    | 'ae_trn'
    | 'al_tin'
    | 'am_tin'
    | 'ao_tin'
    | 'ar_cuit'
    | 'au_abn'
    | 'au_arn'
    | 'ba_tin'
    | 'bb_tin'
    | 'bg_uic'
    | 'bh_vat'
    | 'bo_tin'
    | 'br_cnpj'
    | 'br_cpf'
    | 'bs_tin'
    | 'by_tin'
    | 'ca_bn'
    | 'ca_gst_hst'
    | 'ca_pst_bc'
    | 'ca_pst_mb'
    | 'ca_pst_sk'
    | 'ca_qst'
    | 'cd_nif'
    | 'ch_uid'
    | 'ch_vat'
    | 'cl_tin'
    | 'cn_tin'
    | 'co_nit'
    | 'cr_tin'
    | 'de_stn'
    | 'do_rcn'
    | 'ec_ruc'
    | 'eg_tin'
    | 'es_cif'
    | 'eu_oss_vat'
    | 'eu_vat'
    | 'gb_vat'
    | 'ge_vat'
    | 'gn_nif'
    | 'hk_br'
    | 'hr_oib'
    | 'hu_tin'
    | 'id_npwp'
    | 'il_vat'
    | 'in_gst'
    | 'is_vat'
    | 'jp_cn'
    | 'jp_rn'
    | 'jp_trn'
    | 'ke_pin'
    | 'kh_tin'
    | 'kr_brn'
    | 'kz_bin'
    | 'li_uid'
    | 'li_vat'
    | 'ma_vat'
    | 'md_vat'
    | 'me_pib'
    | 'mk_vat'
    | 'mr_nif'
    | 'mx_rfc'
    | 'my_frp'
    | 'my_itn'
    | 'my_sst'
    | 'ng_tin'
    | 'no_vat'
    | 'no_voec'
    | 'np_pan'
    | 'nz_gst'
    | 'om_vat'
    | 'pe_ruc'
    | 'ph_tin'
    | 'ro_tin'
    | 'rs_pib'
    | 'ru_inn'
    | 'ru_kpp'
    | 'sa_vat'
    | 'sg_gst'
    | 'sg_uen'
    | 'si_tin'
    | 'sn_ninea'
    | 'sr_fin'
    | 'sv_nit'
    | 'th_vat'
    | 'tj_tin'
    | 'tr_tin'
    | 'tw_vat'
    | 'tz_vat'
    | 'ua_vat'
    | 'ug_tin'
    | 'us_ein'
    | 'uy_ruc'
    | 'uz_tin'
    | 'uz_vat'
    | 've_rif'
    | 'vn_tin'
    | 'za_vat'
    | 'zm_tin'
    | 'zw_tin';

type StripeCheckoutTaxStatus

type StripeCheckoutTaxStatus =
    | { status: 'ready' }
    | { status: 'requires_shipping_address' }
    | { status: 'requires_billing_address' };

type StripeCheckoutTotalSummary

type StripeCheckoutTotalSummary = {
    appliedBalance: StripeCheckoutAmount;
    balanceAppliedToNextInvoice: boolean;
    discount: StripeCheckoutAmount;
    shippingRate: StripeCheckoutAmount;
    subtotal: StripeCheckoutAmount;
    taxExclusive: StripeCheckoutAmount;
    taxInclusive: StripeCheckoutAmount;
    total: StripeCheckoutAmount;
};

type StripeCheckoutTrial

type StripeCheckoutTrial = {
    trialEnd: number;
    trialPeriodDays: number;
};

type StripeCheckoutUpdateAddressResult

type StripeCheckoutUpdateAddressResult =
    | { type: 'success'; session: StripeCheckoutSession }
    | { type: 'error'; error: AnyBuyerError };

type StripeCheckoutUpdateEmailResult

type StripeCheckoutUpdateEmailResult =
    | { type: 'success'; session: StripeCheckoutSession }
    | { type: 'error'; error: UpdateEmailError };

type StripeCheckoutUpdateHandler

type StripeCheckoutUpdateHandler = (session: StripeCheckoutSession) => void;

type StripeCheckoutUpdateLineItemQuantityResult

type StripeCheckoutUpdateLineItemQuantityResult =
    | { type: 'success'; session: StripeCheckoutSession }
    | { type: 'error'; error: AnyBuyerError };

type StripeCheckoutUpdatePhoneNumberResult

type StripeCheckoutUpdatePhoneNumberResult =
    | { type: 'success'; session: StripeCheckoutSession }
    | { type: 'error'; error: never };

type StripeCheckoutUpdateShippingOptionResult

type StripeCheckoutUpdateShippingOptionResult =
    | { type: 'success'; session: StripeCheckoutSession }
    | { type: 'error'; error: AnyBuyerError };

type StripeCheckoutUpdateTaxIdInfoResult

type StripeCheckoutUpdateTaxIdInfoResult =
    | { type: 'success'; session: StripeCheckoutSession }
    | { type: 'error'; error: UpdateTaxIdInfoError };

type StripeCurrencySelectorElement

type StripeCurrencySelectorElement = StripeElementBase & {
    /**
     * Triggered when the element is fully rendered and can accept `element.focus` calls.
     */
    on(
        eventType: 'ready',
        handler: (event: { elementType: 'currencySelector' }) => any
    ): StripeCurrencySelectorElement;
    once(
        eventType: 'ready',
        handler: (event: { elementType: 'currencySelector' }) => any
    ): StripeCurrencySelectorElement;
    off(
        eventType: 'ready',
        handler?: (event: { elementType: 'currencySelector' }) => any
    ): StripeCurrencySelectorElement;

    /**
     * Triggered when the element gains focus.
     */
    on(
        eventType: 'focus',
        handler: (event: { elementType: 'currencySelector' }) => any
    ): StripeCurrencySelectorElement;
    once(
        eventType: 'focus',
        handler: (event: { elementType: 'currencySelector' }) => any
    ): StripeCurrencySelectorElement;
    off(
        eventType: 'focus',
        handler?: (event: { elementType: 'currencySelector' }) => any
    ): StripeCurrencySelectorElement;

    /**
     * Triggered when the element loses focus.
     */
    on(
        eventType: 'blur',
        handler: (event: { elementType: 'currencySelector' }) => any
    ): StripeCurrencySelectorElement;
    once(
        eventType: 'blur',
        handler: (event: { elementType: 'currencySelector' }) => any
    ): StripeCurrencySelectorElement;
    off(
        eventType: 'blur',
        handler?: (event: { elementType: 'currencySelector' }) => any
    ): StripeCurrencySelectorElement;

    /**
     * Triggered when the escape key is pressed within the element.
     */
    on(
        eventType: 'escape',
        handler: (event: { elementType: 'currencySelector' }) => any
    ): StripeCurrencySelectorElement;
    once(
        eventType: 'escape',
        handler: (event: { elementType: 'currencySelector' }) => any
    ): StripeCurrencySelectorElement;
    off(
        eventType: 'escape',
        handler?: (event: { elementType: 'currencySelector' }) => any
    ): StripeCurrencySelectorElement;

    /**
     * Triggered when the element fails to load.
     */
    on(
        eventType: 'loaderror',
        handler: (event: {
            elementType: 'currencySelector';
            error: StripeError;
        }) => any
    ): StripeCurrencySelectorElement;
    once(
        eventType: 'loaderror',
        handler: (event: {
            elementType: 'currencySelector';
            error: StripeError;
        }) => any
    ): StripeCurrencySelectorElement;
    off(
        eventType: 'loaderror',
        handler?: (event: {
            elementType: 'currencySelector';
            error: StripeError;
        }) => any
    ): StripeCurrencySelectorElement;
};

type StripeElement

type StripeElement =
    | StripeAddressElement
    | StripeAuBankAccountElement
    | StripeCardElement
    | StripeCardNumberElement
    | StripeCardExpiryElement
    | StripeCardCvcElement
    | StripeIbanElement
    | StripeCurrencySelectorElement
    | StripeExpressCheckoutElement
    | StripePaymentElement
    | StripePaymentMethodMessagingElement
    | StripePaymentRequestButtonElement
    | StripeIssuingCardNumberDisplayElement
    | StripeIssuingCardCvcDisplayElement
    | StripeIssuingCardExpiryDisplayElement
    | StripeIssuingCardPinDisplayElement
    | StripeIssuingCardCopyButtonElement
    | StripeShippingAddressElement
    | StripeTaxIdElement;

type StripeElementBase

type StripeElementBase = {
    /**
     * The `element.mount` method attaches your [Element](https://stripe.com/docs/js/element) to the DOM.
     * `element.mount` accepts either a CSS Selector (e.g., `'#card-element'`) or a DOM element.
     *
     * You need to create a container DOM element to mount an `Element`.
     * If the container DOM element has a label, the `Element` is automatically focused when its label is clicked.
     * There are two ways to do this:
     *
     * 1. Mount the instance within a `<label>`.
     * 2. Create a `<label>` with a `for` attribute, referencing the ID of your container.
     */
    mount(domElement: string | HTMLElement): void;

    /**
     * Blurs the element.
     */
    blur(): void;

    /**
     * Clears the value(s) of the element.
     */
    clear(): void;

    /**
     * Removes the element from the DOM and destroys it.
     * A destroyed element can not be re-activated or re-mounted to the DOM.
     */
    destroy(): void;

    /**
     * Focuses the element.
     */
    focus(): void;

    /**
     * Unmounts the element from the DOM.
     * Call `element.mount` to re-attach it to the DOM.
     */
    unmount(): void;
};

type StripeElementLocale

type StripeElementLocale =
    | 'auto'
    | 'ar'
    | 'bg'
    | 'cs'
    | 'da'
    | 'de'
    | 'el'
    | 'en'
    | 'en-AU'
    | 'en-CA'
    | 'en-NZ'
    | 'en-GB'
    | 'es'
    | 'es-ES'
    | 'es-419'
    | 'et'
    | 'fi'
    | 'fil'
    | 'fr'
    | 'fr-CA'
    | 'fr-FR'
    | 'he'
    | 'hu'
    | 'hr'
    | 'id'
    | 'it'
    | 'it-IT'
    | 'ja'
    | 'ko'
    | 'lt'
    | 'lv'
    | 'ms'
    | 'mt'
    | 'nb'
    | 'nl'
    | 'no'
    | 'pl'
    | 'pt'
    | 'pt-BR'
    | 'ro'
    | 'ru'
    | 'sk'
    | 'sl'
    | 'sv'
    | 'th'
    | 'tr'
    | 'vi'
    | 'zh'
    | 'zh-HK'
    | 'zh-TW';

type StripeElementsOptions

type StripeElementsOptions =
    | StripeElementsOptionsClientSecret
    | StripeElementsOptionsMode;

type StripeElementsOptionsMode

type StripeElementsOptionsMode =
    | StripeElementsOptionsModePayment
    | StripeElementsOptionsModeSubscription
    | StripeElementsOptionsModeSetup;

type StripeElementsOptionsModePayment

type StripeElementsOptionsModePayment = StripeElementsOptionsModeBase & {
    mode: 'payment';

    /**
     * The amount to be charged. Shown in Apple Pay, Google Pay, or Buy now pay later UIs, and influences available payment methods.
     */
    amount: number;
    /**
     * Three character currency code (e.g., usd).
     */
    currency: string;
};

type StripeElementsOptionsModeSetup

type StripeElementsOptionsModeSetup = StripeElementsOptionsModeBase & {
    mode: 'setup';
    /**
     * Three character currency code (e.g., usd).
     *
     * Required when creating SetupIntents with dynamic payment methods.
     * Payment Element renders the payment methods enabled in the Stripe Dashboard that support the provided currency.
     */
    currency?: string;
};

type StripeElementsOptionsModeSubscription

type StripeElementsOptionsModeSubscription = StripeElementsOptionsModeBase & {
    mode: 'subscription';

    /**
     * The amount to be charged. Shown in Apple Pay, Google Pay, or Buy now pay later UIs, and influences available payment methods.
     */
    amount: number;
    /**
     * Three character currency code (e.g., usd).
     */
    currency: string;
};

type StripeElementType

type StripeElementType =
    | 'address'
    | 'auBankAccount'
    | 'card'
    | 'cardNumber'
    | 'cardExpiry'
    | 'cardCvc'
    | 'currencySelector'
    | 'expressCheckout'
    | 'iban'
    | 'payment'
    | 'paymentMethodMessaging'
    | 'paymentRequestButton'
    | 'linkAuthentication'
    | 'shippingAddress'
    | 'issuingCardNumberDisplay'
    | 'issuingCardCvcDisplay'
    | 'issuingCardExpiryDisplay'
    | 'issuingCardPinDisplay'
    | 'issuingCardCopyButton'
    | 'taxId'
    | 'issuingAddToWalletButton';

type StripeEmbeddedCheckoutAddress

type StripeEmbeddedCheckoutAddress = {
    country: string;
    line1?: string | null;
    line2?: string | null;
    city?: string | null;
    postal_code?: string | null;
    state?: string | null;
};

type StripeEmbeddedCheckoutLineItem

type StripeEmbeddedCheckoutLineItem = {
    id?: string;
    quantity?: number;
    price?: string;
    display?: {
        name?: string;
        description?: string;
        images?: string[];
    };
    pricingSpec?: {
        unitAmount?: number;
        unitAmountDecimal?: string;
        currency?: string;
        taxBehavior?: 'inclusive' | 'exclusive' | 'unspecified';
        taxCode?: string;
    };
};

type StripeEmbeddedCheckoutLineItemsChangeEvent

type StripeEmbeddedCheckoutLineItemsChangeEvent = {
    checkoutSessionId: string;
    lineItems: StripeEmbeddedCheckoutLineItem[];
};

type StripeEmbeddedCheckoutShippingDetails

type StripeEmbeddedCheckoutShippingDetails = {
    name: string;
    address: StripeEmbeddedCheckoutAddress;
};

type StripeEmbeddedCheckoutShippingDetailsChangeEvent

type StripeEmbeddedCheckoutShippingDetailsChangeEvent = {
    checkoutSessionId: string;
    shippingDetails: StripeEmbeddedCheckoutShippingDetails;
};

type StripeErrorType

type StripeErrorType =
    /**
     * Failure to connect to Stripe's API.
     */
    | 'api_connection_error'

    /**
     * API errors cover any other type of problem (e.g., a temporary problem with Stripe's servers), and are extremely uncommon.
     */
    | 'api_error'

    /**
     * Failure to properly authenticate yourself in the request.
     */
    | 'authentication_error'

    /**
     * Card errors are the most common type of error you should expect to handle.
     * They result when the user enters a card that can't be charged for some reason.
     */
    | 'card_error'

    /**
     * Idempotency errors occur when an `Idempotency-Key` is re-used on a request that does not match the first request's API endpoint and parameters.
     */
    | 'idempotency_error'

    /**
     * Invalid request errors arise when your request has invalid parameters.
     */
    | 'invalid_request_error'

    /**
     * Too many requests hit the API too quickly.
     */
    | 'rate_limit_error'

    /**
     * Errors triggered by our client-side libraries when failing to validate fields (e.g., when a card number or expiration date is invalid or incomplete).
     */
    | 'validation_error';

type StripeExpressCheckoutElement

type StripeExpressCheckoutElement = StripeElementBase & {
    /**
     * Triggered when the element is fully rendered and can accept `element.focus` calls.
     */
    on(
        eventType: 'ready',
        handler: (event: StripeExpressCheckoutElementReadyEvent) => any
    ): StripeExpressCheckoutElement;
    once(
        eventType: 'ready',
        handler: (event: StripeExpressCheckoutElementReadyEvent) => any
    ): StripeExpressCheckoutElement;
    off(
        eventType: 'ready',
        handler?: (event: StripeExpressCheckoutElementReadyEvent) => any
    ): StripeExpressCheckoutElement;

    /**
     * Triggered when a button on the element is clicked.
     */
    on(
        eventType: 'click',
        handler: (event: StripeExpressCheckoutElementClickEvent) => any
    ): StripeExpressCheckoutElement;
    once(
        eventType: 'click',
        handler: (event: StripeExpressCheckoutElementClickEvent) => any
    ): StripeExpressCheckoutElement;
    off(
        eventType: 'click',
        handler?: (event: StripeExpressCheckoutElementClickEvent) => any
    ): StripeExpressCheckoutElement;

    /**
     * Triggered when the element gains focus.
     */
    on(
        eventType: 'focus',
        handler: (event: { elementType: 'expressCheckout' }) => any
    ): StripeExpressCheckoutElement;
    once(
        eventType: 'focus',
        handler: (event: { elementType: 'expressCheckout' }) => any
    ): StripeExpressCheckoutElement;
    off(
        eventType: 'focus',
        handler?: (event: { elementType: 'expressCheckout' }) => any
    ): StripeExpressCheckoutElement;

    /**
     * Triggered when the element loses focus.
     */
    on(
        eventType: 'blur',
        handler: (event: { elementType: 'expressCheckout' }) => any
    ): StripeExpressCheckoutElement;
    once(
        eventType: 'blur',
        handler: (event: { elementType: 'expressCheckout' }) => any
    ): StripeExpressCheckoutElement;
    off(
        eventType: 'blur',
        handler?: (event: { elementType: 'expressCheckout' }) => any
    ): StripeExpressCheckoutElement;

    /**
     * Triggered when the escape key is pressed within the element.
     */
    on(
        eventType: 'escape',
        handler: (event: { elementType: 'expressCheckout' }) => any
    ): StripeExpressCheckoutElement;
    once(
        eventType: 'escape',
        handler: (event: { elementType: 'expressCheckout' }) => any
    ): StripeExpressCheckoutElement;
    off(
        eventType: 'escape',
        handler?: (event: { elementType: 'expressCheckout' }) => any
    ): StripeExpressCheckoutElement;

    /**
     * Triggered when the element fails to load.
     */
    on(
        eventType: 'loaderror',
        handler: (event: {
            elementType: 'expressCheckout';
            error: StripeError;
        }) => any
    ): StripeExpressCheckoutElement;
    once(
        eventType: 'loaderror',
        handler: (event: {
            elementType: 'expressCheckout';
            error: StripeError;
        }) => any
    ): StripeExpressCheckoutElement;
    off(
        eventType: 'loaderror',
        handler?: (event: {
            elementType: 'expressCheckout';
            error: StripeError;
        }) => any
    ): StripeExpressCheckoutElement;

    /**
     * Triggered when a buyer authorizes a payment within a supported payment method.
     */
    on(
        eventType: 'confirm',
        handler: (event: StripeExpressCheckoutElementConfirmEvent) => any
    ): StripeExpressCheckoutElement;
    once(
        eventType: 'confirm',
        handler: (event: StripeExpressCheckoutElementConfirmEvent) => any
    ): StripeExpressCheckoutElement;
    off(
        eventType: 'confirm',
        handler?: (event: StripeExpressCheckoutElementConfirmEvent) => any
    ): StripeExpressCheckoutElement;

    /**
     * Triggered when a payment interface is dismissed (e.g., a buyer closes the payment interface)
     */
    on(
        eventType: 'cancel',
        handler: (event: { elementType: 'expressCheckout' }) => any
    ): StripeExpressCheckoutElement;
    once(
        eventType: 'cancel',
        handler: (event: { elementType: 'expressCheckout' }) => any
    ): StripeExpressCheckoutElement;
    off(
        eventType: 'cancel',
        handler?: (event: { elementType: 'expressCheckout' }) => any
    ): StripeExpressCheckoutElement;

    /**
     * Triggered when a buyer selects a different shipping address.
     */
    on(
        eventType: 'shippingaddresschange',
        handler: (
            event: StripeExpressCheckoutElementShippingAddressChangeEvent
        ) => any
    ): StripeExpressCheckoutElement;
    once(
        eventType: 'shippingaddresschange',
        handler: (
            event: StripeExpressCheckoutElementShippingAddressChangeEvent
        ) => any
    ): StripeExpressCheckoutElement;
    off(
        eventType: 'shippingaddresschange',
        handler?: (
            event: StripeExpressCheckoutElementShippingAddressChangeEvent
        ) => any
    ): StripeExpressCheckoutElement;

    /**
     * Triggered when a buyer selects a different shipping rate.
     */
    on(
        eventType: 'shippingratechange',
        handler: (event: StripeExpressCheckoutElementShippingRateChangeEvent) => any
    ): StripeExpressCheckoutElement;
    once(
        eventType: 'shippingratechange',
        handler: (event: StripeExpressCheckoutElementShippingRateChangeEvent) => any
    ): StripeExpressCheckoutElement;
    off(
        eventType: 'shippingratechange',
        handler?: (event: StripeExpressCheckoutElementShippingRateChangeEvent) => any
    ): StripeExpressCheckoutElement;

    /**
     * Updates the options the `ExpressCheckoutElement` was initialized with.
     * Updates are merged into the existing configuration.
     */
    update(
        options: StripeExpressCheckoutElementUpdateOptions
    ): StripeExpressCheckoutElement;
};

type StripeIbanElement

type StripeIbanElement = StripeElementBase & {
    /**
     * The change event is triggered when the `Element`'s value changes.
     */
    on(
        eventType: 'change',
        handler: (event: StripeIbanElementChangeEvent) => any
    ): StripeIbanElement;
    once(
        eventType: 'change',
        handler: (event: StripeIbanElementChangeEvent) => any
    ): StripeIbanElement;
    off(
        eventType: 'change',
        handler?: (event: StripeIbanElementChangeEvent) => any
    ): StripeIbanElement;

    /**
     * Triggered when the element is fully rendered and can accept `element.focus` calls.
     */
    on(
        eventType: 'ready',
        handler: (event: { elementType: 'iban' }) => any
    ): StripeIbanElement;
    once(
        eventType: 'ready',
        handler: (event: { elementType: 'iban' }) => any
    ): StripeIbanElement;
    off(
        eventType: 'ready',
        handler?: (event: { elementType: 'iban' }) => any
    ): StripeIbanElement;

    /**
     * Triggered when the element gains focus.
     */
    on(
        eventType: 'focus',
        handler: (event: { elementType: 'iban' }) => any
    ): StripeIbanElement;
    once(
        eventType: 'focus',
        handler: (event: { elementType: 'iban' }) => any
    ): StripeIbanElement;
    off(
        eventType: 'focus',
        handler?: (event: { elementType: 'iban' }) => any
    ): StripeIbanElement;

    /**
     * Triggered when the element loses focus.
     */
    on(
        eventType: 'blur',
        handler: (event: { elementType: 'iban' }) => any
    ): StripeIbanElement;
    once(
        eventType: 'blur',
        handler: (event: { elementType: 'iban' }) => any
    ): StripeIbanElement;
    off(
        eventType: 'blur',
        handler?: (event: { elementType: 'iban' }) => any
    ): StripeIbanElement;

    /**
     * Triggered when the escape key is pressed within the element.
     */
    on(
        eventType: 'escape',
        handler: (event: { elementType: 'iban' }) => any
    ): StripeIbanElement;
    once(
        eventType: 'escape',
        handler: (event: { elementType: 'iban' }) => any
    ): StripeIbanElement;
    off(
        eventType: 'escape',
        handler?: (event: { elementType: 'iban' }) => any
    ): StripeIbanElement;

    /**
     * Updates the options the `IbanElement` was initialized with.
     * Updates are merged into the existing configuration.
     *
     * The styles of an `IbanElement` can be dynamically changed using `element.update`.
     * This method can be used to simulate CSS media queries that automatically adjust the size of elements when viewed on different devices.
     */
    update(options: Partial<StripeIbanElementOptions>): void;
};

type StripeIssuingAddToWalletButtonElement

type StripeIssuingAddToWalletButtonElement = StripeElementBase & {
    /**
     * Triggered when the element is clicked.
     */
    on(
        eventType: 'click',
        handler: (event: { elementType: 'issuingAddToWalletButton' }) => any
    ): StripeIssuingAddToWalletButtonElement;
    once(
        eventType: 'click',
        handler: (event: { elementType: 'issuingAddToWalletButton' }) => any
    ): StripeIssuingAddToWalletButtonElement;
    off(
        eventType: 'click',
        handler?: (event: { elementType: 'issuingAddToWalletButton' }) => any
    ): StripeIssuingAddToWalletButtonElement;

    /**
     * Triggered when add to wallet flow is complete.
     */
    on(
        eventType: 'success',
        handler: (event: { elementType: 'issuingAddToWalletButton' }) => any
    ): StripeIssuingAddToWalletButtonElement;
    once(
        eventType: 'success',
        handler: (event: { elementType: 'issuingAddToWalletButton' }) => any
    ): StripeIssuingAddToWalletButtonElement;
    off(
        eventType: 'success',
        handler?: (event: { elementType: 'issuingAddToWalletButton' }) => any
    ): StripeIssuingAddToWalletButtonElement;

    /**
     * Updates the options the `IssuingAddToWalletButtonElement` was initialized with.
     * Updates are merged into the existing configuration.
     */
    update(options: Partial<StripeIssuingAddToWalletButtonElementOptions>): void;
};

type StripeIssuingCardCopyButtonElement

type StripeIssuingCardCopyButtonElement = StripeElementBase & {
    /**
     * Triggered when the element is clicked.
     */
    on(
        eventType: 'click',
        handler: (event: { elementType: 'issuingCardCopyButton' }) => any
    ): StripeIssuingCardCopyButtonElement;
    once(
        eventType: 'click',
        handler: (event: { elementType: 'issuingCardCopyButton' }) => any
    ): StripeIssuingCardCopyButtonElement;
    off(
        eventType: 'click',
        handler?: (event: { elementType: 'issuingCardCopyButton' }) => any
    ): StripeIssuingCardCopyButtonElement;

    /**
     * Updates the options the `IssuingCardCopyButtonElement` was initialized with.
     * Updates are merged into the existing configuration.
     *
     * The styles of an `IssuingCardCopyButtonElement` can be dynamically changed using `element.update`.
     * This method can be used to simulate CSS media queries that automatically adjust the size of elements when viewed on different devices.
     */
    update(options: Partial<StripeIssuingCardCopyButtonElementOptions>): void;
};

type StripeIssuingCardCvcDisplayElement

type StripeIssuingCardCvcDisplayElement = StripeElementBase & {
    /**
     * Updates the options the `IssuingCardCvcDisplayElement` was initialized with.
     * Updates are merged into the existing configuration.
     *
     * The styles of an `IssuingCardCvcDisplayElement` can be dynamically changed using `element.update`.
     * This method can be used to simulate CSS media queries that automatically adjust the size of elements when viewed on different devices.
     */
    update(options: Partial<StripeIssuingCardCvcDisplayElementOptions>): void;
};

type StripeIssuingCardExpiryDisplayElement

type StripeIssuingCardExpiryDisplayElement = StripeElementBase & {
    /**
     * Updates the options the `IssuingCardExpiryDisplayElement` was initialized with.
     * Updates are merged into the existing configuration.
     *
     * The styles of an `IssuingCardExpiryDisplayElement` can be dynamically changed using `element.update`.
     * This method can be used to simulate CSS media queries that automatically adjust the size of elements when viewed on different devices.
     */
    update(options: Partial<StripeIssuingCardExpiryDisplayElementOptions>): void;
};

type StripeIssuingCardNumberDisplayElement

type StripeIssuingCardNumberDisplayElement = StripeElementBase & {
    /**
     * Updates the options the `IssuingCardNumberDisplayElement` was initialized with.
     * Updates are merged into the existing configuration.
     *
     * The styles of an `IssuingCardNumberDisplayElement` can be dynamically changed using `element.update`.
     * This method can be used to simulate CSS media queries that automatically adjust the size of elements when viewed on different devices.
     */
    update(options: Partial<StripeIssuingCardNumberDisplayElementOptions>): void;

    /**
     * Triggered when the element is fully rendered and can accept `element.focus` calls.
     */
    on(
        eventType: 'ready',
        handler: (event: { elementType: 'issuingCardNumberDisplay' }) => any
    ): StripeIssuingCardNumberDisplayElement;
};

type StripeIssuingCardPinDisplayElement

type StripeIssuingCardPinDisplayElement = StripeElementBase & {
    /**
     * Updates the options the `IssuingCardPinDisplayElement` was initialized with.
     * Updates are merged into the existing configuration.
     *
     * The styles of an `IssuingCardPinDisplayElement` can be dynamically changed using `element.update`.
     * This method can be used to simulate CSS media queries that automatically adjust the size of elements when viewed on different devices.
     */
    update(options: Partial<StripeIssuingCardPinDisplayElementOptions>): void;
};

type StripeLinkAuthenticationElement

type StripeLinkAuthenticationElement = StripeElementBase & {
    /**
     * The change event is triggered when the `Element`'s value changes.
     */
    on(
        eventType: 'change',
        handler: (event: StripeLinkAuthenticationElementChangeEvent) => any
    ): StripeLinkAuthenticationElement;
    once(
        eventType: 'change',
        handler: (event: StripeLinkAuthenticationElementChangeEvent) => any
    ): StripeLinkAuthenticationElement;
    off(
        eventType: 'change',
        handler?: (event: StripeLinkAuthenticationElementChangeEvent) => any
    ): StripeLinkAuthenticationElement;

    /**
     * Triggered when the element is fully rendered and can accept `element.focus` calls.
     */
    on(
        eventType: 'ready',
        handler: (event: { elementType: 'linkAuthentication' }) => any
    ): StripeLinkAuthenticationElement;
    once(
        eventType: 'ready',
        handler: (event: { elementType: 'linkAuthentication' }) => any
    ): StripeLinkAuthenticationElement;
    off(
        eventType: 'ready',
        handler?: (event: { elementType: 'linkAuthentication' }) => any
    ): StripeLinkAuthenticationElement;

    /**
     * Triggered when the element gains focus.
     */
    on(
        eventType: 'focus',
        handler: (event: { elementType: 'linkAuthentication' }) => any
    ): StripeLinkAuthenticationElement;
    once(
        eventType: 'focus',
        handler: (event: { elementType: 'linkAuthentication' }) => any
    ): StripeLinkAuthenticationElement;
    off(
        eventType: 'focus',
        handler?: (event: { elementType: 'linkAuthentication' }) => any
    ): StripeLinkAuthenticationElement;

    /**
     * Triggered when the element loses focus.
     */
    on(
        eventType: 'blur',
        handler: (event: { elementType: 'linkAuthentication' }) => any
    ): StripeLinkAuthenticationElement;
    once(
        eventType: 'blur',
        handler: (event: { elementType: 'linkAuthentication' }) => any
    ): StripeLinkAuthenticationElement;
    off(
        eventType: 'blur',
        handler?: (event: { elementType: 'linkAuthentication' }) => any
    ): StripeLinkAuthenticationElement;

    /**
     * Triggered when the escape key is pressed within the element.
     */
    on(
        eventType: 'escape',
        handler: (event: { elementType: 'linkAuthentication' }) => any
    ): StripeLinkAuthenticationElement;
    once(
        eventType: 'escape',
        handler: (event: { elementType: 'linkAuthentication' }) => any
    ): StripeLinkAuthenticationElement;
    off(
        eventType: 'escape',
        handler?: (event: { elementType: 'linkAuthentication' }) => any
    ): StripeLinkAuthenticationElement;

    /**
     * Triggered when the element fails to load.
     */
    on(
        eventType: 'loaderror',
        handler: (event: {
            elementType: 'linkAuthentication';
            error: StripeError;
        }) => any
    ): StripeLinkAuthenticationElement;
    once(
        eventType: 'loaderror',
        handler: (event: {
            elementType: 'linkAuthentication';
            error: StripeError;
        }) => any
    ): StripeLinkAuthenticationElement;
    off(
        eventType: 'loaderror',
        handler?: (event: {
            elementType: 'linkAuthentication';
            error: StripeError;
        }) => any
    ): StripeLinkAuthenticationElement;

    /**
     * Triggered when the loader UI is mounted to the DOM and ready to be displayed.
     */
    on(
        eventType: 'loaderstart',
        handler: (event: { elementType: 'linkAuthentication' }) => any
    ): StripeLinkAuthenticationElement;
    once(
        eventType: 'loaderstart',
        handler: (event: { elementType: 'linkAuthentication' }) => any
    ): StripeLinkAuthenticationElement;
    off(
        eventType: 'loaderstart',
        handler?: (event: { elementType: 'linkAuthentication' }) => any
    ): StripeLinkAuthenticationElement;
};

type StripePaymentElement

type StripePaymentElement = StripeElementBase & {
    /**
     * The change event is triggered when the `Element`'s value changes.
     */
    on(
        eventType: 'change',
        handler: (event: StripePaymentElementChangeEvent) => any
    ): StripePaymentElement;
    once(
        eventType: 'change',
        handler: (event: StripePaymentElementChangeEvent) => any
    ): StripePaymentElement;
    off(
        eventType: 'change',
        handler?: (event: StripePaymentElementChangeEvent) => any
    ): StripePaymentElement;

    /**
     * Triggered when the element is fully rendered and can accept `element.focus` calls.
     */
    on(
        eventType: 'ready',
        handler: (event: { elementType: 'payment' }) => any
    ): StripePaymentElement;
    once(
        eventType: 'ready',
        handler: (event: { elementType: 'payment' }) => any
    ): StripePaymentElement;
    off(
        eventType: 'ready',
        handler?: (event: { elementType: 'payment' }) => any
    ): StripePaymentElement;

    /**
     * Triggered when the element gains focus.
     */
    on(
        eventType: 'focus',
        handler: (event: { elementType: 'payment' }) => any
    ): StripePaymentElement;
    once(
        eventType: 'focus',
        handler: (event: { elementType: 'payment' }) => any
    ): StripePaymentElement;
    off(
        eventType: 'focus',
        handler?: (event: { elementType: 'payment' }) => any
    ): StripePaymentElement;

    /**
     * Triggered when the element loses focus.
     */
    on(
        eventType: 'blur',
        handler: (event: { elementType: 'payment' }) => any
    ): StripePaymentElement;
    once(
        eventType: 'blur',
        handler: (event: { elementType: 'payment' }) => any
    ): StripePaymentElement;
    off(
        eventType: 'blur',
        handler?: (event: { elementType: 'payment' }) => any
    ): StripePaymentElement;

    /**
     * Triggered when the escape key is pressed within the element.
     */
    on(
        eventType: 'escape',
        handler: (event: { elementType: 'payment' }) => any
    ): StripePaymentElement;
    once(
        eventType: 'escape',
        handler: (event: { elementType: 'payment' }) => any
    ): StripePaymentElement;
    off(
        eventType: 'escape',
        handler?: (event: { elementType: 'payment' }) => any
    ): StripePaymentElement;

    /**
     * Triggered when the element fails to load.
     */
    on(
        eventType: 'loaderror',
        handler: (event: { elementType: 'payment'; error: StripeError }) => any
    ): StripePaymentElement;
    once(
        eventType: 'loaderror',
        handler: (event: { elementType: 'payment'; error: StripeError }) => any
    ): StripePaymentElement;
    off(
        eventType: 'loaderror',
        handler?: (event: { elementType: 'payment'; error: StripeError }) => any
    ): StripePaymentElement;

    /**
     * Triggered when the loader UI is mounted to the DOM and ready to be displayed.
     */
    on(
        eventType: 'loaderstart',
        handler: (event: { elementType: 'payment' }) => any
    ): StripePaymentElement;
    once(
        eventType: 'loaderstart',
        handler: (event: { elementType: 'payment' }) => any
    ): StripePaymentElement;
    off(
        eventType: 'loaderstart',
        handler?: (event: { elementType: 'payment' }) => any
    ): StripePaymentElement;

    /**
     * The change event is triggered when the `Element`'s value changes.
     * Represents the details of a selected Card payment method.
     */
    on(
        eventType: 'carddetailschange',
        handler: (event: StripePaymentElementCardDetailsChangeEvent) => any
    ): StripePaymentElement;

    /**
     * Triggered when a Saved Payment Method is updated.
     */
    on(
        eventType: 'savedpaymentmethodupdate',
        handler: (event: StripePaymentElementSavedPaymentMethodUpdateEvent) => any
    ): StripePaymentElement;

    /**
     * Triggered when a Saved Payment Method is removed.
     */
    on(
        eventType: 'savedpaymentmethodremove',
        handler: (event: StripePaymentElementSavedPaymentMethodRemoveEvent) => any
    ): StripePaymentElement;

    /**
     * Updates the options the `PaymentElement` was initialized with.
     * Updates are merged into the existing configuration.
     */
    update(options: Partial<StripePaymentElementOptions>): StripePaymentElement;

    /**
     * Collapses the Payment Element into a row of payment method tabs.
     */
    collapse(): StripePaymentElement;
};

type StripePaymentMethodMessagingElement

type StripePaymentMethodMessagingElement = {
    /**
     * The `element.mount` method attaches your [Element](https://stripe.com/docs/js/element) to the DOM.
     * `element.mount` accepts either a CSS Selector (e.g., `'#payment-method-messaging'`) or a DOM element.
     */
    mount(domElement: string | HTMLElement): void;

    /**
     * Removes the element from the DOM and destroys it.
     * A destroyed element can not be re-activated or re-mounted to the DOM.
     */
    destroy(): void;

    /**
     * Unmounts the element from the DOM.
     * Call `element.mount` to re-attach it to the DOM.
     */
    unmount(): void;

    /**
     * Updates the options the `PaymentMethodMessagingElement` was initialized with.
     * Updates are merged into the existing configuration.
     */
    update(options: Partial<StripePaymentMethodMessagingElementOptions>): void;

    /**
     * Triggered when the element is fully loaded and ready to perform method calls.
     */
    on(
        eventType: 'ready',
        handler: (event: { elementType: 'paymentMethodMessaging' }) => any
    ): StripePaymentMethodMessagingElement;
};

type StripePaymentRequestButtonElement

type StripePaymentRequestButtonElement = StripeElementBase & {
    /**
     * Triggered when the payment request button is clicked.
     */
    on(
        eventType: 'click',
        handler: (event: StripePaymentRequestButtonElementClickEvent) => any
    ): StripePaymentRequestButtonElement;
    once(
        eventType: 'click',
        handler: (event: StripePaymentRequestButtonElementClickEvent) => any
    ): StripePaymentRequestButtonElement;
    off(
        eventType: 'click',
        handler?: (event: StripePaymentRequestButtonElementClickEvent) => any
    ): StripePaymentRequestButtonElement;

    /**
     * Triggered when the element is fully rendered and can accept `element.focus` calls.
     */
    on(
        eventType: 'ready',
        handler: (event: { elementType: 'paymentRequestButton' }) => any
    ): StripePaymentRequestButtonElement;
    once(
        eventType: 'ready',
        handler: (event: { elementType: 'paymentRequestButton' }) => any
    ): StripePaymentRequestButtonElement;
    off(
        eventType: 'ready',
        handler?: (event: { elementType: 'paymentRequestButton' }) => any
    ): StripePaymentRequestButtonElement;

    /**
     * Triggered when the element gains focus.
     */
    on(
        eventType: 'focus',
        handler: (event: { elementType: 'paymentRequestButton' }) => any
    ): StripePaymentRequestButtonElement;
    once(
        eventType: 'focus',
        handler: (event: { elementType: 'paymentRequestButton' }) => any
    ): StripePaymentRequestButtonElement;
    off(
        eventType: 'focus',
        handler?: (event: { elementType: 'paymentRequestButton' }) => any
    ): StripePaymentRequestButtonElement;

    /**
     * Triggered when the element loses focus.
     */
    on(
        eventType: 'blur',
        handler: (event: { elementType: 'paymentRequestButton' }) => any
    ): StripePaymentRequestButtonElement;
    once(
        eventType: 'blur',
        handler: (event: { elementType: 'paymentRequestButton' }) => any
    ): StripePaymentRequestButtonElement;
    off(
        eventType: 'blur',
        handler?: (event: { elementType: 'paymentRequestButton' }) => any
    ): StripePaymentRequestButtonElement;

    /**
     * Updates the options the `PaymentRequestButtonElement` was initialized with.
     * Updates are merged into the existing configuration.
     *
     * The styles of an `PaymentRequestButtonElement` can be dynamically changed using `element.update`.
     * This method can be used to simulate CSS media queries that automatically adjust the size of elements when viewed on different devices.
     */
    update(
        options: Partial<
            Omit<StripePaymentRequestButtonElementOptions, 'paymentRequest'>
        >
    ): void;
};

type StripeShippingAddressElement

type StripeShippingAddressElement = StripeElementBase & {
    /**
     * The change event is triggered when the `Element`'s value changes.
     */
    on(
        eventType: 'change',
        handler: (event: StripeShippingAddressElementChangeEvent) => any
    ): StripeShippingAddressElement;
    once(
        eventType: 'change',
        handler: (event: StripeShippingAddressElementChangeEvent) => any
    ): StripeShippingAddressElement;
    off(
        eventType: 'change',
        handler?: (event: StripeShippingAddressElementChangeEvent) => any
    ): StripeShippingAddressElement;

    /**
     * Triggered when the element is fully rendered and can accept `element.focus` calls.
     */
    on(
        eventType: 'ready',
        handler: (event: { elementType: 'shippingAddress' }) => any
    ): StripeShippingAddressElement;
    once(
        eventType: 'ready',
        handler: (event: { elementType: 'shippingAddress' }) => any
    ): StripeShippingAddressElement;
    off(
        eventType: 'ready',
        handler?: (event: { elementType: 'shippingAddress' }) => any
    ): StripeShippingAddressElement;

    /**
     * Triggered when the element gains focus.
     */
    on(
        eventType: 'focus',
        handler: (event: { elementType: 'shippingAddress' }) => any
    ): StripeShippingAddressElement;
    once(
        eventType: 'focus',
        handler: (event: { elementType: 'shippingAddress' }) => any
    ): StripeShippingAddressElement;
    off(
        eventType: 'focus',
        handler?: (event: { elementType: 'shippingAddress' }) => any
    ): StripeShippingAddressElement;

    /**
     * Triggered when the element loses focus.
     */
    on(
        eventType: 'blur',
        handler: (event: { elementType: 'shippingAddress' }) => any
    ): StripeShippingAddressElement;
    once(
        eventType: 'blur',
        handler: (event: { elementType: 'shippingAddress' }) => any
    ): StripeShippingAddressElement;
    off(
        eventType: 'blur',
        handler?: (event: { elementType: 'shippingAddress' }) => any
    ): StripeShippingAddressElement;

    /**
     * Triggered when the escape key is pressed within the element.
     */
    on(
        eventType: 'escape',
        handler: (event: { elementType: 'shippingAddress' }) => any
    ): StripeShippingAddressElement;
    once(
        eventType: 'escape',
        handler: (event: { elementType: 'shippingAddress' }) => any
    ): StripeShippingAddressElement;
    off(
        eventType: 'escape',
        handler?: (event: { elementType: 'shippingAddress' }) => any
    ): StripeShippingAddressElement;

    /**
     * Triggered when the element fails to load.
     */
    on(
        eventType: 'loaderror',
        handler: (event: {
            elementType: 'shippingAddress';
            error: StripeError;
        }) => any
    ): StripeShippingAddressElement;
    once(
        eventType: 'loaderror',
        handler: (event: {
            elementType: 'shippingAddress';
            error: StripeError;
        }) => any
    ): StripeShippingAddressElement;
    off(
        eventType: 'loaderror',
        handler?: (event: {
            elementType: 'shippingAddress';
            error: StripeError;
        }) => any
    ): StripeShippingAddressElement;

    /**
     * Triggered when the loader UI is mounted to the DOM and ready to be displayed.
     */
    on(
        eventType: 'loaderstart',
        handler: (event: { elementType: 'shippingAddress' }) => any
    ): StripeShippingAddressElement;
    once(
        eventType: 'loaderstart',
        handler: (event: { elementType: 'shippingAddress' }) => any
    ): StripeShippingAddressElement;
    off(
        eventType: 'loaderstart',
        handler?: (event: { elementType: 'shippingAddress' }) => any
    ): StripeShippingAddressElement;

    /**
     * Updates the options the `ShippingAddressElement` was initialized with.
     * Updates are merged into the existing configuration.
     */
    update(
        options: Partial<StripeShippingAddressElementOptions>
    ): StripeShippingAddressElement;
};

type StripeTaxIdElement

type StripeTaxIdElement = StripeElementBase & {
    /**
     * The change event is triggered when the `Element`'s value changes.
     */
    on(
        eventType: 'change',
        handler: (event: StripeTaxIdElementChangeEvent) => any
    ): StripeTaxIdElement;
    once(
        eventType: 'change',
        handler: (event: StripeTaxIdElementChangeEvent) => any
    ): StripeTaxIdElement;
    off(
        eventType: 'change',
        handler?: (event: StripeTaxIdElementChangeEvent) => any
    ): StripeTaxIdElement;

    /**
     * Triggered when the element is fully rendered and can accept `element.focus` calls.
     */
    on(
        eventType: 'ready',
        handler: (event: { elementType: 'taxId' }) => any
    ): StripeTaxIdElement;
    once(
        eventType: 'ready',
        handler: (event: { elementType: 'taxId' }) => any
    ): StripeTaxIdElement;
    off(
        eventType: 'ready',
        handler?: (event: { elementType: 'taxId' }) => any
    ): StripeTaxIdElement;

    /**
     * Triggered when the element gains focus.
     */
    on(
        eventType: 'focus',
        handler: (event: { elementType: 'taxId' }) => any
    ): StripeTaxIdElement;
    once(
        eventType: 'focus',
        handler: (event: { elementType: 'taxId' }) => any
    ): StripeTaxIdElement;
    off(
        eventType: 'focus',
        handler?: (event: { elementType: 'taxId' }) => any
    ): StripeTaxIdElement;

    /**
     * Triggered when the element loses focus.
     */
    on(
        eventType: 'blur',
        handler: (event: { elementType: 'taxId' }) => any
    ): StripeTaxIdElement;
    once(
        eventType: 'blur',
        handler: (event: { elementType: 'taxId' }) => any
    ): StripeTaxIdElement;
    off(
        eventType: 'blur',
        handler?: (event: { elementType: 'taxId' }) => any
    ): StripeTaxIdElement;

    /**
     * Triggered when the escape key is pressed within the element.
     */
    on(
        eventType: 'escape',
        handler: (event: { elementType: 'taxId' }) => any
    ): StripeTaxIdElement;
    once(
        eventType: 'escape',
        handler: (event: { elementType: 'taxId' }) => any
    ): StripeTaxIdElement;
    off(
        eventType: 'escape',
        handler?: (event: { elementType: 'taxId' }) => any
    ): StripeTaxIdElement;

    /**
     * Triggered when the element fails to load.
     */
    on(
        eventType: 'loaderror',
        handler: (event: { elementType: 'taxId'; error: StripeError }) => any
    ): StripeTaxIdElement;
    once(
        eventType: 'loaderror',
        handler: (event: { elementType: 'taxId'; error: StripeError }) => any
    ): StripeTaxIdElement;
    off(
        eventType: 'loaderror',
        handler?: (event: { elementType: 'taxId'; error: StripeError }) => any
    ): StripeTaxIdElement;

    /**
     * Triggered when the loader UI is mounted to the DOM and ready to be displayed.
     */
    on(
        eventType: 'loaderstart',
        handler: (event: { elementType: 'taxId' }) => any
    ): StripeTaxIdElement;
    once(
        eventType: 'loaderstart',
        handler: (event: { elementType: 'taxId' }) => any
    ): StripeTaxIdElement;
    off(
        eventType: 'loaderstart',
        handler?: (event: { elementType: 'taxId' }) => any
    ): StripeTaxIdElement;

    /**
     * Updates the options the `TaxIdElement` was initialized with.
     * Updates are merged into the existing configuration.
     */
    update(options: Partial<StripeTaxIdElementOptions>): StripeTaxIdElement;

    /**
     * Validates and retrieves form values from the `AddressElement`.
     */
    getValue(): Promise<StripeTaxIdElementChangeEvent>;
};

type SupportedPaymentMethodType

type SupportedPaymentMethodType = 'us_bank_account' | 'link';

type TaxIdType

type TaxIdType =
    | 'al_tin'
    | 'am_tin'
    | 'ao_tin'
    | 'at_vat'
    | 'ba_tin'
    | 'bb_tin'
    | 'be_vat'
    | 'bg_vat'
    | 'bs_tin'
    | 'cd_nif'
    | 'cl_tin'
    | 'tr_tin'
    | 'cy_vat'
    | 'cz_vat'
    | 'de_vat'
    | 'dk_vat'
    | 'ee_vat'
    | 'es_vat'
    | 'fi_vat'
    | 'fr_vat'
    | 'gn_nif'
    | 'gr_vat'
    | 'hr_vat'
    | 'th_vat'
    | 'ie_vat'
    | 'it_vat'
    | 'kh_tin'
    | 'lt_vat'
    | 'lu_vat'
    | 'lv_vat'
    | 'me_pib'
    | 'mk_vat'
    | 'mr_nif'
    | 'mt_vat'
    | 'nl_vat'
    | 'np_pan'
    | 'pe_ruc'
    | 'pl_vat'
    | 'pt_vat'
    | 'ro_vat'
    | 'se_vat'
    | 'sa_vat'
    | 'si_vat'
    | 'sk_vat'
    | 'sn_ninea'
    | 'sr_fin'
    | 'tj_tin'
    | 'ug_tin'
    | 'uy_ruc'
    | 'xi_vat'
    | 'zm_tin'
    | 'zw_tin'
    | 'gb_vat'
    | 'nz_gst'
    | 'au_abn'
    | 'no_vat'
    | 'ch_vat'
    | 'mx_rfc'
    | 'hu_vat'
    | 'ca_bn'
    | 'ca_qst'
    | 'ca_gst_hst'
    | 'ca_pst_bc'
    | 'ca_pst_mb'
    | 'ca_pst_sk'
    | 'sg_gst'
    | 'za_vat'
    | 'ru_inn'
    | 'ru_kpp'
    | 'ae_trn'
    | 'is_vat'
    | 'in_gst'
    | 'kr_brn'
    | 'es_cif'
    | 'bh_vat'
    | 'kz_bin'
    | 'ng_tin'
    | 'om_vat'
    | 'ge_vat'
    | 'ke_pin'
    | 'eg_tin'
    | 'tw_vat'
    | 'ua_vat'
    | 'ec_ruc'
    | 'cr_tin'
    | 'tz_vat'
    | 'rs_pib'
    | 'uz_vat'
    | 'uz_tin'
    | 'md_vat'
    | 'ma_vat'
    | 'by_tin'
    | 'li_vat'
    | 'aw_tin'
    | 'az_tin'
    | 'bd_bin'
    | 'bj_ifu'
    | 'et_tin'
    | 'kg_tin'
    | 'la_tin'
    | 'cm_niu'
    | 'cv_nif'
    | 'bf_ifu'
    | 'ph_tin';

type TermOption

type TermOption = 'auto' | 'always' | 'never';

type TokenResult

type TokenResult =
    | { token: api.Token; error?: undefined }
    | { token?: undefined; error: StripeError };

type UpdateEmailError

type UpdateEmailError =
    | { message: string; code: 'incompleteEmail' }
    | { message: string; code: 'invalidEmail' };

type UpdateTaxIdInfoError

type UpdateTaxIdInfoError =
    | { message: string; code: 'invalidTaxId' }
    | AnyBuyerError;

type VerificationSessionResult

type VerificationSessionResult =
    | { verificationSession: api.VerificationSession; error?: undefined }
    | { verificationSession?: undefined; error: StripeError };

Namespaces

namespace Card

namespace Card {}

type AvailablePayoutMethod

type AvailablePayoutMethod = 'instant' | 'standard';

namespace ConfirmationToken

namespace ConfirmationToken {}

interface MandateData

interface MandateData {}

property customer_acceptance

customer_acceptance: {
    type: 'online';

    online?: {
        /**
         * The IP address from which the Mandate was accepted by the customer.
         */
        ip_address: string;

        /**
         * The user agent of the browser from which the Mandate was accepted by the customer.
         */
        user_agent: string;
    };
};

interface PaymentMethodPreview

interface PaymentMethodPreview {}

property acss_debit

acss_debit?: PaymentMethod.AcssDebit;

property affirm

affirm?: PaymentMethod.Affirm;

property afterpay_clearpay

afterpay_clearpay?: PaymentMethod.AfterpayClearpay;

property au_becs_debit

au_becs_debit?: PaymentMethod.AuBecsDebit;

property billing_details

billing_details: PaymentMethod.BillingDetails;

property card

card?: PaymentMethod.Card;

property card_present

card_present?: PaymentMethod.CardPresent;

property eps

eps?: PaymentMethod.Eps;

property fpx

fpx?: PaymentMethod.Fpx;

property grabpay

grabpay?: PaymentMethod.GrabPay;

property ideal

ideal?: PaymentMethod.Ideal;

property p24

p24?: PaymentMethod.P24;

property sepa_debit

sepa_debit?: PaymentMethod.SepaDebit;

property type

type: string;

The type of the PaymentMethod. An additional hash is included on payment_method_preview with a name matching this value. It contains additional information specific to the PaymentMethod type.

property us_bank_account

us_bank_account?: PaymentMethod.UsBankAccount;

interface Shipping

interface Shipping {}

property address

address: Address;

Recipient address.

property name

name: string | null;

Recipient name.

property phone

phone?: string | null;

Recipient phone (including extension).

namespace CreateSourceData

namespace CreateSourceData {}

type DeprecatedMethodData

type DeprecatedMethodData = Record<string, unknown>;

namespace FinancialConnectionsSession

namespace FinancialConnectionsSession {}

interface Account

interface Account {}

The Financial Connections Account object

property balance

balance: null | Balance;

The balance for this Account

property balance_refresh

balance_refresh: null | BalanceRefresh;

The most recent Balance Refresh for this Account

property category

category: 'cash' | 'credit' | 'investment' | 'other';

The type of the account.

property created

created: number;

Time at which the object was created. Measured in seconds since the Unix epoch.

property display_name

display_name: string;

A human-readable name that has been assigned to this account, either by the account holder or by the institution.

property id

id: string;

Unique identifier for the object.

property institution_name

institution_name: string;

The name of the institution that holds this account.

property last4

last4: string | null;

The last 4 digits of the account number. If present, this will be 4 numeric characters.

property livemode

livemode: boolean;

Has the value true if the object exists in live mode or the value false if the object exists in test mode.

property object

object: 'linked_account' | 'financial_connections.account';

String representing the object's type. 'linked_account' is present for backwards-compatibility.

property ownership

ownership: string | null;

The ID of this account's Ownership resource.

property ownership_refresh

ownership_refresh: null | OwnershipRefresh;

The most recent Ownership Refresh for this Account

property permissions

permissions: Permission[];

Permissions granted on this Account

property status

status: 'active' | 'inactive' | 'disconnected';

The status of the Account

property subcategory

subcategory:
    | 'checking'
    | 'savings'
    | 'mortgage'
    | 'line_of_credit'
    | 'credit_card'
    | 'other';

The sub-category of the Account

property supported_payment_method_types

supported_payment_method_types: SupportedPaymentMethodType[];

The types of Payment Methods which can be set up by this Account

interface Filters

interface Filters {}

Filters to restrict the kinds of accounts to collect.

property countries

countries?: string[];

List of countries from which to collect accounts.

type Permission

type Permission =
    | 'payment_method'
    | 'balances'
    | 'transactions'
    | 'ownership'
    | 'account_numbers';

Data features to which access can be requested

namespace Order

namespace Order {}

interface Billing

interface Billing {}

property address

address?: Address;

Billing address for the order.

property email

email?: string | null;

Email address for the order.

property name

name?: string | null;

Full name for the order.

property phone

phone?: string | null;

Billing phone number for the order (including extension).

interface Payment

interface Payment {}

property payment_intent

payment_intent?: PaymentIntent | null;

Payment intent associated with this order. Null when the order is open.

property status

status?: PaymentIntent.Status | null;

The status of the underlying payment associated with this order, if any. Null when the order is open.

interface Shipping

interface Shipping {}

property address

address?: Address;

Recipient shipping address. Required if the order includes products that are shippable.

property name

name?: string | null;

Recipient name.

property phone

phone?: string | null;

Recipient phone (including extension).

type Status

type Status = 'open' | 'submitted' | 'processing' | 'complete' | 'canceled';

namespace PaymentIntent

namespace PaymentIntent {}

interface LastPaymentError

interface LastPaymentError {}

property charge

charge?: string;

For card errors, the ID of the failed charge.

property code

code?: string;

For some errors that could be handled programmatically, a short string indicating the [error code](https://stripe.com/docs/error-codes) reported.

property decline_code

decline_code?: string;

For card errors resulting from a card issuer decline, a short string indicating the [card issuer's reason for the decline](https://stripe.com/docs/declines#issuer-declines) if they provide one.

property doc_url

doc_url?: string;

A URL to more information about the [error code](https://stripe.com/docs/error-codes) reported.

property message

message?: string;

A human-readable message providing more details about the error. For card errors, these messages can be shown to your users.

property param

param?: string;

If the error is parameter-specific, the parameter related to the error. For example, you can use this to display a message near the correct form field.

property payment_method

payment_method?: PaymentMethod;

property type

type: LastPaymentError.Type;

The type of error returned. One of api_connection_error, api_error, authentication_error, card_error, idempotency_error, invalid_request_error, or rate_limit_error

interface NextAction

interface NextAction {}

property redirect_to_url

redirect_to_url?: NextAction.RedirectToUrl;

Contains instructions for authenticating a payment by redirecting your customer to another page or application.

property type

type: string;

Type of the next action to perform, one of redirect_to_url, use_stripe_sdk, wechat_pay_display_qr_code, or verify_with_microdeposits.

property use_stripe_sdk

use_stripe_sdk?: NextAction.UseStripeSdk;

When confirming a SetupIntent with Stripe.js, Stripe.js depends on the contents of this dictionary to invoke authentication flows. The shape of the contents is subject to change and is only intended to be used by Stripe.js.

property verify_with_microdeposits

verify_with_microdeposits?: NextAction.VerifyWithMicrodeposits;

Contains details describing microdeposits verification flow.

property wechat_pay_display_qr_code

wechat_pay_display_qr_code?: NextAction.WechatPayDisplayQrCode;

Wechat Pay display qrcode

interface Shipping

interface Shipping {}

property address

address?: Address;

property carrier

carrier?: string | null;

The delivery service that shipped a physical product, such as Fedex, UPS, USPS, etc.

property name

name?: string | null;

Recipient name.

property phone

phone?: string | null;

Recipient phone (including extension).

property tracking_number

tracking_number?: string | null;

The tracking number for a physical product, obtained from the delivery service. If multiple tracking numbers were generated for this purchase, please separate them with commas.

type CancellationReason

type CancellationReason =
    | 'abandoned'
    | 'automatic'
    | 'duplicate'
    | 'failed_invoice'
    | 'fraudulent'
    | 'requested_by_customer'
    | 'void_invoice';

type CaptureMethod

type CaptureMethod = 'automatic' | 'manual';

type ConfirmationMethod

type ConfirmationMethod = 'automatic' | 'manual';

type SetupFutureUsage

type SetupFutureUsage = 'off_session' | 'on_session';

type Status

type Status =
    | 'canceled'
    | 'processing'
    | 'requires_action'
    | 'requires_capture'
    | 'requires_confirmation'
    | 'requires_payment_method'
    | 'succeeded';

namespace PaymentIntent.LastPaymentError

namespace PaymentIntent.LastPaymentError {}

type Type

type Type =
    | 'api_connection_error'
    | 'api_error'
    | 'authentication_error'
    | 'card_error'
    | 'idempotency_error'
    | 'invalid_request_error'
    | 'rate_limit_error';

namespace PaymentIntent.NextAction

namespace PaymentIntent.NextAction {}

interface RedirectToUrl

interface RedirectToUrl {}

property return_url

return_url: string | null;

If the customer does not exit their browser while authenticating, they will be redirected to this specified URL after completion.

property url

url: string | null;

The URL you must redirect your customer to in order to authenticate the payment.

interface UseStripeSdk

interface UseStripeSdk {}

interface VerifyWithMicrodeposits

interface VerifyWithMicrodeposits {}

property arrival_date

arrival_date: number;

The timestamp when the microdeposits are expected to land.

property hosted_verification_url

hosted_verification_url: string;

The URL for the hosted verification page, which allows customers to verify their bank account.

property microdeposit_type

microdeposit_type: string | null;

The type of the microdeposit sent to the customer. Used to distinguish between different verification methods.

interface WechatPayDisplayQrCode

interface WechatPayDisplayQrCode {}

property data

data: string;

Render and display paymentIntent.next_action.wechat_pay_display_qr_code.data as a QR code on your checkout page.

property image_data_url

image_data_url: string;

Use paymentIntent.next_action.wechat_pay_display_qr_code.image_data_url as an image source.

namespace PaymentIntentConfirmParams

namespace PaymentIntentConfirmParams {}

interface Shipping

interface Shipping {}

property address

address: AddressParam;

Shipping address.

property carrier

carrier?: string;

The delivery service that shipped a physical product, such as Fedex, UPS, USPS, etc.

property name

name: string;

Recipient name.

property phone

phone?: string;

Recipient phone (including extension).

property tracking_number

tracking_number?: string;

The tracking number for a physical product, obtained from the delivery service. If multiple tracking numbers were generated for this purchase, please separate them with commas.

type SetupFutureUsage

type SetupFutureUsage = 'off_session' | 'on_session';

namespace PaymentMethod

namespace PaymentMethod {}

interface AcssDebit

interface AcssDebit {}

property bank_name

bank_name: string;

The name of the bank.

property fingerprint

fingerprint: string | null;

Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same.

property institution_number

institution_number: string;

Institution number of the customer’s bank.

property last4

last4: string;

Last four digits of the bank account number.

property transit_number

transit_number: string;

Transit number of the customer’s bank.

interface Affirm

interface Affirm {}

interface AfterpayClearpay

interface AfterpayClearpay {}

interface Alipay

interface Alipay {}

interface Alma

interface Alma {}

interface AmazonPay

interface AmazonPay {}

interface AuBecsDebit

interface AuBecsDebit {}

property bsb_number

bsb_number: string | null;

Bank State Branch

property fingerprint

fingerprint: string | null;

Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same.

property last4

last4: string | null;

Last four characters of the account number.

interface BacsDebit

interface BacsDebit {}

property last4

last4: string | null;

Last four characters of the account number.

property sort_code

sort_code: string | null;

Sort code of the bank account. (e.g., 10-20-30).

interface Bancontact

interface Bancontact {}

interface Billie

interface Billie {}

interface BillingDetails

interface BillingDetails {}

property address

address: Address | null;

Billing address.

property email

email: string | null;

Email address.

property name

name: string | null;

Full name.

property phone

phone: string | null;

Billing phone number (including extension).

interface Blik

interface Blik {}

interface Boleto

interface Boleto {}

interface Card

interface Card {}

property brand

brand: string;

Card brand. Can be amex, diners, discover, jcb, mastercard, unionpay, visa, or unknown.

property checks

checks: Card.Checks | null;

Checks on Card address and CVC if provided.

property country

country: string | null;

Two-letter ISO code representing the country of the card. You could use this attribute to get a sense of the international breakdown of cards you've collected.

property display_brand

display_brand: string | null;

The brand to use when displaying the card, this accounts for customer’s brand choice on dual-branded cards. Can be american_express, cartes_bancaires, diners_club, discover, eftpos_australia, interac, jcb, mastercard, union_pay, visa, or other and may contain more values in the future.

property exp_month

exp_month: number;

Two-digit number representing the card's expiration month.

property exp_year

exp_year: number;

Four-digit number representing the card's expiration year.

property fingerprint

fingerprint?: string | null;

Uniquely identifies this particular card number. You can use this attribute to check whether two customers who've signed up with you are using the same card number.

property funding

funding: string;

Card funding type. Can be credit, debit, prepaid, or unknown.

property last4

last4: string;

The last four digits of the card.

property networks

networks: {
    /**
     * The preferred network for co-branded cards.
     */
    preferred: string | null;

    /**
     * All available networks for the card.
     */
    available: string[];
} | null;

Contains information about card networks that can be used to process the payment.

property regulated_status

regulated_status: string | null;

Status of a card based on the card issuer. Can be regulated or unregulated.

property three_d_secure_usage

three_d_secure_usage: Card.ThreeDSecureUsage | null;

Contains details on how this Card maybe be used for 3D Secure authentication.

property wallet

wallet: null | { [k: string]: any };

If this Card is part of a card wallet, this contains the details of the card wallet.

interface CardPresent

interface CardPresent {}

interface CashApp

interface CashApp {}

property buyer_id

buyer_id: string | null;

A unique and immutable identifier assigned by Cash App to every buyer.

property cashtag

cashtag: string | null;

A public identifier for buyers using Cash App.

interface Crypto

interface Crypto {}

interface Eps

interface Eps {}

property bank

bank: string;

The customer's bank.

interface Fpx

interface Fpx {}

property bank

bank: string;

The customer's bank.

interface GrabPay

interface GrabPay {}

interface Ideal

interface Ideal {}

property bank

bank: string | null;

The customer's bank, if provided.

property bic

bic: string | null;

The Bank Identifier Code of the customer's bank, if the bank was provided.

interface KakaoPay

interface KakaoPay {}

interface Klarna

interface Klarna {}

interface Konbini

interface Konbini {}

interface KrCard

interface KrCard {}

property brand

brand: string | null;

The local credit or debit card brand.

property last4

last4: string | null;

Last four characters of the IBAN.

interface Link

interface Link {}

property email

email: string | null;

Account owner’s email address.

interface MobilePay

interface MobilePay {}

interface Multibanco

interface Multibanco {}

interface NaverPay

interface NaverPay {}

interface NzBankAccount

interface NzBankAccount {}

property account_holder_name

account_holder_name: string | null;

The name on the bank account. Only present if the account holder name is different from the name of the authorized signatory collected in the PaymentMethod’s billing details.

property bank_code

bank_code: string | null;

The numeric code for the bank account’s bank.

property bank_name

bank_name: string | null;

The name of the bank.

property branch_code

branch_code: string | null;

Branch code of bank associated with the bank account.

property last4

last4: string | null;

Last four digits of the bank account number.

property suffix

suffix: string | null;

The suffix of the bank account number.

interface Oxxo

interface Oxxo {}

interface P24

interface P24 {}

property bank

bank: string;

The customer's bank.

interface PayByBank

interface PayByBank {}

interface Payco

interface Payco {}

interface Paynow

interface Paynow {}

interface Paypal

interface Paypal {}

property country

country: string | null;

Two-letter ISO code representing the buyer’s country. Values are provided by PayPal directly (if supported) at the time of authorization or settlement. They cannot be set or mutated.

property payer_id

payer_id: string | null;

PayPal account PayerID. This identifier uniquely identifies the PayPal customer.

property payer_name

payer_name: string | null;

Owner’s email. Values are provided by PayPal directly (if supported) at the time of authorization or settlement. They cannot be set or mutated.

interface Pix

interface Pix {}

interface PromptPay

interface PromptPay {}

interface RevolutPay

interface RevolutPay {}

interface SamsungPay

interface SamsungPay {}

interface Satispay

interface Satispay {}

interface SepaDebit

interface SepaDebit {}

property bank_code

bank_code: string | null;

Bank code of bank associated with the bank account.

property branch_code

branch_code: string | null;

Branch code of bank associated with the bank account.

property country

country: string | null;

Two-letter ISO code representing the country the bank account is located in.

property fingerprint

fingerprint: string | null;

Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same.

property last4

last4: string | null;

Last four characters of the IBAN.

interface Swish

interface Swish {}

interface Twint

interface Twint {}

interface UsBankAccount

interface UsBankAccount {}

property account_holder_type

account_holder_type: string;

The type of entity that holds the account. This can be either individual or company.

property account_number

account_number: string;

Customer’s bank account number.

property account_type

account_type: string;

Account type: checkings or savings. Defaults to checking if omitted.

property bank_name

bank_name: string;

The name of the bank.

property financial_connections_account

financial_connections_account: string;

The ID of the Financial Connections Account used to create the payment method.

property fingerprint

fingerprint: string;

Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same.

property last4

last4: string;

Last four digits of the bank account number.

property networks

networks: {
    /**
     * The preferred network.
     */
    preferred: string;

    /**
     * All supported networks.
     */
    supported: string[];
};

Contains information about US bank account networks that can be used.

property routing_number

routing_number: string;

The routing transit number for the bank account.

interface WechatPay

interface WechatPay {}

interface Zip

interface Zip {}

namespace PaymentMethod.Card

namespace PaymentMethod.Card {}

interface Checks

interface Checks {}

property address_line1_check

address_line1_check: string | null;

If a address line1 was provided, results of the check, one of pass, fail, unavailable, or unchecked.

property address_postal_code_check

address_postal_code_check: string | null;

If a address postal code was provided, results of the check, one of pass, fail, unavailable, or unchecked.

property cvc_check

cvc_check: string | null;

If a CVC was provided, results of the check, one of pass, fail, unavailable, or unchecked.

interface ThreeDSecureUsage

interface ThreeDSecureUsage {}

property supported

supported: boolean;

Whether 3D Secure is supported on this card.

namespace PaymentMethodCreateParams

namespace PaymentMethodCreateParams {}

interface BillingDetails

interface BillingDetails {}

property address

address?: BillingDetails.Address;

Billing address.

property email

email?: string | null;

Email address.

property name

name?: string | null;

Full name.

property phone

phone?: string | null;

Billing phone number (including extension).

namespace PaymentMethodCreateParams.BillingDetails

namespace PaymentMethodCreateParams.BillingDetails {}

interface Address

interface Address {}

property city

city?: string | null;

City, district, suburb, town, or village.

property country

country?: string | null;

Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).

property line1

line1?: string | null;

Address line 1 (e.g., street, PO Box, or company name).

property line2

line2?: string | null;

Address line 2 (e.g., apartment, suite, unit, or building).

property postal_code

postal_code?: string | null;

ZIP or postal code.

property state

state?: string | null;

State, county, province, or region.

namespace SetupIntent

namespace SetupIntent {}

interface LastSetupError

interface LastSetupError {}

property charge

charge?: string;

For card errors, the ID of the failed charge.

property code

code?: string;

For some errors that could be handled programmatically, a short string indicating the [error code](https://stripe.com/docs/error-codes) reported.

property decline_code

decline_code?: string;

For card errors resulting from a card issuer decline, a short string indicating the [card issuer's reason for the decline](https://stripe.com/docs/declines#issuer-declines) if they provide one.

property doc_url

doc_url?: string;

A URL to more information about the [error code](https://stripe.com/docs/error-codes) reported.

property message

message?: string;

A human-readable message providing more details about the error. For card errors, these messages can be shown to your users.

property param

param?: string;

If the error is parameter-specific, the parameter related to the error. For example, you can use this to display a message near the correct form field.

property payment_method

payment_method?: PaymentMethod;

property type

type: LastSetupError.Type;

The type of error returned. One of api_connection_error, api_error, authentication_error, card_error, idempotency_error, invalid_request_error, or rate_limit_error

interface NextAction

interface NextAction {}

property redirect_to_url

redirect_to_url?: NextAction.RedirectToUrl;

Contains instructions for authenticating a payment by redirecting your customer to another page or application.

property type

type: string;

Type of the next action to perform, one of redirect_to_url, use_stripe_sdk, or verify_with_microdeposits.

property use_stripe_sdk

use_stripe_sdk?: NextAction.UseStripeSdk;

When confirming a SetupIntent with Stripe.js, Stripe.js depends on the contents of this dictionary to invoke authentication flows. The shape of the contents is subject to change and is only intended to be used by Stripe.js.

property verify_with_microdeposits

verify_with_microdeposits?: NextAction.VerifyWithMicrodeposits;

Contains details describing microdeposits verification flow.

type CancellationReason

type CancellationReason = 'abandoned' | 'duplicate' | 'requested_by_customer';

type Status

type Status =
    | 'canceled'
    | 'processing'
    | 'requires_action'
    | 'requires_confirmation'
    | 'requires_payment_method'
    | 'succeeded';

namespace SetupIntent.LastSetupError

namespace SetupIntent.LastSetupError {}

type Type

type Type =
    | 'api_connection_error'
    | 'api_error'
    | 'authentication_error'
    | 'card_error'
    | 'idempotency_error'
    | 'invalid_request_error'
    | 'rate_limit_error';

namespace SetupIntent.NextAction

namespace SetupIntent.NextAction {}

interface RedirectToUrl

interface RedirectToUrl {}

property return_url

return_url: string | null;

If the customer does not exit their browser while authenticating, they will be redirected to this specified URL after completion.

property url

url: string | null;

The URL you must redirect your customer to in order to authenticate.

interface UseStripeSdk

interface UseStripeSdk {}

interface VerifyWithMicrodeposits

interface VerifyWithMicrodeposits {}

property arrival_date

arrival_date: number;

The timestamp when the microdeposits are expected to land.

property hosted_verification_url

hosted_verification_url: string;

The URL for the hosted verification page, which allows customers to verify their bank account.

property microdeposit_type

microdeposit_type: string | null;

The type of the microdeposit sent to the customer. Used to distinguish between different verification methods.

namespace Source

namespace Source {}

interface AchCreditTransfer

interface AchCreditTransfer {}

property account_number

account_number?: string | null;

property bank_name

bank_name?: string | null;

property fingerprint

fingerprint?: string | null;

property refund_account_holder_name

refund_account_holder_name?: string | null;

property refund_account_holder_type

refund_account_holder_type?: string | null;

property refund_routing_number

refund_routing_number?: string | null;

property routing_number

routing_number?: string | null;

property swift_code

swift_code?: string | null;

interface AchDebit

interface AchDebit {}

property bank_name

bank_name?: string | null;

property country

country?: string | null;

property fingerprint

fingerprint?: string | null;

property last4

last4?: string | null;

property routing_number

routing_number?: string | null;

property type

type?: string | null;

interface AcssDebit

interface AcssDebit {}

property bank_address_city

bank_address_city?: string | null;

property bank_address_line_1

bank_address_line_1?: string | null;

property bank_address_line_2

bank_address_line_2?: string | null;

property bank_address_postal_code

bank_address_postal_code?: string | null;

property bank_name

bank_name?: string | null;

property category

category?: string | null;

property country

country?: string | null;

property fingerprint

fingerprint?: string | null;

property last4

last4?: string | null;

property routing_number

routing_number?: string | null;

interface Alipay

interface Alipay {}

property data_string

data_string?: string | null;

property native_url

native_url?: string | null;

property statement_descriptor

statement_descriptor?: string | null;

interface AuBecsDebit

interface AuBecsDebit {}

property bsb_number

bsb_number?: string | null;

property fingerprint

fingerprint?: string | null;

property last4

last4?: string | null;

interface Bancontact

interface Bancontact {}

property bank_code

bank_code?: string | null;

property bank_name

bank_name?: string | null;

property bic

bic?: string | null;

property iban_last4

iban_last4?: string | null;

property preferred_language

preferred_language?: string | null;

property statement_descriptor

statement_descriptor?: string | null;

interface Card

interface Card {}

property address_line1_check

address_line1_check?: string | null;

property address_zip_check

address_zip_check?: string | null;

property brand

brand?: string | null;

property country

country?: string | null;

property cvc_check

cvc_check?: string | null;

property description

description?: string;

property dynamic_last4

dynamic_last4?: string | null;

property exp_month

exp_month?: number | null;

property exp_year

exp_year?: number | null;

property fingerprint

fingerprint?: string;

property funding

funding?: string | null;

property iin

iin?: string;

property issuer

issuer?: string;

property last4

last4?: string | null;

property name

name?: string | null;

property three_d_secure

three_d_secure?: string;

property tokenization_method

tokenization_method?: string | null;

interface CardPresent

interface CardPresent {}

property application_cryptogram

application_cryptogram?: string;

property application_preferred_name

application_preferred_name?: string;

property authorization_code

authorization_code?: string | null;

property authorization_response_code

authorization_response_code?: string;

property brand

brand?: string | null;

property country

country?: string | null;

property cvm_type

cvm_type?: string;

property data_type

data_type?: string | null;

property dedicated_file_name

dedicated_file_name?: string;

property description

description?: string;

property emv_auth_data

emv_auth_data?: string;

property evidence_customer_signature

evidence_customer_signature?: string | null;

property evidence_transaction_certificate

evidence_transaction_certificate?: string | null;

property exp_month

exp_month?: number | null;

property exp_year

exp_year?: number | null;

property fingerprint

fingerprint?: string;

property funding

funding?: string | null;

property iin

iin?: string;

property issuer

issuer?: string;

property last4

last4?: string | null;

property pos_device_id

pos_device_id?: string | null;

property pos_entry_mode

pos_entry_mode?: string;

property read_method

read_method?: string | null;

property reader

reader?: string | null;

property terminal_verification_results

terminal_verification_results?: string;

property transaction_status_information

transaction_status_information?: string;

interface CodeVerification

interface CodeVerification {}

property attempts_remaining

attempts_remaining: number;

The number of attempts remaining to authenticate the source object with a verification code.

property status

status: string;

The status of the code verification, either pending (awaiting verification, attempts_remaining should be greater than 0), succeeded (successful verification) or failed (failed verification, cannot be verified anymore as attempts_remaining should be 0).

interface Eps

interface Eps {}

property reference

reference?: string | null;

property statement_descriptor

statement_descriptor?: string | null;

interface Giropay

interface Giropay {}

property bank_code

bank_code?: string | null;

property bank_name

bank_name?: string | null;

property bic

bic?: string | null;

property statement_descriptor

statement_descriptor?: string | null;

interface Ideal

interface Ideal {}

property bank

bank?: string | null;

property bic

bic?: string | null;

property iban_last4

iban_last4?: string | null;

property statement_descriptor

statement_descriptor?: string | null;

interface Klarna

interface Klarna {}

property background_image_url

background_image_url?: string;

property client_token

client_token?: string | null;

property first_name

first_name?: string;

property last_name

last_name?: string;

property locale

locale?: string;

property logo_url

logo_url?: string;

property page_title

page_title?: string;

property pay_later_asset_urls_descriptive

pay_later_asset_urls_descriptive?: string;

property pay_later_asset_urls_standard

pay_later_asset_urls_standard?: string;

property pay_later_name

pay_later_name?: string;

property pay_later_redirect_url

pay_later_redirect_url?: string;

property pay_now_asset_urls_descriptive

pay_now_asset_urls_descriptive?: string;

property pay_now_asset_urls_standard

pay_now_asset_urls_standard?: string;

property pay_now_name

pay_now_name?: string;

property pay_now_redirect_url

pay_now_redirect_url?: string;

property pay_over_time_asset_urls_descriptive

pay_over_time_asset_urls_descriptive?: string;

property pay_over_time_asset_urls_standard

pay_over_time_asset_urls_standard?: string;

property pay_over_time_name

pay_over_time_name?: string;

property pay_over_time_redirect_url

pay_over_time_redirect_url?: string;

property payment_method_categories

payment_method_categories?: string;

property purchase_country

purchase_country?: string;

property purchase_type

purchase_type?: string;

property redirect_url

redirect_url?: string;

property shipping_first_name

shipping_first_name?: string;

property shipping_last_name

shipping_last_name?: string;

interface Multibanco

interface Multibanco {}

property entity

entity?: string | null;

property reference

reference?: string | null;

property refund_account_holder_address_city

refund_account_holder_address_city?: string | null;

property refund_account_holder_address_country

refund_account_holder_address_country?: string | null;

property refund_account_holder_address_line1

refund_account_holder_address_line1?: string | null;

property refund_account_holder_address_line2

refund_account_holder_address_line2?: string | null;

property refund_account_holder_address_postal_code

refund_account_holder_address_postal_code?: string | null;

property refund_account_holder_address_state

refund_account_holder_address_state?: string | null;

property refund_account_holder_name

refund_account_holder_name?: string | null;

property refund_iban

refund_iban?: string | null;

interface Owner

interface Owner {}

property address

address: Address | null;

Owner's address.

property email

email: string | null;

Owner's email address.

property name

name: string | null;

Owner's full name.

property phone

phone: string | null;

Owner's phone number (including extension).

property verified_address

verified_address: Address | null;

Verified owner's address. Verified values are verified or provided by the payment method directly (and if supported) at the time of authorization or settlement. They cannot be set or mutated.

property verified_email

verified_email: string | null;

Verified owner's email address. Verified values are verified or provided by the payment method directly (and if supported) at the time of authorization or settlement. They cannot be set or mutated.

property verified_name

verified_name: string | null;

Verified owner's full name. Verified values are verified or provided by the payment method directly (and if supported) at the time of authorization or settlement. They cannot be set or mutated.

property verified_phone

verified_phone: string | null;

Verified owner's phone number (including extension). Verified values are verified or provided by the payment method directly (and if supported) at the time of authorization or settlement. They cannot be set or mutated.

interface P24

interface P24 {}

property reference

reference?: string | null;

interface Receiver

interface Receiver {}

property address

address: string | null;

The address of the receiver source. This is the value that should be communicated to the customer to send their funds to.

property amount_charged

amount_charged: number;

The total amount that was charged by you. The amount charged is expressed in the source's currency.

property amount_received

amount_received: number;

The total amount received by the receiver source. amount_received = amount_returned + amount_charged is true at all time. The amount received is expressed in the source's currency.

property amount_returned

amount_returned: number;

The total amount that was returned to the customer. The amount returned is expressed in the source's currency.

property refund_attributes_method

refund_attributes_method: string;

Type of refund attribute method, one of email, manual, or none.

property refund_attributes_status

refund_attributes_status: string;

Type of refund attribute status, one of missing, requested, or available.

interface Redirect

interface Redirect {}

property failure_reason

failure_reason: string | null;

The failure reason for the redirect, either user_abort (the customer aborted or dropped out of the redirect flow), declined (the authentication failed or the transaction was declined), or processing_error (the redirect failed due to a technical error). Present only if the redirect status is failed.

property return_url

return_url: string;

The URL you provide to redirect the customer to after they authenticated their payment.

property status

status: string;

The status of the redirect, either pending (ready to be used by your customer to authenticate the transaction), succeeded (succesful authentication, cannot be reused) or not_required (redirect should not be used) or failed (failed authentication, cannot be reused).

property url

url: string;

The URL provided to you to redirect a customer to as part of a redirect authentication flow.

interface SepaCreditTransfer

interface SepaCreditTransfer {}

property bank_name

bank_name?: string | null;

property bic

bic?: string | null;

property iban

iban?: string | null;

property refund_account_holder_address_city

refund_account_holder_address_city?: string | null;

property refund_account_holder_address_country

refund_account_holder_address_country?: string | null;

property refund_account_holder_address_line1

refund_account_holder_address_line1?: string | null;

property refund_account_holder_address_line2

refund_account_holder_address_line2?: string | null;

property refund_account_holder_address_postal_code

refund_account_holder_address_postal_code?: string | null;

property refund_account_holder_address_state

refund_account_holder_address_state?: string | null;

property refund_account_holder_name

refund_account_holder_name?: string | null;

property refund_iban

refund_iban?: string | null;

interface SepaDebit

interface SepaDebit {}

property bank_code

bank_code?: string | null;

property branch_code

branch_code?: string | null;

property country

country?: string | null;

property fingerprint

fingerprint?: string | null;

property last4

last4?: string | null;

property mandate_reference

mandate_reference?: string | null;

property mandate_url

mandate_url?: string | null;

interface Sofort

interface Sofort {}

property bank_code

bank_code?: string | null;

property bank_name

bank_name?: string | null;

property bic

bic?: string | null;

property country

country?: string | null;

property iban_last4

iban_last4?: string | null;

property preferred_language

preferred_language?: string | null;

property statement_descriptor

statement_descriptor?: string | null;

interface SourceOrder

interface SourceOrder {}

property amount

amount: number;

A positive integer in the smallest currency unit (that is, 100 cents for $1.00, or 1 for ¥1, Japanese Yen being a zero-decimal currency) representing the total amount for the order.

property currency

currency: string;

Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).

property email

email?: string;

The email address of the customer placing the order.

property items

items: Array<SourceOrder.Item> | null;

List of items constituting the order.

property shipping

shipping?: SourceOrder.Shipping;

interface ThreeDSecure

interface ThreeDSecure {}

property address_line1_check

address_line1_check?: string | null;

property address_zip_check

address_zip_check?: string | null;

property authenticated

authenticated?: boolean | null;

property brand

brand?: string | null;

property card

card?: string | null;

property country

country?: string | null;

property customer

customer?: string | null;

property cvc_check

cvc_check?: string | null;

property description

description?: string;

property dynamic_last4

dynamic_last4?: string | null;

property exp_month

exp_month?: number | null;

property exp_year

exp_year?: number | null;

property fingerprint

fingerprint?: string;

property funding

funding?: string | null;

property iin

iin?: string;

property issuer

issuer?: string;

property last4

last4?: string | null;

property name

name?: string | null;

property three_d_secure

three_d_secure?: string;

property tokenization_method

tokenization_method?: string | null;

interface Wechat

interface Wechat {}

property prepay_id

prepay_id?: string;

property qr_code_url

qr_code_url?: string | null;

property statement_descriptor

statement_descriptor?: string;

type Type

type Type =
    | 'ach_credit_transfer'
    | 'ach_debit'
    | 'acss_debit'
    | 'alipay'
    | 'au_becs_debit'
    | 'bancontact'
    | 'card'
    | 'card_present'
    | 'eps'
    | 'giropay'
    | 'ideal'
    | 'klarna'
    | 'multibanco'
    | 'p24'
    | 'sepa_credit_transfer'
    | 'sepa_debit'
    | 'sofort'
    | 'three_d_secure'
    | 'wechat';

namespace Source.SourceOrder

namespace Source.SourceOrder {}

interface Item

interface Item {}

property amount

amount: number | null;

The amount (price) for this order item.

property currency

currency: string | null;

This currency of this order item. Required when amount is present.

property description

description: string | null;

Human-readable description for this order item.

property quantity

quantity?: number;

The quantity of this order item. When type is sku, this is the number of instances of the SKU to be ordered.

property type

type: string | null;

The type of this order item. Must be sku, tax, or shipping.

interface Shipping

interface Shipping {}

property address

address?: Address;

property carrier

carrier?: string | null;

The delivery service that shipped a physical product, such as Fedex, UPS, USPS, etc.

property name

name?: string | null;

Recipient name.

property phone

phone?: string | null;

Recipient phone (including extension).

property tracking_number

tracking_number?: string | null;

The tracking number for a physical product, obtained from the delivery service. If multiple tracking numbers were generated for this purchase, please separate them with commas.

namespace SourceCreateParams

namespace SourceCreateParams {}

interface Mandate

interface Mandate {}

property acceptance

acceptance?: Mandate.Acceptance;

The parameters required to notify Stripe of a mandate acceptance or refusal by the customer.

property amount

amount?: number | '';

The amount specified by the mandate. (Leave null for a mandate covering all amounts)

property currency

currency?: string;

The currency specified by the mandate. (Must match currency of the source)

property interval

interval?: Mandate.Interval;

The interval of debits permitted by the mandate. Either one_time (just permitting a single debit), scheduled (with debits on an agreed schedule or for clearly-defined events), or variable(for debits with any frequency)

property notification_method

notification_method?: Mandate.NotificationMethod;

The method Stripe should use to notify the customer of upcoming debit instructions and/or mandate confirmation as required by the underlying debit network. Either email (an email is sent directly to the customer), manual (a source.mandate_notification event is sent to your webhooks endpoint and you should handle the notification) or none (the underlying debit network does not require any notification).

interface Owner

interface Owner {}

property address

address?: Owner.Address;

Owner's address.

property email

email?: string;

Owner's email address.

property name

name?: string;

Owner's full name.

property phone

phone?: string;

Owner's phone number.

interface Receiver

interface Receiver {}

property refund_attributes_method

refund_attributes_method?: Receiver.RefundAttributesMethod;

The method Stripe should use to request information needed to process a refund or mispayment. Either email (an email is sent directly to the customer) or manual (a source.refund_attributes_required event is sent to your webhooks endpoint). Refer to each payment method's documentation to learn which refund attributes may be required.

interface Redirect

interface Redirect {}

property return_url

return_url: string;

The URL you provide to redirect the customer back to you after they authenticated their payment. It can use your application URI scheme in the context of a mobile application.

interface SourceOrder

interface SourceOrder {}

property items

items?: Array<SourceOrder.Item>;

List of items constituting the order.

property shipping

shipping?: SourceOrder.Shipping;

Shipping address for the order. Required if any of the SKUs are for products that have shippable set to true.

type Flow

type Flow = 'code_verification' | 'none' | 'receiver' | 'redirect';

type Usage

type Usage = 'reusable' | 'single_use';

namespace SourceCreateParams.Mandate

namespace SourceCreateParams.Mandate {}

interface Acceptance

interface Acceptance {}

property date

date?: number;

The Unix timestamp (in seconds) when the mandate was accepted or refused by the customer.

property ip

ip?: string;

The IP address from which the mandate was accepted or refused by the customer.

property offline

offline?: Acceptance.Offline;

The parameters required to store a mandate accepted offline. Should only be set if mandate[type] is offline

property online

online?: Acceptance.Online;

The parameters required to store a mandate accepted online. Should only be set if mandate[type] is online

property status

status: Acceptance.Status;

The status of the mandate acceptance. Either accepted (the mandate was accepted) or refused (the mandate was refused).

property type

type?: Acceptance.Type;

The type of acceptance information included with the mandate. Either online or offline

property user_agent

user_agent?: string;

The user agent of the browser from which the mandate was accepted or refused by the customer.

type Interval

type Interval = 'one_time' | 'scheduled' | 'variable';

type NotificationMethod

type NotificationMethod =
    | 'deprecated_none'
    | 'email'
    | 'manual'
    | 'none'
    | 'stripe_email';

namespace SourceCreateParams.Mandate.Acceptance

namespace SourceCreateParams.Mandate.Acceptance {}

interface Offline

interface Offline {}

property contact_email

contact_email: string;

An email to contact you with if a copy of the mandate is requested, required if type is offline.

interface Online

interface Online {}

property date

date?: number;

The Unix timestamp (in seconds) when the mandate was accepted or refused by the customer.

property ip

ip?: string;

The IP address from which the mandate was accepted or refused by the customer.

property user_agent

user_agent?: string;

The user agent of the browser from which the mandate was accepted or refused by the customer.

type Status

type Status = 'accepted' | 'pending' | 'refused' | 'revoked';

type Type

type Type = 'offline' | 'online';

namespace SourceCreateParams.Owner

namespace SourceCreateParams.Owner {}

interface Address

interface Address {}

property city

city?: string;

City, district, suburb, town, or village.

property country

country?: string;

Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).

property line1

line1?: string;

Address line 1 (e.g., street, PO Box, or company name).

property line2

line2?: string;

Address line 2 (e.g., apartment, suite, unit, or building).

property postal_code

postal_code?: string;

ZIP or postal code.

property state

state?: string;

State, county, province, or region.

namespace SourceCreateParams.Receiver

namespace SourceCreateParams.Receiver {}

type RefundAttributesMethod

type RefundAttributesMethod = 'email' | 'manual' | 'none';

namespace SourceCreateParams.SourceOrder

namespace SourceCreateParams.SourceOrder {}

interface Item

interface Item {}

property amount

amount?: number;

property currency

currency?: string;

property description

description?: string;

property parent

parent?: string;

The ID of the SKU being ordered.

property quantity

quantity?: number;

The quantity of this order item. When type is sku, this is the number of instances of the SKU to be ordered.

property type

type?: Item.Type;

interface Shipping

interface Shipping {}

property address

address: AddressParam;

Shipping address.

property carrier

carrier?: string;

The delivery service that shipped a physical product, such as Fedex, UPS, USPS, etc.

property name

name?: string;

Recipient name.

property phone

phone?: string;

Recipient phone (including extension).

property tracking_number

tracking_number?: string;

The tracking number for a physical product, obtained from the delivery service. If multiple tracking numbers were generated for this purchase, please separate them with commas.

namespace SourceCreateParams.SourceOrder.Item

namespace SourceCreateParams.SourceOrder.Item {}

type Type

type Type = 'discount' | 'shipping' | 'sku' | 'tax';

namespace TokenCreateParams

namespace TokenCreateParams {}

interface Account

interface Account {}

property business_type

business_type?: Account.BusinessType;

The business type.

property company

company?: Account.Company;

Information about the company or business.

property individual

individual?: Account.Individual;

Information about the person represented by the account.

property tos_shown_and_accepted

tos_shown_and_accepted?: boolean;

Whether the user described by the data in the token has been shown [the Stripe Connected Account Agreement](https://stripe.com/docs/connect/account-tokens#stripe-connected-account-agreement). When creating an account token to create a new Connect account, this value must be true.

interface Person

interface Person {}

property address

address?: Person.Address;

The person's address.

property address_kana

address_kana?: JapanAddressParam;

The Kana variation of the person's address (Japan only).

property address_kanji

address_kanji?: JapanAddressParam;

The Kanji variation of the person's address (Japan only).

property dob

dob?: Person.Dob | null;

The person's date of birth.

property email

email?: string;

The person's email address.

property first_name

first_name?: string;

The person's first name.

property first_name_kana

first_name_kana?: string;

The Kana variation of the person's first name (Japan only).

property first_name_kanji

first_name_kanji?: string;

The Kanji variation of the person's first name (Japan only).

property gender

gender?: string;

The person's gender (International regulations require either "male" or "female").

property id_number

id_number?: string;

The person's ID number, as appropriate for their country. For example, a social security number in the U.S., social insurance number in Canada, etc. Instead of the number itself, you can also provide a [PII token provided by Stripe.js](https://stripe.com/docs/stripe.js#collecting-pii-data).

property last_name

last_name?: string;

The person's last name.

property last_name_kana

last_name_kana?: string;

The Kana variation of the person's last name (Japan only).

property last_name_kanji

last_name_kanji?: string;

The Kanji variation of the person's last name (Japan only).

property maiden_name

maiden_name?: string;

The person's maiden name.

property metadata

metadata?: MetadataParam | null;

Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to metadata.

property phone

phone?: string;

The person's phone number.

property relationship

relationship?: Person.Relationship;

The relationship that this person has with the account's legal entity.

property ssn_last_4

ssn_last_4?: string;

The last 4 digits of the person's social security number.

property verification

verification?: Person.Verification;

The person's verification status.

namespace TokenCreateParams.Account

namespace TokenCreateParams.Account {}

interface Company

interface Company {}

property address

address?: Company.Address;

The company's primary address.

property address_kana

address_kana?: JapanAddressParam;

The Kana variation of the company's primary address (Japan only).

property address_kanji

address_kanji?: JapanAddressParam;

The Kanji variation of the company's primary address (Japan only).

property directors_provided

directors_provided?: boolean;

Whether the company's directors have been provided. Set this Boolean to true after creating all the company's directors with [the Persons API](https://stripe.com/docs/api/persons) for accounts with a relationship.director requirement. This value is not automatically set to true after creating directors, so it needs to be updated to indicate all directors have been provided.

property executives_provided

executives_provided?: boolean;

Whether the company's executives have been provided. Set this Boolean to true after creating all the company's executives with [the Persons API](https://stripe.com/docs/api/persons) for accounts with a relationship.executive requirement.

property name

name?: string;

The company's legal name.

property name_kana

name_kana?: string;

The Kana variation of the company's legal name (Japan only).

property name_kanji

name_kanji?: string;

The Kanji variation of the company's legal name (Japan only).

property owners_provided

owners_provided?: boolean;

Whether the company's owners have been provided. Set this Boolean to true after creating all the company's owners with [the Persons API](https://stripe.com/docs/api/persons) for accounts with a relationship.owner requirement.

property phone

phone?: string;

The company's phone number (used for verification).

property structure

structure?: Company.Structure | null;

The category identifying the legal structure of the company or legal entity. See [Business structure](https://stripe.com/docs/connect/identity-verification#business-structure) for more details.

property tax_id

tax_id?: string;

The business ID number of the company, as appropriate for the company's country. (Examples are an Employer ID Number in the U.S., a Business Number in Canada, or a Company Number in the UK.)

property tax_id_registrar

tax_id_registrar?: string;

The jurisdiction in which the tax_id is registered (Germany-based companies only).

property vat_id

vat_id?: string;

The VAT number of the company.

property verification

verification?: Company.Verification;

Information on the verification state of the company.

interface Individual

interface Individual {}

property address

address?: Individual.Address;

The individual's primary address.

property address_kana

address_kana?: JapanAddressParam;

The Kana variation of the the individual's primary address (Japan only).

property address_kanji

address_kanji?: JapanAddressParam;

The Kanji variation of the the individual's primary address (Japan only).

property dob

dob?: Individual.Dob | null;

The individual's date of birth.

property email

email?: string;

The individual's email address.

property first_name

first_name?: string;

The individual's first name.

property first_name_kana

first_name_kana?: string;

The Kana variation of the the individual's first name (Japan only).

property first_name_kanji

first_name_kanji?: string;

The Kanji variation of the individual's first name (Japan only).

property gender

gender?: string;

The individual's gender (International regulations require either "male" or "female").

property id_number

id_number?: string;

The government-issued ID number of the individual, as appropriate for the representative's country. (Examples are a Social Security Number in the U.S., or a Social Insurance Number in Canada). Instead of the number itself, you can also provide a [PII token created with Stripe.js](https://stripe.com/docs/stripe.js#collecting-pii-data).

property last_name

last_name?: string;

The individual's last name.

property last_name_kana

last_name_kana?: string;

The Kana varation of the individual's last name (Japan only).

property last_name_kanji

last_name_kanji?: string;

The Kanji varation of the individual's last name (Japan only).

property maiden_name

maiden_name?: string;

The individual's maiden name.

property metadata

metadata?: MetadataParam | null;

Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to metadata.

property phone

phone?: string;

The individual's phone number.

property political_exposure

political_exposure?: Individual.PoliticalExposure;

Indicates if the person or any of their representatives, family members, or other closely related persons, declares that they hold or have held an important public job or function, in any jurisdiction.

property ssn_last_4

ssn_last_4?: string;

The last four digits of the individual's Social Security Number (U.S. only).

property verification

verification?: Individual.Verification;

The individual's verification document information.

type BusinessType

type BusinessType = 'company' | 'government_entity' | 'individual' | 'non_profit';

namespace TokenCreateParams.Account.Company

namespace TokenCreateParams.Account.Company {}

interface Address

interface Address {}

property city

city?: string;

City, district, suburb, town, or village.

property country

country?: string;

Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).

property line1

line1?: string;

Address line 1 (e.g., street, PO Box, or company name).

property line2

line2?: string;

Address line 2 (e.g., apartment, suite, unit, or building).

property postal_code

postal_code?: string;

ZIP or postal code.

property state

state?: string;

State, county, province, or region.

interface Verification

interface Verification {}

property document

document?: Verification.Document;

A document verifying the business.

type Structure

type Structure =
    | 'government_instrumentality'
    | 'governmental_unit'
    | 'incorporated_non_profit'
    | 'limited_liability_partnership'
    | 'multi_member_llc'
    | 'private_company'
    | 'private_corporation'
    | 'private_partnership'
    | 'public_company'
    | 'public_corporation'
    | 'public_partnership'
    | 'sole_proprietorship'
    | 'tax_exempt_government_instrumentality'
    | 'unincorporated_association'
    | 'unincorporated_non_profit';

namespace TokenCreateParams.Account.Company.Verification

namespace TokenCreateParams.Account.Company.Verification {}

interface Document

interface Document {}

property back

back?: string;

The back of a document returned by a [file upload](https://stripe.com/docs/api#create_file) with a purpose value of additional_verification. The uploaded file needs to be a color image (smaller than 8,000px by 8,000px), in JPG, PNG, or PDF format, and less than 10 MB in size.

property front

front?: string;

The front of a document returned by a [file upload](https://stripe.com/docs/api#create_file) with a purpose value of additional_verification. The uploaded file needs to be a color image (smaller than 8,000px by 8,000px), in JPG, PNG, or PDF format, and less than 10 MB in size.

namespace TokenCreateParams.Account.Individual

namespace TokenCreateParams.Account.Individual {}

interface Address

interface Address {}

property city

city?: string;

City, district, suburb, town, or village.

property country

country?: string;

Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).

property line1

line1?: string;

Address line 1 (e.g., street, PO Box, or company name).

property line2

line2?: string;

Address line 2 (e.g., apartment, suite, unit, or building).

property postal_code

postal_code?: string;

ZIP or postal code.

property state

state?: string;

State, county, province, or region.

interface Dob

interface Dob {}

property day

day: number;

The day of birth, between 1 and 31.

property month

month: number;

The month of birth, between 1 and 12.

property year

year: number;

The four-digit year of birth.

interface Verification

interface Verification {}

property additional_document

additional_document?: Verification.AdditionalDocument;

A document showing address, either a passport, local ID card, or utility bill from a well-known utility company.

property document

document?: Verification.Document;

An identifying document, either a passport or local ID card.

type PoliticalExposure

type PoliticalExposure = 'none' | 'existing';

namespace TokenCreateParams.Account.Individual.Verification

namespace TokenCreateParams.Account.Individual.Verification {}

interface AdditionalDocument

interface AdditionalDocument {}

property back

back?: string;

The back of an ID returned by a [file upload](https://stripe.com/docs/api#create_file) with a purpose value of identity_document. The uploaded file needs to be a color image (smaller than 8,000px by 8,000px), in JPG, PNG, or PDF format, and less than 10 MB in size.

property front

front?: string;

The front of an ID returned by a [file upload](https://stripe.com/docs/api#create_file) with a purpose value of identity_document. The uploaded file needs to be a color image (smaller than 8,000px by 8,000px), in JPG, PNG, or PDF format, and less than 10 MB in size.

interface Document

interface Document {}

property back

back?: string;

The back of an ID returned by a [file upload](https://stripe.com/docs/api#create_file) with a purpose value of identity_document. The uploaded file needs to be a color image (smaller than 8,000px by 8,000px), in JPG, PNG, or PDF format, and less than 10 MB in size.

property front

front?: string;

The front of an ID returned by a [file upload](https://stripe.com/docs/api#create_file) with a purpose value of identity_document. The uploaded file needs to be a color image (smaller than 8,000px by 8,000px), in JPG, PNG, or PDF format, and less than 10 MB in size.

namespace TokenCreateParams.Person

namespace TokenCreateParams.Person {}

interface Address

interface Address {}

property city

city?: string;

City, district, suburb, town, or village.

property country

country?: string;

Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).

property line1

line1?: string;

Address line 1 (e.g., street, PO Box, or company name).

property line2

line2?: string;

Address line 2 (e.g., apartment, suite, unit, or building).

property postal_code

postal_code?: string;

ZIP or postal code.

property state

state?: string;

State, county, province, or region.

interface Dob

interface Dob {}

property day

day: number;

The day of birth, between 1 and 31.

property month

month: number;

The month of birth, between 1 and 12.

property year

year: number;

The four-digit year of birth.

interface Relationship

interface Relationship {}

property director

director?: boolean;

Whether the person is a director of the account's legal entity. Currently only required for accounts in the EU. Directors are typically members of the governing board of the company, or responsible for ensuring the company meets its regulatory obligations.

property executive

executive?: boolean;

Whether the person has significant responsibility to control, manage, or direct the organization.

property owner

owner?: boolean;

Whether the person is an owner of the account's legal entity.

property percent_ownership

percent_ownership?: number | null;

The percent owned by the person of the account's legal entity.

property representative

representative?: boolean;

Whether the person is authorized as the primary representative of the account. This is the person nominated by the business to provide information about themselves, and general information about the account. There can only be one representative at any given time. At the time the account is created, this person should be set to the person responsible for opening the account.

property title

title?: string;

The person's title (e.g., CEO, Support Engineer).

interface Verification

interface Verification {}

property additional_document

additional_document?: Verification.AdditionalDocument;

A document showing address, either a passport, local ID card, or utility bill from a well-known utility company.

property document

document?: Verification.Document;

An identifying document, either a passport or local ID card.

namespace TokenCreateParams.Person.Verification

namespace TokenCreateParams.Person.Verification {}

interface AdditionalDocument

interface AdditionalDocument {}

property back

back?: string;

The back of an ID returned by a [file upload](https://stripe.com/docs/api#create_file) with a purpose value of identity_document. The uploaded file needs to be a color image (smaller than 8,000px by 8,000px), in JPG, PNG, or PDF format, and less than 10 MB in size.

property front

front?: string;

The front of an ID returned by a [file upload](https://stripe.com/docs/api#create_file) with a purpose value of identity_document. The uploaded file needs to be a color image (smaller than 8,000px by 8,000px), in JPG, PNG, or PDF format, and less than 10 MB in size.

interface Document

interface Document {}

property back

back?: string;

The back of an ID returned by a [file upload](https://stripe.com/docs/api#create_file) with a purpose value of identity_document. The uploaded file needs to be a color image (smaller than 8,000px by 8,000px), in JPG, PNG, or PDF format, and less than 10 MB in size.

property front

front?: string;

The front of an ID returned by a [file upload](https://stripe.com/docs/api#create_file) with a purpose value of identity_document. The uploaded file needs to be a color image (smaller than 8,000px by 8,000px), in JPG, PNG, or PDF format, and less than 10 MB in size.

Package Files (48)

Dependencies (0)

No dependencies.

Peer Dependencies (0)

No peer dependencies.

Badge

To add a badge like this oneto your package's README, use the codes available below.

You may also use Shields.io to create a custom badge linking to https://www.jsdocs.io/package/@stripe/stripe-js.

Markdown

[![jsDocs.io](https://img.shields.io/badge/jsDocs.io-reference-blue)](https://www.jsdocs.io/package/@stripe/stripe-js)

HTML

<a href="https://www.jsdocs.io/package/@stripe/stripe-js"><img src="https://img.shields.io/badge/jsDocs.io-reference-blue" alt="jsDocs.io"></a>

Updated 4 days ago.
Package analyzed in 17371 ms.
Missing or incorrect documentation? Open an issue for this package.