stripe
Version:
Stripe API wrapper
1,400 lines (1,141 loc) • 119 kB
TypeScript
// File generated from our OpenAPI spec
declare module 'stripe' {
namespace Stripe {
namespace Checkout {
/**
* A Checkout Session represents your customer's session as they pay for
* one-time purchases or subscriptions through [Checkout](https://stripe.com/docs/payments/checkout)
* or [Payment Links](https://stripe.com/docs/payments/payment-links). We recommend creating a
* new Session each time your customer attempts to pay.
*
* Once payment is successful, the Checkout Session will contain a reference
* to the [Customer](https://stripe.com/docs/api/customers), and either the successful
* [PaymentIntent](https://stripe.com/docs/api/payment_intents) or an active
* [Subscription](https://stripe.com/docs/api/subscriptions).
*
* You can create a Checkout Session on your server and redirect to its URL
* to begin Checkout.
*
* Related guide: [Checkout quickstart](https://stripe.com/docs/checkout/quickstart)
*/
interface Session {
/**
* Unique identifier for the object.
*/
id: string;
/**
* String representing the object's type. Objects of the same type share the same value.
*/
object: 'checkout.session';
/**
* Settings for price localization with [Adaptive Pricing](https://docs.stripe.com/payments/checkout/adaptive-pricing).
*/
adaptive_pricing: Session.AdaptivePricing | null;
/**
* When set, provides configuration for actions to take if this Checkout Session expires.
*/
after_expiration: Session.AfterExpiration | null;
/**
* Enables user redeemable promotion codes.
*/
allow_promotion_codes: boolean | null;
/**
* Total of all items before discounts or taxes are applied.
*/
amount_subtotal: number | null;
/**
* Total of all items after discounts and taxes are applied.
*/
amount_total: number | null;
automatic_tax: Session.AutomaticTax;
/**
* Describes whether Checkout should collect the customer's billing address. Defaults to `auto`.
*/
billing_address_collection: Session.BillingAddressCollection | null;
branding_settings?: Session.BrandingSettings;
/**
* If set, Checkout displays a back button and customers will be directed to this URL if they decide to cancel payment and return to your website.
*/
cancel_url: string | null;
/**
* A unique string to reference the Checkout Session. This can be a
* customer ID, a cart ID, or similar, and can be used to reconcile the
* Session with your internal systems.
*/
client_reference_id: string | null;
/**
* The client secret of your Checkout Session. Applies to Checkout Sessions with `ui_mode: embedded` or `ui_mode: custom`. For `ui_mode: embedded`, the client secret is to be used when initializing Stripe.js embedded checkout.
* For `ui_mode: custom`, use the client secret with [initCheckout](https://stripe.com/docs/js/custom_checkout/init) on your front end.
*/
client_secret: string | null;
/**
* Information about the customer collected within the Checkout Session.
*/
collected_information: Session.CollectedInformation | null;
/**
* Results of `consent_collection` for this session.
*/
consent: Session.Consent | null;
/**
* When set, provides configuration for the Checkout Session to gather active consent from customers.
*/
consent_collection: Session.ConsentCollection | null;
/**
* Time at which the object was created. Measured in seconds since the Unix epoch.
*/
created: number;
/**
* 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).
*/
currency: string | null;
/**
* Currency conversion details for [Adaptive Pricing](https://docs.stripe.com/payments/checkout/adaptive-pricing) sessions created before 2025-03-31.
*/
currency_conversion: Session.CurrencyConversion | null;
/**
* Collect additional information from your customer using custom fields. Up to 3 fields are supported.
*/
custom_fields: Array<Session.CustomField>;
custom_text: Session.CustomText;
/**
* The ID of the customer for this Session.
* For Checkout Sessions in `subscription` mode or Checkout Sessions with `customer_creation` set as `always` in `payment` mode, Checkout
* will create a new customer object based on information provided
* during the payment flow unless an existing customer was provided when
* the Session was created.
*/
customer: string | Stripe.Customer | Stripe.DeletedCustomer | null;
/**
* Configure whether a Checkout Session creates a Customer when the Checkout Session completes.
*/
customer_creation: Session.CustomerCreation | null;
/**
* The customer details including the customer's tax exempt status and the customer's tax IDs. Customer's address details are not present on Sessions in `setup` mode.
*/
customer_details: Session.CustomerDetails | null;
/**
* If provided, this value will be used when the Customer object is created.
* If not provided, customers will be asked to enter their email address.
* Use this parameter to prefill customer data if you already have an email
* on file. To access information about the customer once the payment flow is
* complete, use the `customer` attribute.
*/
customer_email: string | null;
/**
* List of coupons and promotion codes attached to the Checkout Session.
*/
discounts: Array<Session.Discount> | null;
/**
* A list of the types of payment methods (e.g., `card`) that should be excluded from this Checkout Session. This should only be used when payment methods for this Checkout Session are managed through the [Stripe Dashboard](https://dashboard.stripe.com/settings/payment_methods).
*/
excluded_payment_method_types?: Array<string>;
/**
* The timestamp at which the Checkout Session will expire.
*/
expires_at: number;
/**
* ID of the invoice created by the Checkout Session, if it exists.
*/
invoice: string | Stripe.Invoice | null;
/**
* Details on the state of invoice creation for the Checkout Session.
*/
invoice_creation: Session.InvoiceCreation | null;
/**
* The line items purchased by the customer.
*/
line_items?: ApiList<Stripe.LineItem>;
/**
* Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.
*/
livemode: boolean;
/**
* The IETF language tag of the locale Checkout is displayed in. If blank or `auto`, the browser's locale is used.
*/
locale: Session.Locale | null;
/**
* Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
*/
metadata: Stripe.Metadata | null;
/**
* The mode of the Checkout Session.
*/
mode: Session.Mode;
name_collection?: Session.NameCollection;
/**
* The optional items presented to the customer at checkout.
*/
optional_items?: Array<Session.OptionalItem> | null;
/**
* Where the user is coming from. This informs the optimizations that are applied to the session.
*/
origin_context: Session.OriginContext | null;
/**
* The ID of the PaymentIntent for Checkout Sessions in `payment` mode. You can't confirm or cancel the PaymentIntent for a Checkout Session. To cancel, [expire the Checkout Session](https://stripe.com/docs/api/checkout/sessions/expire) instead.
*/
payment_intent: string | Stripe.PaymentIntent | null;
/**
* The ID of the Payment Link that created this Session.
*/
payment_link: string | Stripe.PaymentLink | null;
/**
* Configure whether a Checkout Session should collect a payment method. Defaults to `always`.
*/
payment_method_collection: Session.PaymentMethodCollection | null;
/**
* Information about the payment method configuration used for this Checkout session if using dynamic payment methods.
*/
payment_method_configuration_details: Session.PaymentMethodConfigurationDetails | null;
/**
* Payment-method-specific configuration for the PaymentIntent or SetupIntent of this CheckoutSession.
*/
payment_method_options: Session.PaymentMethodOptions | null;
/**
* A list of the types of payment methods (e.g. card) this Checkout
* Session is allowed to accept.
*/
payment_method_types: Array<string>;
/**
* The payment status of the Checkout Session, one of `paid`, `unpaid`, or `no_payment_required`.
* You can use this value to decide when to fulfill your customer's order.
*/
payment_status: Session.PaymentStatus;
/**
* This property is used to set up permissions for various actions (e.g., update) on the CheckoutSession object.
*
* For specific permissions, please refer to their dedicated subsections, such as `permissions.update_shipping_details`.
*/
permissions: Session.Permissions | null;
phone_number_collection?: Session.PhoneNumberCollection;
presentment_details?: Session.PresentmentDetails;
/**
* The ID of the original expired Checkout Session that triggered the recovery flow.
*/
recovered_from: string | null;
/**
* This parameter applies to `ui_mode: embedded`. Learn more about the [redirect behavior](https://stripe.com/docs/payments/checkout/custom-success-page?payment-ui=embedded-form) of embedded sessions. Defaults to `always`.
*/
redirect_on_completion?: Session.RedirectOnCompletion;
/**
* Applies to Checkout Sessions with `ui_mode: embedded` or `ui_mode: custom`. The URL to redirect your customer back to after they authenticate or cancel their payment on the payment method's app or site.
*/
return_url?: string;
/**
* Controls saved payment method settings for the session. Only available in `payment` and `subscription` mode.
*/
saved_payment_method_options: Session.SavedPaymentMethodOptions | null;
/**
* The ID of the SetupIntent for Checkout Sessions in `setup` mode. You can't confirm or cancel the SetupIntent for a Checkout Session. To cancel, [expire the Checkout Session](https://stripe.com/docs/api/checkout/sessions/expire) instead.
*/
setup_intent: string | Stripe.SetupIntent | null;
/**
* When set, provides configuration for Checkout to collect a shipping address from a customer.
*/
shipping_address_collection: Session.ShippingAddressCollection | null;
/**
* The details of the customer cost of shipping, including the customer chosen ShippingRate.
*/
shipping_cost: Session.ShippingCost | null;
/**
* The shipping rate options applied to this Session.
*/
shipping_options: Array<Session.ShippingOption>;
/**
* The status of the Checkout Session, one of `open`, `complete`, or `expired`.
*/
status: Session.Status | null;
/**
* Describes the type of transaction being performed by Checkout in order to customize
* relevant text on the page, such as the submit button. `submit_type` can only be
* specified on Checkout Sessions in `payment` mode. If blank or `auto`, `pay` is used.
*/
submit_type: Session.SubmitType | null;
/**
* The ID of the [Subscription](https://stripe.com/docs/api/subscriptions) for Checkout Sessions in `subscription` mode.
*/
subscription: string | Stripe.Subscription | null;
/**
* The URL the customer will be directed to after the payment or
* subscription creation is successful.
*/
success_url: string | null;
tax_id_collection?: Session.TaxIdCollection;
/**
* Tax and discount details for the computed total amount.
*/
total_details: Session.TotalDetails | null;
/**
* The UI mode of the Session. Defaults to `hosted`.
*/
ui_mode: Session.UiMode | null;
/**
* The URL to the Checkout Session. Applies to Checkout Sessions with `ui_mode: hosted`. Redirect customers to this URL to take them to Checkout. If you're using [Custom Domains](https://stripe.com/docs/payments/checkout/custom-domains), the URL will use your subdomain. Otherwise, it'll use `checkout.stripe.com.`
* This value is only present when the session is active.
*/
url: string | null;
/**
* Wallet-specific configuration for this Checkout Session.
*/
wallet_options: Session.WalletOptions | null;
}
namespace Session {
interface AdaptivePricing {
/**
* If enabled, Adaptive Pricing is available on [eligible sessions](https://docs.stripe.com/payments/currencies/localize-prices/adaptive-pricing?payment-ui=stripe-hosted#restrictions).
*/
enabled: boolean;
}
interface AfterExpiration {
/**
* When set, configuration used to recover the Checkout Session on expiry.
*/
recovery: AfterExpiration.Recovery | null;
}
namespace AfterExpiration {
interface Recovery {
/**
* Enables user redeemable promotion codes on the recovered Checkout Sessions. Defaults to `false`
*/
allow_promotion_codes: boolean;
/**
* If `true`, a recovery url will be generated to recover this Checkout Session if it
* expires before a transaction is completed. It will be attached to the
* Checkout Session object upon expiration.
*/
enabled: boolean;
/**
* The timestamp at which the recovery URL will expire.
*/
expires_at: number | null;
/**
* URL that creates a new Checkout Session when clicked that is a copy of this expired Checkout Session
*/
url: string | null;
}
}
interface AutomaticTax {
/**
* Indicates whether automatic tax is enabled for the session
*/
enabled: boolean;
/**
* The account that's liable for tax. If set, the business address and tax registrations required to perform the tax calculation are loaded from this account. The tax transaction is returned in the report of the connected account.
*/
liability: AutomaticTax.Liability | null;
/**
* The tax provider powering automatic tax.
*/
provider: string | null;
/**
* The status of the most recent automated tax calculation for this session.
*/
status: AutomaticTax.Status | null;
}
namespace AutomaticTax {
interface Liability {
/**
* The connected account being referenced when `type` is `account`.
*/
account?: string | Stripe.Account;
/**
* Type of the account referenced.
*/
type: Liability.Type;
}
namespace Liability {
type Type = 'account' | 'self';
}
type Status = 'complete' | 'failed' | 'requires_location_inputs';
}
type BillingAddressCollection = 'auto' | 'required';
interface BrandingSettings {
/**
* A hex color value starting with `#` representing the background color for the Checkout Session.
*/
background_color: string;
/**
* The border style for the Checkout Session. Must be one of `rounded`, `rectangular`, or `pill`.
*/
border_style: BrandingSettings.BorderStyle;
/**
* A hex color value starting with `#` representing the button color for the Checkout Session.
*/
button_color: string;
/**
* The display name shown on the Checkout Session.
*/
display_name: string;
/**
* The font family for the Checkout Session. Must be one of the [supported font families](https://docs.stripe.com/payments/checkout/customization/appearance?payment-ui=stripe-hosted#font-compatibility).
*/
font_family: string;
/**
* The icon for the Checkout Session. You cannot set both `logo` and `icon`.
*/
icon: BrandingSettings.Icon | null;
/**
* The logo for the Checkout Session. You cannot set both `logo` and `icon`.
*/
logo: BrandingSettings.Logo | null;
}
namespace BrandingSettings {
type BorderStyle = 'pill' | 'rectangular' | 'rounded';
interface Icon {
/**
* The ID of a [File upload](https://stripe.com/docs/api/files) representing the icon. Purpose must be `business_icon`. Required if `type` is `file` and disallowed otherwise.
*/
file?: string;
/**
* The type of image for the icon. Must be one of `file` or `url`.
*/
type: Icon.Type;
/**
* The URL of the image. Present when `type` is `url`.
*/
url?: string;
}
namespace Icon {
type Type = 'file' | 'url';
}
interface Logo {
/**
* The ID of a [File upload](https://stripe.com/docs/api/files) representing the logo. Purpose must be `business_logo`. Required if `type` is `file` and disallowed otherwise.
*/
file?: string;
/**
* The type of image for the logo. Must be one of `file` or `url`.
*/
type: Logo.Type;
/**
* The URL of the image. Present when `type` is `url`.
*/
url?: string;
}
namespace Logo {
type Type = 'file' | 'url';
}
}
interface CollectedInformation {
/**
* Customer's business name for this Checkout Session
*/
business_name: string | null;
/**
* Customer's individual name for this Checkout Session
*/
individual_name: string | null;
/**
* Shipping information for this Checkout Session.
*/
shipping_details: CollectedInformation.ShippingDetails | null;
}
namespace CollectedInformation {
interface ShippingDetails {
address: Stripe.Address;
/**
* Customer name.
*/
name: string;
}
}
interface Consent {
/**
* If `opt_in`, the customer consents to receiving promotional communications
* from the merchant about this Checkout Session.
*/
promotions: Consent.Promotions | null;
/**
* If `accepted`, the customer in this Checkout Session has agreed to the merchant's terms of service.
*/
terms_of_service: 'accepted' | null;
}
namespace Consent {
type Promotions = 'opt_in' | 'opt_out';
}
interface ConsentCollection {
/**
* If set to `hidden`, it will hide legal text related to the reuse of a payment method.
*/
payment_method_reuse_agreement: ConsentCollection.PaymentMethodReuseAgreement | null;
/**
* If set to `auto`, enables the collection of customer consent for promotional communications. The Checkout
* Session will determine whether to display an option to opt into promotional communication
* from the merchant depending on the customer's locale. Only available to US merchants.
*/
promotions: ConsentCollection.Promotions | null;
/**
* If set to `required`, it requires customers to accept the terms of service before being able to pay.
*/
terms_of_service: ConsentCollection.TermsOfService | null;
}
namespace ConsentCollection {
interface PaymentMethodReuseAgreement {
/**
* Determines the position and visibility of the payment method reuse agreement in the UI. When set to `auto`, Stripe's defaults will be used.
*
* When set to `hidden`, the payment method reuse agreement text will always be hidden in the UI.
*/
position: PaymentMethodReuseAgreement.Position;
}
namespace PaymentMethodReuseAgreement {
type Position = 'auto' | 'hidden';
}
type Promotions = 'auto' | 'none';
type TermsOfService = 'none' | 'required';
}
interface CurrencyConversion {
/**
* Total of all items in source currency before discounts or taxes are applied.
*/
amount_subtotal: number;
/**
* Total of all items in source currency after discounts and taxes are applied.
*/
amount_total: number;
/**
* Exchange rate used to convert source currency amounts to customer currency amounts
*/
fx_rate: string;
/**
* Creation currency of the CheckoutSession before localization
*/
source_currency: string;
}
type CustomerCreation = 'always' | 'if_required';
interface CustomerDetails {
/**
* The customer's address after a completed Checkout Session. Note: This property is populated only for sessions on or after March 30, 2022.
*/
address: Stripe.Address | null;
/**
* The customer's business name after a completed Checkout Session.
*/
business_name: string | null;
/**
* The email associated with the Customer, if one exists, on the Checkout Session after a completed Checkout Session or at time of session expiry.
* Otherwise, if the customer has consented to promotional content, this value is the most recent valid email provided by the customer on the Checkout form.
*/
email: string | null;
/**
* The customer's individual name after a completed Checkout Session.
*/
individual_name: string | null;
/**
* The customer's name after a completed Checkout Session. Note: This property is populated only for sessions on or after March 30, 2022.
*/
name: string | null;
/**
* The customer's phone number after a completed Checkout Session.
*/
phone: string | null;
/**
* The customer's tax exempt status after a completed Checkout Session.
*/
tax_exempt: CustomerDetails.TaxExempt | null;
/**
* The customer's tax IDs after a completed Checkout Session.
*/
tax_ids: Array<CustomerDetails.TaxId> | null;
}
namespace CustomerDetails {
type TaxExempt = 'exempt' | 'none' | 'reverse';
interface TaxId {
/**
* The type of the tax ID, one of `ad_nrt`, `ar_cuit`, `eu_vat`, `bo_tin`, `br_cnpj`, `br_cpf`, `cn_tin`, `co_nit`, `cr_tin`, `do_rcn`, `ec_ruc`, `eu_oss_vat`, `hr_oib`, `pe_ruc`, `ro_tin`, `rs_pib`, `sv_nit`, `uy_ruc`, `ve_rif`, `vn_tin`, `gb_vat`, `nz_gst`, `au_abn`, `au_arn`, `in_gst`, `no_vat`, `no_voec`, `za_vat`, `ch_vat`, `mx_rfc`, `sg_uen`, `ru_inn`, `ru_kpp`, `ca_bn`, `hk_br`, `es_cif`, `tw_vat`, `th_vat`, `jp_cn`, `jp_rn`, `jp_trn`, `li_uid`, `li_vat`, `my_itn`, `us_ein`, `kr_brn`, `ca_qst`, `ca_gst_hst`, `ca_pst_bc`, `ca_pst_mb`, `ca_pst_sk`, `my_sst`, `sg_gst`, `ae_trn`, `cl_tin`, `sa_vat`, `id_npwp`, `my_frp`, `il_vat`, `ge_vat`, `ua_vat`, `is_vat`, `bg_uic`, `hu_tin`, `si_tin`, `ke_pin`, `tr_tin`, `eg_tin`, `ph_tin`, `al_tin`, `bh_vat`, `kz_bin`, `ng_tin`, `om_vat`, `de_stn`, `ch_uid`, `tz_vat`, `uz_vat`, `uz_tin`, `md_vat`, `ma_vat`, `by_tin`, `ao_tin`, `bs_tin`, `bb_tin`, `cd_nif`, `mr_nif`, `me_pib`, `zw_tin`, `ba_tin`, `gn_nif`, `mk_vat`, `sr_fin`, `sn_ninea`, `am_tin`, `np_pan`, `tj_tin`, `ug_tin`, `zm_tin`, `kh_tin`, `aw_tin`, `az_tin`, `bd_bin`, `bj_ifu`, `et_tin`, `kg_tin`, `la_tin`, `cm_niu`, `cv_nif`, `bf_ifu`, or `unknown`
*/
type: TaxId.Type;
/**
* The value of the tax ID.
*/
value: string | null;
}
namespace TaxId {
type Type =
| 'ad_nrt'
| 'ae_trn'
| 'al_tin'
| 'am_tin'
| 'ao_tin'
| 'ar_cuit'
| 'au_abn'
| 'au_arn'
| 'aw_tin'
| 'az_tin'
| 'ba_tin'
| 'bb_tin'
| 'bd_bin'
| 'bf_ifu'
| 'bg_uic'
| 'bh_vat'
| 'bj_ifu'
| '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'
| 'cm_niu'
| 'cn_tin'
| 'co_nit'
| 'cr_tin'
| 'cv_nif'
| 'de_stn'
| 'do_rcn'
| 'ec_ruc'
| 'eg_tin'
| 'es_cif'
| 'et_tin'
| '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'
| 'kg_tin'
| 'kh_tin'
| 'kr_brn'
| 'kz_bin'
| 'la_tin'
| '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'
| 'unknown'
| 'us_ein'
| 'uy_ruc'
| 'uz_tin'
| 'uz_vat'
| 've_rif'
| 'vn_tin'
| 'za_vat'
| 'zm_tin'
| 'zw_tin';
}
}
interface CustomField {
dropdown?: CustomField.Dropdown;
/**
* String of your choice that your integration can use to reconcile this field. Must be unique to this field, alphanumeric, and up to 200 characters.
*/
key: string;
label: CustomField.Label;
numeric?: CustomField.Numeric;
/**
* Whether the customer is required to complete the field before completing the Checkout Session. Defaults to `false`.
*/
optional: boolean;
text?: CustomField.Text;
/**
* The type of the field.
*/
type: CustomField.Type;
}
namespace CustomField {
interface Dropdown {
/**
* The value that will pre-fill on the payment page.
*/
default_value: string | null;
/**
* The options available for the customer to select. Up to 200 options allowed.
*/
options: Array<Dropdown.Option>;
/**
* The option selected by the customer. This will be the `value` for the option.
*/
value: string | null;
}
namespace Dropdown {
interface Option {
/**
* The label for the option, displayed to the customer. Up to 100 characters.
*/
label: string;
/**
* The value for this option, not displayed to the customer, used by your integration to reconcile the option selected by the customer. Must be unique to this option, alphanumeric, and up to 100 characters.
*/
value: string;
}
}
interface Label {
/**
* Custom text for the label, displayed to the customer. Up to 50 characters.
*/
custom: string | null;
/**
* The type of the label.
*/
type: 'custom';
}
interface Numeric {
/**
* The value that will pre-fill the field on the payment page.
*/
default_value: string | null;
/**
* The maximum character length constraint for the customer's input.
*/
maximum_length: number | null;
/**
* The minimum character length requirement for the customer's input.
*/
minimum_length: number | null;
/**
* The value entered by the customer, containing only digits.
*/
value: string | null;
}
interface Text {
/**
* The value that will pre-fill the field on the payment page.
*/
default_value: string | null;
/**
* The maximum character length constraint for the customer's input.
*/
maximum_length: number | null;
/**
* The minimum character length requirement for the customer's input.
*/
minimum_length: number | null;
/**
* The value entered by the customer.
*/
value: string | null;
}
type Type = 'dropdown' | 'numeric' | 'text';
}
interface CustomText {
/**
* Custom text that should be displayed after the payment confirmation button.
*/
after_submit: CustomText.AfterSubmit | null;
/**
* Custom text that should be displayed alongside shipping address collection.
*/
shipping_address: CustomText.ShippingAddress | null;
/**
* Custom text that should be displayed alongside the payment confirmation button.
*/
submit: CustomText.Submit | null;
/**
* Custom text that should be displayed in place of the default terms of service agreement text.
*/
terms_of_service_acceptance: CustomText.TermsOfServiceAcceptance | null;
}
namespace CustomText {
interface AfterSubmit {
/**
* Text may be up to 1200 characters in length.
*/
message: string;
}
interface ShippingAddress {
/**
* Text may be up to 1200 characters in length.
*/
message: string;
}
interface Submit {
/**
* Text may be up to 1200 characters in length.
*/
message: string;
}
interface TermsOfServiceAcceptance {
/**
* Text may be up to 1200 characters in length.
*/
message: string;
}
}
interface Discount {
/**
* Coupon attached to the Checkout Session.
*/
coupon: string | Stripe.Coupon | null;
/**
* Promotion code attached to the Checkout Session.
*/
promotion_code: string | Stripe.PromotionCode | null;
}
interface InvoiceCreation {
/**
* Indicates whether invoice creation is enabled for the Checkout Session.
*/
enabled: boolean;
invoice_data: InvoiceCreation.InvoiceData;
}
namespace InvoiceCreation {
interface InvoiceData {
/**
* The account tax IDs associated with the invoice.
*/
account_tax_ids: Array<
string | Stripe.TaxId | Stripe.DeletedTaxId
> | null;
/**
* Custom fields displayed on the invoice.
*/
custom_fields: Array<InvoiceData.CustomField> | null;
/**
* An arbitrary string attached to the object. Often useful for displaying to users.
*/
description: string | null;
/**
* Footer displayed on the invoice.
*/
footer: string | null;
/**
* The connected account that issues the invoice. The invoice is presented with the branding and support information of the specified account.
*/
issuer: InvoiceData.Issuer | null;
/**
* Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
*/
metadata: Stripe.Metadata | null;
/**
* Options for invoice PDF rendering.
*/
rendering_options: InvoiceData.RenderingOptions | null;
}
namespace InvoiceData {
interface CustomField {
/**
* The name of the custom field.
*/
name: string;
/**
* The value of the custom field.
*/
value: string;
}
interface Issuer {
/**
* The connected account being referenced when `type` is `account`.
*/
account?: string | Stripe.Account;
/**
* Type of the account referenced.
*/
type: Issuer.Type;
}
namespace Issuer {
type Type = 'account' | 'self';
}
interface RenderingOptions {
/**
* How line-item prices and amounts will be displayed with respect to tax on invoice PDFs.
*/
amount_tax_display: string | null;
/**
* ID of the invoice rendering template to be used for the generated invoice.
*/
template: string | null;
}
}
}
type Locale =
| 'auto'
| 'bg'
| 'cs'
| 'da'
| 'de'
| 'el'
| 'en'
| 'en-GB'
| 'es'
| 'es-419'
| 'et'
| 'fi'
| 'fil'
| 'fr'
| 'fr-CA'
| 'hr'
| 'hu'
| 'id'
| 'it'
| 'ja'
| 'ko'
| 'lt'
| 'lv'
| 'ms'
| 'mt'
| 'nb'
| 'nl'
| 'pl'
| 'pt'
| 'pt-BR'
| 'ro'
| 'ru'
| 'sk'
| 'sl'
| 'sv'
| 'th'
| 'tr'
| 'vi'
| 'zh'
| 'zh-HK'
| 'zh-TW';
type Mode = 'payment' | 'setup' | 'subscription';
interface NameCollection {
business?: NameCollection.Business;
individual?: NameCollection.Individual;
}
namespace NameCollection {
interface Business {
/**
* Indicates whether business name collection is enabled for the session
*/
enabled: boolean;
/**
* Whether the customer is required to complete the field before completing the Checkout Session. Defaults to `false`.
*/
optional: boolean;
}
interface Individual {
/**
* Indicates whether individual name collection is enabled for the session
*/
enabled: boolean;
/**
* Whether the customer is required to complete the field before completing the Checkout Session. Defaults to `false`.
*/
optional: boolean;
}
}
interface OptionalItem {
adjustable_quantity: OptionalItem.AdjustableQuantity | null;
price: string;
quantity: number;
}
namespace OptionalItem {
interface AdjustableQuantity {
/**
* Set to true if the quantity can be adjusted to any non-negative integer.
*/
enabled: boolean;
/**
* The maximum quantity of this item the customer can purchase. By default this value is 99. You can specify a value up to 999999.
*/
maximum: number | null;
/**
* The minimum quantity of this item the customer must purchase, if they choose to purchase it. Because this item is optional, the customer will always be able to remove it from their order, even if the `minimum` configured here is greater than 0. By default this value is 0.
*/
minimum: number | null;
}
}
type OriginContext = 'mobile_app' | 'web';
type PaymentMethodCollection = 'always' | 'if_required';
interface PaymentMethodConfigurationDetails {
/**
* ID of the payment method configuration used.
*/
id: string;
/**
* ID of the parent payment method configuration used.
*/
parent: string | null;
}
interface PaymentMethodOptions {
acss_debit?: PaymentMethodOptions.AcssDebit;
affirm?: PaymentMethodOptions.Affirm;
afterpay_clearpay?: PaymentMethodOptions.AfterpayClearpay;
alipay?: PaymentMethodOptions.Alipay;
alma?: PaymentMethodOptions.Alma;
amazon_pay?: PaymentMethodOptions.AmazonPay;
au_becs_debit?: PaymentMethodOptions.AuBecsDebit;
bacs_debit?: PaymentMethodOptions.BacsDebit;
bancontact?: PaymentMethodOptions.Bancontact;
billie?: PaymentMethodOptions.Billie;
boleto?: PaymentMethodOptions.Boleto;
card?: PaymentMethodOptions.Card;
cashapp?: PaymentMethodOptions.Cashapp;
customer_balance?: PaymentMethodOptions.CustomerBalance;
eps?: PaymentMethodOptions.Eps;
fpx?: PaymentMethodOptions.Fpx;
giropay?: PaymentMethodOptions.Giropay;
grabpay?: PaymentMethodOptions.Grabpay;
ideal?: PaymentMethodOptions.Ideal;
kakao_pay?: PaymentMethodOptions.KakaoPay;
klarna?: PaymentMethodOptions.Klarna;
konbini?: PaymentMethodOptions.Konbini;
kr_card?: PaymentMethodOptions.KrCard;
link?: PaymentMethodOptions.Link;
mobilepay?: PaymentMethodOptions.Mobilepay;
multibanco?: PaymentMethodOptions.Multibanco;
naver_pay?: PaymentMethodOptions.NaverPay;
oxxo?: PaymentMethodOptions.Oxxo;
p24?: PaymentMethodOptions.P24;
payco?: PaymentMethodOptions.Payco;
paynow?: PaymentMethodOptions.Paynow;
paypal?: PaymentMethodOptions.Paypal;
pix?: PaymentMethodOptions.Pix;
revolut_pay?: PaymentMethodOptions.RevolutPay;
samsung_pay?: PaymentMethodOptions.SamsungPay;
satispay?: PaymentMethodOptions.Satispay;
sepa_debit?: PaymentMethodOptions.SepaDebit;
sofort?: PaymentMethodOptions.Sofort;
swish?: PaymentMethodOptions.Swish;
twint?: PaymentMethodOptions.Twint;
us_bank_account?: PaymentMethodOptions.UsBankAccount;
}
namespace PaymentMethodOptions {
interface AcssDebit {
/**
* Currency supported by the bank account. Returned when the Session is in `setup` mode.
*/
currency?: AcssDebit.Currency;
mandate_options?: AcssDebit.MandateOptions;
/**
* Indicates that you intend to make future payments with this PaymentIntent's payment method.
*
* If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](https://docs.stripe.com/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](https://docs.stripe.com/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
*
* If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](https://docs.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
*
* When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](https://docs.stripe.com/strong-customer-authentication).
*/
setup_future_usage?: AcssDebit.SetupFutureUsage;
/**
* Controls when Stripe will attempt to debit the funds from the customer's account. The date must be a string in YYYY-MM-DD format. The date must be in the future and between 3 and 15 calendar days from now.
*/
target_date?: string;
/**
* Bank account verification method.
*/
verification_method?: AcssDebit.VerificationMethod;
}
namespace AcssDebit {
type Currency = 'cad' | 'usd';
interface MandateOptions {
/**
* A URL for custom mandate text
*/
custom_mandate_url?: string;
/**
* List of Stripe products where this mandate can be selected automatically. Returned when the Session is in `setup` mode.
*/
default_for?: Array<MandateOptions.DefaultFor>;
/**
* Description of the interval. Only required if the 'payment_schedule' parameter is 'interval' or 'combined'.
*/
interval_description: string | null;
/**
* Payment schedule for the mandate.
*/
payment_schedule: MandateOptions.PaymentSchedule | null;
/**
* Transaction type of the mandate.
*/
transaction_type: MandateOptions.TransactionType | null;
}
namespace MandateOptions {
type DefaultFor = 'invoice' | 'subscription';
type PaymentSchedule = 'combined' | 'interval' | 'sporadic';
type TransactionType = 'business' | 'personal';
}
type SetupFutureUsage = 'none' | 'off_session' | 'on_session';
type VerificationMethod = 'automatic' | 'instant' | 'microdeposits';
}
interface Affirm {
/**
* Controls when the funds will be captured from the customer's account.
*/
capture_method?: 'manual';
/**
* Indicates that you intend to make future payments with this PaymentIntent's payment method.
*
* If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](https://docs.stripe.com/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](https://docs.stripe.com/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
*
* If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](https://docs.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
*
* When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](https://docs.stripe.com/strong-customer-authentication).
*/
setup_future_usage?: 'none';
}
interface AfterpayClearpay {
/**
* Controls when the funds will be captured from the customer's account.
*/
capture_method?: 'manual';
/**
* Indicates that you intend to make future payments with this PaymentIntent's payment method.
*
* If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](https://docs.stripe.com/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](https://docs.stripe.com/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
*
* If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](https://docs.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
*
* When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](https://docs.stripe.com/strong-customer-authentication).
*/
setup_future_usage?: 'none';
}
interface Alipay {
/**
* Indicates that you intend to make future payments with this PaymentIntent's payment method.
*
* If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](https://docs.stripe.com/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](https://docs.stripe.com/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
*
* If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](https://docs.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
*
* When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](https://docs.stripe.com/strong-customer-authentication).
*/
setup_future_usage?: 'none';
}
interface Alma {
/**
* Controls when the funds will be captured from the customer's account.
*/
capture_method?: 'manual';