@stripe/stripe-js

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.

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.

property line1

line1: string;

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

property disableAnimations

disableAnimations?: boolean;

property labels

labels?: 'above' | 'floating';

property rules

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

property theme

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

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
    borderRadius?: string;
};

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

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.

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

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.

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';

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;

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;

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)

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 clientSecret

clientSecret: string;

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

property clientSecret

clientSecret: string;

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

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.

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.

property skipMandate

skipMandate?: boolean;

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

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.

property skipMandate

skipMandate?: boolean;

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

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.

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.