stripe
Version:
Stripe API wrapper
1,260 lines (1,048 loc) • 147 kB
TypeScript
// File generated from our OpenAPI spec
declare module 'stripe' {
namespace Stripe {
namespace Checkout {
interface SessionCreateParams {
/**
* Settings for price localization with [Adaptive Pricing](https://docs.stripe.com/payments/checkout/adaptive-pricing).
*/
adaptive_pricing?: SessionCreateParams.AdaptivePricing;
/**
* Configure actions after a Checkout Session has expired.
*/
after_expiration?: SessionCreateParams.AfterExpiration;
/**
* Enables user redeemable promotion codes.
*/
allow_promotion_codes?: boolean;
/**
* Settings for automatic tax lookup for this session and resulting payments, invoices, and subscriptions.
*/
automatic_tax?: SessionCreateParams.AutomaticTax;
/**
* Specify whether Checkout should collect the customer's billing address. Defaults to `auto`.
*/
billing_address_collection?: SessionCreateParams.BillingAddressCollection;
/**
* 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. This parameter is not allowed if ui_mode is `embedded` or `custom`.
*/
cancel_url?: string;
/**
* 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;
/**
* Configure fields for the Checkout Session to gather active consent from customers.
*/
consent_collection?: SessionCreateParams.ConsentCollection;
/**
* 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). Required in `setup` mode when `payment_method_types` is not set.
*/
currency?: string;
/**
* Collect additional information from your customer using custom fields. Up to 3 fields are supported.
*/
custom_fields?: Array<SessionCreateParams.CustomField>;
/**
* Display additional text for your customers using custom text.
*/
custom_text?: SessionCreateParams.CustomText;
/**
* ID of an existing Customer, if one exists. In `payment` mode, the customer's most recently saved card
* payment method will be used to prefill the email, name, card details, and billing address
* on the Checkout page. In `subscription` mode, the customer's [default payment method](https://stripe.com/docs/api/customers/update#update_customer-invoice_settings-default_payment_method)
* will be used if it's a card, otherwise the most recently saved card will be used. A valid billing address, billing name and billing email are required on the payment method for Checkout to prefill the customer's card details.
*
* If the Customer already has a valid [email](https://stripe.com/docs/api/customers/object#customer_object-email) set, the email will be prefilled and not editable in Checkout.
* If the Customer does not have a valid `email`, Checkout will set the email entered during the session on the Customer.
*
* If blank for Checkout Sessions in `subscription` mode or with `customer_creation` set as `always` in `payment` mode, Checkout will create a new Customer object based on information provided during the payment flow.
*
* You can set [`payment_intent_data.setup_future_usage`](https://stripe.com/docs/api/checkout/sessions/create#create_checkout_session-payment_intent_data-setup_future_usage) to have Checkout automatically attach the payment method to the Customer you pass in for future reuse.
*/
customer?: string;
/**
* Configure whether a Checkout Session creates a [Customer](https://stripe.com/docs/api/customers) during Session confirmation.
*
* When a Customer is not created, you can still retrieve email, address, and other customer data entered in Checkout
* with [customer_details](https://stripe.com/docs/api/checkout/sessions/object#checkout_session_object-customer_details).
*
* Sessions that don't create Customers instead are grouped by [guest customers](https://stripe.com/docs/payments/checkout/guest-customers)
* in the Dashboard. Promotion codes limited to first time customers will return invalid for these Sessions.
*
* Can only be set in `payment` and `setup` mode.
*/
customer_creation?: SessionCreateParams.CustomerCreation;
/**
* 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 a session is
* complete, use the `customer` field.
*/
customer_email?: string;
/**
* Controls what fields on Customer can be updated by the Checkout Session. Can only be provided when `customer` is provided.
*/
customer_update?: SessionCreateParams.CustomerUpdate;
/**
* The coupon or promotion code to apply to this Session. Currently, only up to one may be specified.
*/
discounts?: Array<SessionCreateParams.Discount>;
/**
* Specifies which fields in the response should be expanded.
*/
expand?: Array<string>;
/**
* The Epoch time in seconds at which the Checkout Session will expire. It can be anywhere from 30 minutes to 24 hours after Checkout Session creation. By default, this value is 24 hours from creation.
*/
expires_at?: number;
/**
* Generate a post-purchase Invoice for one-time payments.
*/
invoice_creation?: SessionCreateParams.InvoiceCreation;
/**
* A list of items the customer is purchasing. Use this parameter to pass one-time or recurring [Prices](https://stripe.com/docs/api/prices). The parameter is required for `payment` and `subscription` mode.
*
* For `payment` mode, there is a maximum of 100 line items, however it is recommended to consolidate line items if there are more than a few dozen.
*
* For `subscription` mode, there is a maximum of 20 line items with recurring Prices and 20 line items with one-time Prices. Line items with one-time Prices will be on the initial invoice only.
*/
line_items?: Array<SessionCreateParams.LineItem>;
/**
* The IETF language tag of the locale Checkout is displayed in. If blank or `auto`, the browser's locale is used.
*/
locale?: SessionCreateParams.Locale;
/**
* 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. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.
*/
metadata?: Stripe.MetadataParam;
/**
* The mode of the Checkout Session. Pass `subscription` if the Checkout Session includes at least one recurring item.
*/
mode?: SessionCreateParams.Mode;
/**
* A list of optional items the customer can add to their order at checkout. Use this parameter to pass one-time or recurring [Prices](https://stripe.com/docs/api/prices).
*
* There is a maximum of 10 optional items allowed on a Checkout Session, and the existing limits on the number of line items allowed on a Checkout Session apply to the combined number of line items and optional items.
*
* For `payment` mode, there is a maximum of 100 combined line items and optional items, however it is recommended to consolidate items if there are more than a few dozen.
*
* For `subscription` mode, there is a maximum of 20 line items and optional items with recurring Prices and 20 line items and optional items with one-time Prices.
*/
optional_items?: Array<SessionCreateParams.OptionalItem>;
/**
* Where the user is coming from. This informs the optimizations that are applied to the session.
*/
origin_context?: SessionCreateParams.OriginContext;
/**
* A subset of parameters to be passed to PaymentIntent creation for Checkout Sessions in `payment` mode.
*/
payment_intent_data?: SessionCreateParams.PaymentIntentData;
/**
* Specify whether Checkout should collect a payment method. When set to `if_required`, Checkout will not collect a payment method when the total due for the session is 0.
* This may occur if the Checkout Session includes a free trial or a discount.
*
* Can only be set in `subscription` mode. Defaults to `always`.
*
* If you'd like information on how to collect a payment method outside of Checkout, read the guide on configuring [subscriptions with a free trial](https://stripe.com/docs/payments/checkout/free-trials).
*/
payment_method_collection?: SessionCreateParams.PaymentMethodCollection;
/**
* The ID of the payment method configuration to use with this Checkout session.
*/
payment_method_configuration?: string;
/**
* This parameter allows you to set some attributes on the payment method created during a Checkout session.
*/
payment_method_data?: SessionCreateParams.PaymentMethodData;
/**
* Payment-method-specific configuration.
*/
payment_method_options?: SessionCreateParams.PaymentMethodOptions;
/**
* A list of the types of payment methods (e.g., `card`) this Checkout Session can accept.
*
* You can omit this attribute to manage your payment methods from the [Stripe Dashboard](https://dashboard.stripe.com/settings/payment_methods).
* See [Dynamic Payment Methods](https://stripe.com/docs/payments/payment-methods/integration-options#using-dynamic-payment-methods) for more details.
*
* Read more about the supported payment methods and their requirements in our [payment
* method details guide](https://docs.stripe.com/docs/payments/checkout/payment-methods).
*
* If multiple payment methods are passed, Checkout will dynamically reorder them to
* prioritize the most relevant payment methods based on the customer's location and
* other characteristics.
*/
payment_method_types?: Array<SessionCreateParams.PaymentMethodType>;
/**
* This property is used to set up permissions for various actions (e.g., update) on the CheckoutSession object. Can only be set when creating `embedded` or `custom` sessions.
*
* For specific permissions, please refer to their dedicated subsections, such as `permissions.update_shipping_details`.
*/
permissions?: SessionCreateParams.Permissions;
/**
* Controls phone number collection settings for the session.
*
* We recommend that you review your privacy policy and check with your legal contacts
* before using this feature. Learn more about [collecting phone numbers with Checkout](https://stripe.com/docs/payments/checkout/phone-numbers).
*/
phone_number_collection?: SessionCreateParams.PhoneNumberCollection;
/**
* 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?: SessionCreateParams.RedirectOnCompletion;
/**
* The URL to redirect your customer back to after they authenticate or cancel their payment on the
* payment method's app or site. This parameter is required if `ui_mode` is `embedded` or `custom`
* and redirect-based payment methods are enabled on the session.
*/
return_url?: string;
/**
* Controls saved payment method settings for the session. Only available in `payment` and `subscription` mode.
*/
saved_payment_method_options?: SessionCreateParams.SavedPaymentMethodOptions;
/**
* A subset of parameters to be passed to SetupIntent creation for Checkout Sessions in `setup` mode.
*/
setup_intent_data?: SessionCreateParams.SetupIntentData;
/**
* When set, provides configuration for Checkout to collect a shipping address from a customer.
*/
shipping_address_collection?: SessionCreateParams.ShippingAddressCollection;
/**
* The shipping rate options to apply to this Session. Up to a maximum of 5.
*/
shipping_options?: Array<SessionCreateParams.ShippingOption>;
/**
* 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` or `subscription` mode. If blank or `auto`, `pay` is used.
*/
submit_type?: SessionCreateParams.SubmitType;
/**
* A subset of parameters to be passed to subscription creation for Checkout Sessions in `subscription` mode.
*/
subscription_data?: SessionCreateParams.SubscriptionData;
/**
* The URL to which Stripe should send customers when payment or setup
* is complete.
* This parameter is not allowed if ui_mode is `embedded` or `custom`. If you'd like to use
* information from the successful Checkout Session on your page, read the
* guide on [customizing your success page](https://stripe.com/docs/payments/checkout/custom-success-page).
*/
success_url?: string;
/**
* Controls tax ID collection during checkout.
*/
tax_id_collection?: SessionCreateParams.TaxIdCollection;
/**
* The UI mode of the Session. Defaults to `hosted`.
*/
ui_mode?: SessionCreateParams.UiMode;
/**
* Wallet-specific configuration.
*/
wallet_options?: SessionCreateParams.WalletOptions;
}
namespace SessionCreateParams {
interface AdaptivePricing {
/**
* If set to `true`, Adaptive Pricing is available on [eligible sessions](https://docs.stripe.com/payments/currencies/localize-prices/adaptive-pricing?payment-ui=stripe-hosted#restrictions). Defaults to your [dashboard setting](https://dashboard.stripe.com/settings/adaptive-pricing).
*/
enabled?: boolean;
}
interface AfterExpiration {
/**
* Configure a Checkout Session that can be used to recover an expired session.
*/
recovery?: AfterExpiration.Recovery;
}
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 successful transaction is completed. It will be attached to the
* Checkout Session object upon expiration.
*/
enabled: boolean;
}
}
interface AutomaticTax {
/**
* Set to `true` to [calculate tax automatically](https://docs.stripe.com/tax) using the customer's location.
*
* Enabling this parameter causes Checkout to collect any billing address information necessary for tax calculation.
*/
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;
}
namespace AutomaticTax {
interface Liability {
/**
* The connected account being referenced when `type` is `account`.
*/
account?: string;
/**
* Type of the account referenced in the request.
*/
type: Liability.Type;
}
namespace Liability {
type Type = 'account' | 'self';
}
}
type BillingAddressCollection = 'auto' | 'required';
interface ConsentCollection {
/**
* Determines the display of payment method reuse agreement text in the UI. If set to `hidden`, it will hide legal text related to the reuse of a payment method.
*/
payment_method_reuse_agreement?: ConsentCollection.PaymentMethodReuseAgreement;
/**
* 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;
/**
* If set to `required`, it requires customers to check a terms of service checkbox before being able to pay.
* There must be a valid terms of service URL set in your [Dashboard settings](https://dashboard.stripe.com/settings/public).
*/
terms_of_service?: ConsentCollection.TermsOfService;
}
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';
}
type CustomerCreation = 'always' | 'if_required';
interface CustomerUpdate {
/**
* Describes whether Checkout saves the billing address onto `customer.address`.
* To always collect a full billing address, use `billing_address_collection`. Defaults to `never`.
*/
address?: CustomerUpdate.Address;
/**
* Describes whether Checkout saves the name onto `customer.name`. Defaults to `never`.
*/
name?: CustomerUpdate.Name;
/**
* Describes whether Checkout saves shipping information onto `customer.shipping`.
* To collect shipping information, use `shipping_address_collection`. Defaults to `never`.
*/
shipping?: CustomerUpdate.Shipping;
}
namespace CustomerUpdate {
type Address = 'auto' | 'never';
type Name = 'auto' | 'never';
type Shipping = 'auto' | 'never';
}
interface CustomField {
/**
* Configuration for `type=dropdown` fields.
*/
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;
/**
* The label for the field, displayed to the customer.
*/
label: CustomField.Label;
/**
* Configuration for `type=numeric` fields.
*/
numeric?: CustomField.Numeric;
/**
* Whether the customer is required to complete the field before completing the Checkout Session. Defaults to `false`.
*/
optional?: boolean;
/**
* Configuration for `type=text` fields.
*/
text?: CustomField.Text;
/**
* The type of the field.
*/
type: CustomField.Type;
}
namespace CustomField {
interface Dropdown {
/**
* The value that will pre-fill the field on the payment page.Must match a `value` in the `options` array.
*/
default_value?: string;
/**
* The options available for the customer to select. Up to 200 options allowed.
*/
options: Array<Dropdown.Option>;
}
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;
/**
* The type of the label.
*/
type: 'custom';
}
interface Numeric {
/**
* The value that will pre-fill the field on the payment page.
*/
default_value?: string;
/**
* The maximum character length constraint for the customer's input.
*/
maximum_length?: number;
/**
* The minimum character length requirement for the customer's input.
*/
minimum_length?: number;
}
interface Text {
/**
* The value that will pre-fill the field on the payment page.
*/
default_value?: string;
/**
* The maximum character length constraint for the customer's input.
*/
maximum_length?: number;
/**
* The minimum character length requirement for the customer's input.
*/
minimum_length?: number;
}
type Type = 'dropdown' | 'numeric' | 'text';
}
interface CustomText {
/**
* Custom text that should be displayed after the payment confirmation button.
*/
after_submit?: Stripe.Emptyable<CustomText.AfterSubmit>;
/**
* Custom text that should be displayed alongside shipping address collection.
*/
shipping_address?: Stripe.Emptyable<CustomText.ShippingAddress>;
/**
* Custom text that should be displayed alongside the payment confirmation button.
*/
submit?: Stripe.Emptyable<CustomText.Submit>;
/**
* Custom text that should be displayed in place of the default terms of service agreement text.
*/
terms_of_service_acceptance?: Stripe.Emptyable<
CustomText.TermsOfServiceAcceptance
>;
}
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 {
/**
* The ID of the coupon to apply to this Session.
*/
coupon?: string;
/**
* The ID of a promotion code to apply to this Session.
*/
promotion_code?: string;
}
interface InvoiceCreation {
/**
* Set to `true` to enable invoice creation.
*/
enabled: boolean;
/**
* Parameters passed when creating invoices for payment-mode Checkout Sessions.
*/
invoice_data?: InvoiceCreation.InvoiceData;
}
namespace InvoiceCreation {
interface InvoiceData {
/**
* The account tax IDs associated with the invoice.
*/
account_tax_ids?: Stripe.Emptyable<Array<string>>;
/**
* Default custom fields to be displayed on invoices for this customer.
*/
custom_fields?: Stripe.Emptyable<Array<InvoiceData.CustomField>>;
/**
* An arbitrary string attached to the object. Often useful for displaying to users.
*/
description?: string;
/**
* Default footer to be displayed on invoices for this customer.
*/
footer?: string;
/**
* The connected account that issues the invoice. The invoice is presented with the branding and support information of the specified account.
*/
issuer?: InvoiceData.Issuer;
/**
* 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. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.
*/
metadata?: Stripe.MetadataParam;
/**
* Default options for invoice PDF rendering for this customer.
*/
rendering_options?: Stripe.Emptyable<InvoiceData.RenderingOptions>;
}
namespace InvoiceData {
interface CustomField {
/**
* The name of the custom field. This may be up to 40 characters.
*/
name: string;
/**
* The value of the custom field. This may be up to 140 characters.
*/
value: string;
}
interface Issuer {
/**
* The connected account being referenced when `type` is `account`.
*/
account?: string;
/**
* Type of the account referenced in the request.
*/
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. One of `exclude_tax` or `include_inclusive_tax`. `include_inclusive_tax` will include inclusive tax (and exclude exclusive tax) in invoice PDF amounts. `exclude_tax` will exclude all tax (inclusive and exclusive alike) from invoice PDF amounts.
*/
amount_tax_display?: Stripe.Emptyable<
RenderingOptions.AmountTaxDisplay
>;
/**
* ID of the invoice rendering template to use for this invoice.
*/
template?: string;
}
namespace RenderingOptions {
type AmountTaxDisplay = 'exclude_tax' | 'include_inclusive_tax';
}
}
}
interface LineItem {
/**
* When set, provides configuration for this item's quantity to be adjusted by the customer during Checkout.
*/
adjustable_quantity?: LineItem.AdjustableQuantity;
/**
* The [tax rates](https://stripe.com/docs/api/tax_rates) that will be applied to this line item depending on the customer's billing/shipping address. We currently support the following countries: US, GB, AU, and all countries in the EU.
*/
dynamic_tax_rates?: Array<string>;
/**
* The ID of the [Price](https://stripe.com/docs/api/prices) or [Plan](https://stripe.com/docs/api/plans) object. One of `price` or `price_data` is required.
*/
price?: string;
/**
* Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline. One of `price` or `price_data` is required.
*/
price_data?: LineItem.PriceData;
/**
* The quantity of the line item being purchased. Quantity should not be defined when `recurring.usage_type=metered`.
*/
quantity?: number;
/**
* The [tax rates](https://stripe.com/docs/api/tax_rates) which apply to this line item.
*/
tax_rates?: Array<string>;
}
namespace LineItem {
interface AdjustableQuantity {
/**
* Set to true if the quantity can be adjusted to any non-negative integer.
*/
enabled: boolean;
/**
* The maximum quantity the customer can purchase for the Checkout Session. By default this value is 99. You can specify a value up to 999999.
*/
maximum?: number;
/**
* The minimum quantity the customer must purchase for the Checkout Session. By default this value is 0.
*/
minimum?: number;
}
interface PriceData {
/**
* 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;
/**
* The ID of the [Product](https://docs.stripe.com/api/products) that this [Price](https://docs.stripe.com/api/prices) will belong to. One of `product` or `product_data` is required.
*/
product?: string;
/**
* Data used to generate a new [Product](https://docs.stripe.com/api/products) object inline. One of `product` or `product_data` is required.
*/
product_data?: PriceData.ProductData;
/**
* The recurring components of a price such as `interval` and `interval_count`.
*/
recurring?: PriceData.Recurring;
/**
* Only required if a [default tax behavior](https://stripe.com/docs/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)) was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. Once specified as either `inclusive` or `exclusive`, it cannot be changed.
*/
tax_behavior?: PriceData.TaxBehavior;
/**
* A non-negative integer in cents (or local equivalent) representing how much to charge. One of `unit_amount` or `unit_amount_decimal` is required.
*/
unit_amount?: number;
/**
* Same as `unit_amount`, but accepts a decimal value in cents (or local equivalent) with at most 12 decimal places. Only one of `unit_amount` and `unit_amount_decimal` can be set.
*/
unit_amount_decimal?: string;
}
namespace PriceData {
interface ProductData {
/**
* The product's description, meant to be displayable to the customer. Use this field to optionally store a long form explanation of the product being sold for your own rendering purposes.
*/
description?: string;
/**
* A list of up to 8 URLs of images for this product, meant to be displayable to the customer.
*/
images?: Array<string>;
/**
* 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. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.
*/
metadata?: Stripe.MetadataParam;
/**
* The product's name, meant to be displayable to the customer.
*/
name: string;
/**
* A [tax code](https://stripe.com/docs/tax/tax-categories) ID.
*/
tax_code?: string;
}
interface Recurring {
/**
* Specifies billing frequency. Either `day`, `week`, `month` or `year`.
*/
interval: Recurring.Interval;
/**
* The number of intervals between subscription billings. For example, `interval=month` and `interval_count=3` bills every 3 months. Maximum of three years interval allowed (3 years, 36 months, or 156 weeks).
*/
interval_count?: number;
}
namespace Recurring {
type Interval = 'day' | 'month' | 'week' | 'year';
}
type TaxBehavior = 'exclusive' | 'inclusive' | 'unspecified';
}
}
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 OptionalItem {
/**
* When set, provides configuration for the customer to adjust the quantity of the line item created when a customer chooses to add this optional item to their order.
*/
adjustable_quantity?: OptionalItem.AdjustableQuantity;
/**
* The ID of the [Price](https://stripe.com/docs/api/prices) or [Plan](https://stripe.com/docs/api/plans) object.
*/
price: string;
/**
* The initial quantity of the line item created when a customer chooses to add this optional item to their order.
*/
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;
/**
* 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;
}
}
type OriginContext = 'mobile_app' | 'web';
interface PaymentIntentData {
/**
* The amount of the application fee (if any) that will be requested to be applied to the payment and transferred to the application owner's Stripe account. The amount of the application fee collected will be capped at the total amount captured. For more information, see the PaymentIntents [use case for connected accounts](https://stripe.com/docs/payments/connected-accounts).
*/
application_fee_amount?: number;
/**
* Controls when the funds will be captured from the customer's account.
*/
capture_method?: PaymentIntentData.CaptureMethod;
/**
* An arbitrary string attached to the object. Often useful for displaying to users.
*/
description?: string;
/**
* 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. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.
*/
metadata?: Stripe.MetadataParam;
/**
* The Stripe account ID for which these funds are intended. For details,
* see the PaymentIntents [use case for connected
* accounts](https://docs.stripe.com/docs/payments/connected-accounts).
*/
on_behalf_of?: string;
/**
* Email address that the receipt for the resulting payment will be sent to. If `receipt_email` is specified for a payment in live mode, a receipt will be sent regardless of your [email settings](https://dashboard.stripe.com/account/emails).
*/
receipt_email?: string;
/**
* Indicates that you intend to [make future payments](https://stripe.com/docs/payments/payment-intents#future-usage) with the payment
* method collected by this Checkout Session.
*
* When setting this to `on_session`, Checkout will show a notice to the
* customer that their payment details will be saved.
*
* When setting this to `off_session`, Checkout will show a notice to the
* customer that their payment details will be saved and used for future
* payments.
*
* If a Customer has been provided or Checkout creates a new Customer,
* Checkout will attach the payment method to the Customer.
*
* If Checkout does not create a Customer, the payment method is not attached
* to a Customer. To reuse the payment method, you can retrieve it from the
* Checkout Session's PaymentIntent.
*
* When processing card payments, Checkout also uses `setup_future_usage`
* to dynamically optimize your payment flow and comply with regional
* legislation and network rules, such as SCA.
*/
setup_future_usage?: PaymentIntentData.SetupFutureUsage;
/**
* Shipping information for this payment.
*/
shipping?: PaymentIntentData.Shipping;
/**
* Text that appears on the customer's statement as the statement descriptor for a non-card charge. This value overrides the account's default statement descriptor. For information about requirements, including the 22-character limit, see [the Statement Descriptor docs](https://docs.stripe.com/get-started/account/statement-descriptors).
*
* Setting this value for a card charge returns an error. For card charges, set the [statement_descriptor_suffix](https://docs.stripe.com/get-started/account/statement-descriptors#dynamic) instead.
*/
statement_descriptor?: string;
/**
* Provides information about a card charge. Concatenated to the account's [statement descriptor prefix](https://docs.stripe.com/get-started/account/statement-descriptors#static) to form the complete statement descriptor that appears on the customer's statement.
*/
statement_descriptor_suffix?: string;
/**
* The parameters used to automatically create a Transfer when the payment succeeds.
* For more information, see the PaymentIntents [use case for connected accounts](https://stripe.com/docs/payments/connected-accounts).
*/
transfer_data?: PaymentIntentData.TransferData;
/**
* A string that identifies the resulting payment as part of a group. See the PaymentIntents [use case for connected accounts](https://stripe.com/docs/connect/separate-charges-and-transfers) for details.
*/
transfer_group?: string;
}
namespace PaymentIntentData {
type CaptureMethod = 'automatic' | 'automatic_async' | 'manual';
type SetupFutureUsage = 'off_session' | 'on_session';
interface Shipping {
/**
* Shipping address.
*/
address: Stripe.ShippingAddressParam;
/**
* The delivery service that shipped a physical product, such as Fedex, UPS, USPS, etc.
*/
carrier?: string;
/**
* Recipient name.
*/
name: string;
/**
* Recipient phone (including extension).
*/
phone?: 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.
*/
tracking_number?: string;
}
interface TransferData {
/**
* The amount that will be transferred automatically when a charge succeeds.
*/
amount?: number;
/**
* If specified, successful charges will be attributed to the destination
* account for tax reporting, and the funds from charges will be transferred
* to the destination account. The ID of the resulting transfer will be
* returned on the successful charge's `transfer` field.
*/
destination: string;
}
}
type PaymentMethodCollection = 'always' | 'if_required';
interface PaymentMethodData {
/**
* Allow redisplay will be set on the payment method on confirmation and indicates whether this payment method can be shown again to the customer in a checkout flow. Only set this field if you wish to override the allow_redisplay value determined by Checkout.
*/
allow_redisplay?: PaymentMethodData.AllowRedisplay;
}
namespace PaymentMethodData {
type AllowRedisplay = 'always' | 'limited' | 'unspecified';
}
interface PaymentMethodOptions {
/**
* contains details about the ACSS Debit payment method options.
*/
acss_debit?: PaymentMethodOptions.AcssDebit;
/**
* contains details about the Affirm payment method options.
*/
affirm?: PaymentMethodOptions.Affirm;
/**
* contains details about the Afterpay Clearpay payment method options.
*/
afterpay_clearpay?: PaymentMethodOptions.AfterpayClearpay;
/**
* contains details about the Alipay payment method options.
*/
alipay?: PaymentMethodOptions.Alipay;
/**
* contains details about the AmazonPay payment method options.
*/
amazon_pay?: PaymentMethodOptions.AmazonPay;
/**
* contains details about the AU Becs Debit payment method options.
*/
au_becs_debit?: PaymentMethodOptions.AuBecsDebit;
/**
* contains details about the Bacs Debit payment method options.
*/
bacs_debit?: PaymentMethodOptions.BacsDebit;
/**
* contains details about the Bancontact payment method options.
*/
bancontact?: PaymentMethodOptions.Bancontact;
/**
* contains details about the Boleto payment method options.
*/
boleto?: PaymentMethodOptions.Boleto;
/**
* contains details about the Card payment method options.
*/
card?: PaymentMethodOptions.Card;
/**
* contains details about the Cashapp Pay payment method options.
*/
cashapp?: PaymentMethodOptions.Cashapp;
/**
* contains details about the Customer Balance payment method options.
*/
customer_balance?: PaymentMethodOptions.CustomerBalance;
/**
* contains details about the EPS payment method options.
*/
eps?: PaymentMethodOptions.Eps;
/**
* contains details about the FPX payment method options.
*/
fpx?: PaymentMethodOptions.Fpx;
/**
* contains details about the Giropay payment method options.
*/
giropay?: PaymentMethodOptions.Giropay;
/**
* contains details about the Grabpay payment method options.
*/
grabpay?: PaymentMethodOptions.Grabpay;
/**
* contains details about the Ideal payment method options.
*/
ideal?: PaymentMethodOptions.Ideal;
/**
* contains details about the Kakao Pay payment method options.
*/
kakao_pay?: PaymentMethodOptions.KakaoPay;
/**
* contains details about the Klarna payment method options.
*/
klarna?: PaymentMethodOptions.Klarna;
/**
* contains details about the Konbini payment method options.
*/
konbini?: PaymentMethodOptions.Konbini;
/**
* contains details about the Korean card payment method options.
*/
kr_card?: PaymentMethodOptions.KrCard;
/**
* contains details about the Link payment method options.
*/
link?: PaymentMethodOptions.Link;
/**
* contains details about the Mobilepay payment method options.
*/
mobilepay?: PaymentMethodOptions.Mobilepay;
/**
* contains details about the Multibanco payment method options.
*/
multibanco?: PaymentMethodOptions.Multibanco;
/**
* contains details about the Naver Pay payment method options.
*/
naver_pay?: PaymentMethodOptions.NaverPay;
/**
* contains details about the OXXO payment method options.
*/
oxxo?: PaymentMethodOptions.Oxxo;
/**
* contains details about the P24 payment method options.
*/
p24?: PaymentMethodOptions.P24;
/**
* contains details about the Pay By Bank payment method options.
*/
pay_by_bank?: PaymentMethodOptions.PayByBank;
/**
* contains details about the PAYCO payment method options.
*/
payco?: PaymentMethodOptions.Payco;
/**
* contains details about the PayNow payment method options.
*/
paynow?: PaymentMethodOptions.Paynow;
/**
* contains details about the PayPal payment method options.
*/
paypal?: PaymentMethodOptions.Paypal;
/**
* contains details about the Pix payment method options.
*/
pix?: PaymentMethodOptions.Pix;
/**
* contains details about the RevolutPay payment method options.
*/
revolut_pay?: PaymentMethodOptions.RevolutPay;
/**
* contains details about the Samsung Pay payment method options.
*/
samsung_pay?: PaymentMethodOptions.SamsungPay;
/**
* contains details about the Sepa Debit payment method options.
*/
sepa_debit?: PaymentMethodOptions.SepaDebit;
/**
* contains details about the Sofort payment method options.
*/
sofort?: PaymentMethodOptions.Sofort;
/**
* contains details about the Swish payment method options.
*/
swish?: PaymentMethodOptions.Swish;
/**
* contains details about the Us Bank Account payment method options.
*/
us_bank_account?: