--- title: "Update a customer credit balance transaction" method: POST path: "/v1/customers/{customer}/balance_transactions/{transaction}" --- # Update a customer credit balance transaction `POST /v1/customers/{customer}/balance_transactions/{transaction}` Most credit balance transaction fields are immutable, but you may update its `description` and `metadata`. ## Path parameters - `customer` string, required - `transaction` string, required ## Response `200` Successful response. - CustomerBalanceTransaction — Each customer has a [Balance](https://docs.stripe.com/api/customers/object#customer_object-balance) value, which denotes a debit or credit that's automatically applied to their next invoice upon finalization. You may modify the value directly by using the [update customer API](https://docs.stripe.com/api/customers/update), or by creating a Customer Balance Transaction, which increments or decrements the customer's `balance` by the specified `amount`. Related guide: [Customer balance](https://docs.stripe.com/billing/customer/balance) - `amount` integer, required — The amount of the transaction. A negative value is a credit for the customer's balance, and a positive value is a debit to the customer's `balance`. - `checkout_session` union — The ID of the checkout session (if any) that created the transaction. - string - CheckoutSession — A Checkout Session represents your customer's session as they pay for one-time purchases or subscriptions through [Checkout](https://docs.stripe.com/payments/checkout) or [Payment Links](https://docs.stripe.com/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://docs.stripe.com/api/customers), and either the successful [PaymentIntent](https://docs.stripe.com/api/payment_intents) or an active [Subscription](https://docs.stripe.com/api/subscriptions). You can create a Checkout Session on your server and redirect to its URL to begin Checkout. Related guide: [Checkout quickstart](https://docs.stripe.com/checkout/quickstart) - `adaptive_pricing` PaymentPagesCheckoutSessionAdaptivePricing - `enabled` boolean, required — If enabled, Adaptive Pricing is available on [eligible sessions](https://docs.stripe.com/payments/currencies/localize-prices/adaptive-pricing?payment-ui=stripe-hosted#restrictions). - `after_expiration` PaymentPagesCheckoutSessionAfterExpiration - `recovery` PaymentPagesCheckoutSessionAfterExpirationRecovery - `allow_promotion_codes` boolean, required — Enables user redeemable promotion codes on the recovered Checkout Sessions. Defaults to `false` - `enabled` boolean, required — 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. - `expires_at` integer, nullable — The timestamp at which the recovery URL will expire. - `url` string, nullable — URL that creates a new Checkout Session when clicked that is a copy of this expired Checkout Session - `allow_promotion_codes` boolean, nullable — Enables user redeemable promotion codes. - `amount_subtotal` integer, nullable — Total of all items before discounts or taxes are applied. - `amount_total` integer, nullable — Total of all items after discounts and taxes are applied. - `automatic_tax` PaymentPagesCheckoutSessionAutomaticTax, required - `enabled` boolean, required — Indicates whether automatic tax is enabled for the session - `liability` ConnectAccountReference - `account` union — The connected account being referenced when `type` is `account`. - string - Account — For new integrations, we recommend using the [Accounts v2 API](/api/v2/core/accounts), in place of /v1/accounts and /v1/customers to represent a user. This is an object representing a Stripe account. You can retrieve it to see properties on the account like its current requirements or if the account is enabled to make live charges or receive payouts. For accounts where [controller.requirement_collection](/api/accounts/object#account_object-controller-requirement_collection) is `application`, which includes Custom accounts, the properties below are always returned. For accounts where [controller.requirement_collection](/api/accounts/object#account_object-controller-requirement_collection) is `stripe`, which includes Standard and Express accounts, some properties are only returned until you create an [Account Link](/api/account_links) or [Account Session](/api/account_sessions) to start Connect Onboarding. Learn about the [differences between accounts](/connect/accounts). - … - `type` 'account' | 'self', required — Type of the account referenced. - `provider` string, nullable — The tax provider powering automatic tax. - `status` 'complete' | 'failed' | 'requires_location_inputs', nullable — The status of the most recent automated tax calculation for this session. - `billing_address_collection` 'auto' | 'required', nullable — Describes whether Checkout should collect the customer's billing address. Defaults to `auto`. - `branding_settings` PaymentPagesCheckoutSessionBrandingSettings - `background_color` string, required — A hex color value starting with `#` representing the background color for the Checkout Session. - `border_style` 'pill' | 'rectangular' | 'rounded', required — The border style for the Checkout Session. Must be one of `rounded`, `rectangular`, or `pill`. - `button_color` string, required — A hex color value starting with `#` representing the button color for the Checkout Session. - `display_name` string, required — The display name shown on the Checkout Session. - `font_family` string, required — 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). - `icon` PaymentPagesCheckoutSessionBrandingSettingsIcon - `file` string — 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. - `type` 'file' | 'url', required — The type of image for the icon. Must be one of `file` or `url`. - `url` string — The URL of the image. Present when `type` is `url`. - `logo` PaymentPagesCheckoutSessionBrandingSettingsLogo - `file` string — 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. - `type` 'file' | 'url', required — The type of image for the logo. Must be one of `file` or `url`. - `url` string — The URL of the image. Present when `type` is `url`. - `cancel_url` string, nullable — 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. - `client_reference_id` string, nullable — 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_secret` string, nullable — The client secret of your Checkout Session. Applies to Checkout Sessions with `ui_mode: embedded_page` or `ui_mode: elements`. For `ui_mode: embedded_page`, the client secret is to be used when initializing Stripe.js embedded checkout. For `ui_mode: elements`, use the client secret with [initCheckout](https://docs.stripe.com/js/custom_checkout/init) on your front end. - `collected_information` PaymentPagesCheckoutSessionCollectedInformation - `business_name` string, nullable — Customer’s business name for this Checkout Session - `individual_name` string, nullable — Customer’s individual name for this Checkout Session - `shipping_details` PaymentPagesCheckoutSessionCheckoutAddressDetails - `address` Address, required - `city` string, nullable — City, district, suburb, town, or village. - `country` string, nullable — Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)). - `line1` string, nullable — Address line 1, such as the street, PO Box, or company name. - `line2` string, nullable — Address line 2, such as the apartment, suite, unit, or building. - `postal_code` string, nullable — ZIP or postal code. - `state` string, nullable — State, county, province, or region ([ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2)). - `name` string, required — Customer name. - `consent` PaymentPagesCheckoutSessionConsent - `promotions` 'opt_in' | 'opt_out', nullable — If `opt_in`, the customer consents to receiving promotional communications from the merchant about this Checkout Session. - `terms_of_service` 'accepted', nullable — If `accepted`, the customer in this Checkout Session has agreed to the merchant's terms of service. - `consent_collection` PaymentPagesCheckoutSessionConsentCollection - `payment_method_reuse_agreement` PaymentPagesCheckoutSessionPaymentMethodReuseAgreement - `position` 'auto' | 'hidden', required — 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. - `promotions` 'auto' | 'none', nullable — 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 and US customers. - `terms_of_service` 'none' | 'required', nullable — If set to `required`, it requires customers to accept the terms of service before being able to pay. - `created` integer, required — Time at which the object was created. Measured in seconds since the Unix epoch. - `currency` string, currency, nullable — 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_conversion` PaymentPagesCheckoutSessionCurrencyConversion - `amount_subtotal` integer, required — Total of all items in source currency before discounts or taxes are applied. - `amount_total` integer, required — Total of all items in source currency after discounts and taxes are applied. - `fx_rate` string, decimal, required — Exchange rate used to convert source currency amounts to customer currency amounts - `source_currency` string, required — Creation currency of the CheckoutSession before localization - `custom_fields` PaymentPagesCheckoutSessionCustomFields[], required — Collect additional information from your customer using custom fields. Up to 3 fields are supported. You can't set this parameter if `ui_mode` is `custom`. - `dropdown` PaymentPagesCheckoutSessionCustomFieldsDropdown - `default_value` string, nullable — The value that pre-fills on the payment page. - `options` PaymentPagesCheckoutSessionCustomFieldsOption[], required — The options available for the customer to select. Up to 200 options allowed. - `label` string, required — The label for the option, displayed to the customer. Up to 100 characters. - `value` string, required — 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, nullable — The option selected by the customer. This will be the `value` for the option. - `key` string, required — 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. - `label` PaymentPagesCheckoutSessionCustomFieldsLabel, required - `custom` string, nullable — Custom text for the label, displayed to the customer. Up to 50 characters. - `type` 'custom', required — The type of the label. - `numeric` PaymentPagesCheckoutSessionCustomFieldsNumeric - `default_value` string, nullable — The value that pre-fills the field on the payment page. - `maximum_length` integer, nullable — The maximum character length constraint for the customer's input. - `minimum_length` integer, nullable — The minimum character length requirement for the customer's input. - `value` string, nullable — The value entered by the customer, containing only digits. - `optional` boolean, required — Whether the customer is required to complete the field before completing the Checkout Session. Defaults to `false`. - `text` PaymentPagesCheckoutSessionCustomFieldsText - `default_value` string, nullable — The value that pre-fills the field on the payment page. - `maximum_length` integer, nullable — The maximum character length constraint for the customer's input. - `minimum_length` integer, nullable — The minimum character length requirement for the customer's input. - `value` string, nullable — The value entered by the customer. - `type` 'dropdown' | 'numeric' | 'text', required — The type of the field. - `custom_text` PaymentPagesCheckoutSessionCustomText, required - `after_submit` PaymentPagesCheckoutSessionCustomTextPosition - `message` string, required — Text can be up to 1200 characters in length. - `shipping_address` PaymentPagesCheckoutSessionCustomTextPosition - `message` string, required — Text can be up to 1200 characters in length. - `submit` PaymentPagesCheckoutSessionCustomTextPosition - `message` string, required — Text can be up to 1200 characters in length. - `terms_of_service_acceptance` PaymentPagesCheckoutSessionCustomTextPosition - `message` string, required — Text can be up to 1200 characters in length. - `customer` union — 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. - string - Customer — This object represents a customer of your business. Use it to [create recurring charges](https://docs.stripe.com/invoicing/customer), [save payment](https://docs.stripe.com/payments/save-during-payment) and contact information, and track payments that belong to the same customer. - `address` Address - `city` string, nullable — City, district, suburb, town, or village. - `country` string, nullable — Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)). - `line1` string, nullable — Address line 1, such as the street, PO Box, or company name. - `line2` string, nullable — Address line 2, such as the apartment, suite, unit, or building. - `postal_code` string, nullable — ZIP or postal code. - `state` string, nullable — State, county, province, or region ([ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2)). - `balance` integer — The current balance, if any, that's stored on the customer in their default currency. If negative, the customer has credit to apply to their next invoice. If positive, the customer has an amount owed that's added to their next invoice. The balance only considers amounts that Stripe hasn't successfully applied to any invoice. It doesn't reflect unpaid invoices. This balance is only taken into account after invoices finalize. For multi-currency balances, see [invoice_credit_balance](https://docs.stripe.com/api/customers/object#customer_object-invoice_credit_balance). - `business_name` string — The customer's business name. - `cash_balance` CashBalance — A customer's `Cash balance` represents real funds. Customers can add funds to their cash balance by sending a bank transfer. These funds can be used for payment and can eventually be paid out to your bank account. - `available` object, nullable — A hash of all cash balances available to this customer. You cannot delete a customer with any cash balances, even if the balance is 0. Amounts are represented in the [smallest currency unit](https://docs.stripe.com/currencies#zero-decimal). - `customer` string, required — The ID of the customer whose cash balance this object represents. - `customer_account` string, nullable — The ID of an Account representing a customer whose cash balance this object represents. - `livemode` boolean, required — If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`. - `object` 'cash_balance', required — String representing the object's type. Objects of the same type share the same value. - `settings` CustomerBalanceCustomerBalanceSettings, required - … - `created` integer, required — Time at which the object was created. Measured in seconds since the Unix epoch. - `currency` string, nullable — Three-letter [ISO code for the currency](https://stripe.com/docs/currencies) the customer can be charged in for recurring billing purposes. - `customer_account` string, nullable — The ID of an Account representing a customer. You can use this ID with any v1 API that accepts a customer_account parameter. - `default_source` union — ID of the default payment source for the customer. If you use payment methods created through the PaymentMethods API, see the [invoice_settings.default_payment_method](https://docs.stripe.com/api/customers/object#customer_object-invoice_settings-default_payment_method) field instead. - string - BankAccount — These bank accounts are payment methods on `Customer` objects. On the other hand [External Accounts](/api#external_accounts) are transfer destinations on `Account` objects for connected accounts. They can be bank accounts or debit cards as well, and are documented in the links above. Related guide: [Bank debits and transfers](/payments/bank-debits-transfers) - … - Card — You can store multiple cards on a customer in order to charge the customer later. You can also store multiple debit cards on a recipient in order to transfer to those cards later. Related guide: [Card payments with Sources](https://docs.stripe.com/sources/cards) - … - Source — `Source` objects allow you to accept a variety of payment methods. They represent a customer's payment instrument, and can be used with the Stripe API just like a `Card` object: once chargeable, they can be charged, or can be attached to customers. Stripe doesn't recommend using the deprecated [Sources API](https://docs.stripe.com/api/sources). We recommend that you adopt the [PaymentMethods API](https://docs.stripe.com/api/payment_methods). This newer API provides access to our latest features and payment method types. Related guides: [Sources API](https://docs.stripe.com/sources) and [Sources & Customers](https://docs.stripe.com/sources/customers). - … - `delinquent` boolean, nullable — Tracks the most recent state change on any invoice belonging to the customer. Paying an invoice or marking it uncollectible via the API will set this field to false. An automatic payment failure or passing the `invoice.due_date` will set this field to `true`. If an invoice becomes uncollectible by [dunning](https://docs.stripe.com/billing/automatic-collection), `delinquent` doesn't reset to `false`. If you care whether the customer has paid their most recent subscription invoice, use `subscription.status` instead. Paying or marking uncollectible any customer invoice regardless of whether it is the latest invoice for a subscription will always set this field to `false`. - `description` string, nullable — An arbitrary string attached to the object. Often useful for displaying to users. - `discount` Discount — A discount represents the actual application of a [coupon](https://api.stripe.com#coupons) or [promotion code](https://api.stripe.com#promotion_codes). It contains information about when the discount began, when it will end, and what it is applied to. Related guide: [Applying discounts to subscriptions](https://docs.stripe.com/billing/subscriptions/discounts) - `checkout_session` string, nullable — The Checkout session that this coupon is applied to, if it is applied to a particular session in payment mode. Not present for subscription mode. - `customer` union — The ID of the customer associated with this discount. - … - `customer_account` string, nullable — The ID of the account representing the customer associated with this discount. - `end` integer, nullable — If the coupon has a duration of `repeating`, the date that this discount will end. If the coupon has a duration of `once` or `forever`, this attribute will be null. - `id` string, required — The ID of the discount object. Discounts can't be fetched by ID. Use `expand[]=discounts` in API calls to expand discount IDs in an array. - `invoice` string, nullable — The invoice that the discount's coupon was applied to, if it was applied directly to a particular invoice. - `invoice_item` string, nullable — The invoice item `id` (or invoice line item `id` for invoice line items of type='subscription') that the discount's coupon was applied to, if it was applied directly to a particular invoice item or invoice line item. - `object` 'discount', required — String representing the object's type. Objects of the same type share the same value. - `promotion_code` union — The promotion code applied to create this discount. - … - `source` DiscountSource, required - … - `start` integer, required — Date that the coupon was applied. - `subscription` string, nullable — The subscription that this coupon is applied to, if it is applied to a particular subscription. - `subscription_item` string, nullable — The subscription item that this coupon is applied to, if it is applied to a particular subscription item. - `email` string, nullable — The customer's email address. - `id` string, required — Unique identifier for the object. - `individual_name` string — The customer's individual name. - `invoice_credit_balance` object — The current multi-currency balances, if any, that's stored on the customer. If positive in a currency, the customer has a credit to apply to their next invoice denominated in that currency. If negative, the customer has an amount owed that's added to their next invoice denominated in that currency. These balances don't apply to unpaid invoices. They solely track amounts that Stripe hasn't successfully applied to any invoice. Stripe only applies a balance in a specific currency to an invoice after that invoice (which is in the same currency) finalizes. - `invoice_prefix` string, nullable — The prefix for the customer used to generate unique invoice numbers. - `invoice_settings` InvoiceSettingCustomerSetting - `custom_fields` InvoiceSettingCustomField[], nullable — Default custom fields to be displayed on invoices for this customer. - … - `default_payment_method` union — ID of a payment method that's attached to the customer, to be used as the customer's default payment method for subscriptions and invoices. - … - `footer` string, nullable — Default footer to be displayed on invoices for this customer. - `rendering_options` InvoiceSettingCustomerRenderingOptions - … - `livemode` boolean, required — If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`. - `metadata` object — Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. - `name` string, nullable — The customer's full name or business name. - `next_invoice_sequence` integer — The suffix of the customer's next invoice number (for example, 0001). When the account uses account level sequencing, this parameter is ignored in API requests and the field omitted in API responses. - `object` 'customer', required — String representing the object's type. Objects of the same type share the same value. - `phone` string, nullable — The customer's phone number. - `preferred_locales` string[], nullable — The customer's preferred locales (languages), ordered by preference. - `shipping` Shipping - `address` Address - … - `carrier` string, nullable — The delivery service that shipped a physical product, such as Fedex, UPS, USPS, etc. - `name` string — Recipient name. - `phone` string, nullable — Recipient phone (including extension). - `tracking_number` string, nullable — 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. - `sources` object — The customer's payment sources, if any. - `data` union[], required — Details about each object. - … - `has_more` boolean, required — True if this list has another page of items after this one that can be fetched. - `object` 'list', required — String representing the object's type. Objects of the same type share the same value. Always has the value `list`. - `url` string, required — The URL where this list can be accessed. - `subscriptions` object — The customer's current subscriptions, if any. - `data` Subscription[], required — Details about each object. - … - `has_more` boolean, required — True if this list has another page of items after this one that can be fetched. - `object` 'list', required — String representing the object's type. Objects of the same type share the same value. Always has the value `list`. - `url` string, required — The URL where this list can be accessed. - `tax` CustomerTax - `automatic_tax` 'failed' | 'not_collecting' | 'supported' | 'unrecognized_location', required — Surfaces if automatic tax computation is possible given the current customer location information. - `ip_address` string, nullable — A recent IP address of the customer used for tax reporting and tax location inference. - `location` CustomerTaxLocation - … - `provider` 'anrok' | 'avalara' | 'sphere' | 'stripe', required — The tax calculation provider used for location resolution. Defaults to `stripe` when not using a [third-party provider](/tax/third-party-apps). - `tax_exempt` 'exempt' | 'none' | 'reverse', nullable — Describes the customer's tax exemption status, which is `none`, `exempt`, or `reverse`. When set to `reverse`, invoice and receipt PDFs include the following text: **"Reverse charge"**. - `tax_ids` object — The customer's tax IDs. - `data` TaxId[], required — Details about each object. - … - `has_more` boolean, required — True if this list has another page of items after this one that can be fetched. - `object` 'list', required — String representing the object's type. Objects of the same type share the same value. Always has the value `list`. - `url` string, required — The URL where this list can be accessed. - `test_clock` union — ID of the test clock that this customer belongs to. - string - TestHelpersTestClock — A test clock enables deterministic control over objects in testmode. With a test clock, you can create objects at a frozen time in the past or future, and advance to a specific future time to observe webhooks and state changes. After the clock advances, you can either validate the current state of your scenario (and test your assumptions), change the current state of your scenario (and test more complex scenarios), or keep advancing forward in time. - … - DeletedCustomer - `deleted` true, required — Always true for a deleted object - `id` string, required — Unique identifier for the object. - `object` 'customer', required — String representing the object's type. Objects of the same type share the same value. - `customer_account` string, nullable — The ID of the account for this Session. - `customer_creation` 'always' | 'if_required', nullable — Configure whether a Checkout Session creates a Customer when the Checkout Session completes. - `customer_details` PaymentPagesCheckoutSessionCustomerDetails - `address` Address - `city` string, nullable — City, district, suburb, town, or village. - `country` string, nullable — Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)). - `line1` string, nullable — Address line 1, such as the street, PO Box, or company name. - `line2` string, nullable — Address line 2, such as the apartment, suite, unit, or building. - `postal_code` string, nullable — ZIP or postal code. - `state` string, nullable — State, county, province, or region ([ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2)). - `business_name` string, nullable — The customer's business name after a completed Checkout Session. - `email` string, nullable — 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. - `individual_name` string, nullable — The customer's individual name after a completed Checkout Session. - `name` string, nullable — The customer's name after a completed Checkout Session. Note: This property is populated only for sessions on or after March 30, 2022. - `phone` string, nullable — The customer's phone number after a completed Checkout Session. - `tax_exempt` 'exempt' | 'none' | 'reverse', nullable — The customer’s tax exempt status after a completed Checkout Session. - `tax_ids` PaymentPagesCheckoutSessionTaxId[], nullable — The customer’s tax IDs after a completed Checkout Session. - `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' | 'fo_vat' | 'gb_vat' | 'ge_vat' | 'gi_tin' | 'gn_nif' | 'hk_br' | 'hr_oib' | 'hu_tin' | 'ic_nif' | 'id_npwp' | 'il_vat' | 'in_gst' | 'is_vat' | 'it_cf' | 'jp_cn' | 'jp_rn' | 'jp_trn' | 'ke_pin' | 'kg_tin' | 'kh_tin' | 'kr_brn' | 'kz_bin' | 'la_tin' | 'li_uid' | 'li_vat' | 'lk_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' | 'pl_nip' | 'py_ruc' | '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', required — 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`, `pl_nip`, `it_cf`, `fo_vat`, `gi_tin`, `py_ruc`, `tw_vat`, `th_vat`, `jp_cn`, `jp_rn`, `jp_trn`, `li_uid`, `li_vat`, `lk_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`, `ic_nif`, or `unknown` - `value` string, nullable — The value of the tax ID. - `customer_email` string, nullable — 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. - `discounts` PaymentPagesCheckoutSessionDiscount[], nullable — List of coupons and promotion codes attached to the Checkout Session. - `coupon` union — Coupon attached to the Checkout Session. - string - Coupon — A coupon contains information about a percent-off or amount-off discount you might want to apply to a customer. Coupons may be applied to [subscriptions](https://api.stripe.com#subscriptions), [invoices](https://api.stripe.com#invoices), [checkout sessions](https://docs.stripe.com/api/checkout/sessions), [quotes](https://api.stripe.com#quotes), and more. Coupons do not work with conventional one-off [charges](/api/charges/create) or [payment intents](https://docs.stripe.com/api/payment_intents). - `amount_off` integer, nullable — Amount (in the `currency` specified) that will be taken off the subtotal of any invoices for this customer. - `applies_to` CouponAppliesTo - … - `created` integer, required — Time at which the object was created. Measured in seconds since the Unix epoch. - `currency` string, currency, nullable — If `amount_off` has been set, the three-letter [ISO code for the currency](https://stripe.com/docs/currencies) of the amount to take off. - `currency_options` object — Coupons defined in each available currency option. Each key must be a three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html) and a [supported currency](https://stripe.com/docs/currencies). - `duration` 'forever' | 'once' | 'repeating', required — One of `forever`, `once`, or `repeating`. Describes how long a customer who applies this coupon will get the discount. - `duration_in_months` integer, nullable — If `duration` is `repeating`, the number of months the coupon applies. Null if coupon `duration` is `forever` or `once`. - `id` string, required — Unique identifier for the object. - `livemode` boolean, required — If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`. - `max_redemptions` integer, nullable — Maximum number of times this coupon can be redeemed, in total, across all customers, before it is no longer valid. - `metadata` object, nullable — Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. - `name` string, nullable — Name of the coupon displayed to customers on for instance invoices or receipts. - `object` 'coupon', required — String representing the object's type. Objects of the same type share the same value. - `percent_off` number, nullable — Percent that will be taken off the subtotal of any invoices for this customer for the duration of the coupon. For example, a coupon with percent_off of 50 will make a $ (or local equivalent)100 invoice $ (or local equivalent)50 instead. - `redeem_by` integer, nullable — Date after which the coupon can no longer be redeemed. - `times_redeemed` integer, required — Number of times this coupon has been applied to a customer. - `valid` boolean, required — Taking account of the above properties, whether this coupon can still be applied to a customer. - `promotion_code` union — Promotion code attached to the Checkout Session. - string - PromotionCode — A Promotion Code represents a customer-redeemable code for an underlying promotion. You can create multiple codes for a single promotion. If you enable promotion codes in your [customer portal configuration](https://docs.stripe.com/customer-management/configure-portal), then customers can redeem a code themselves when updating a subscription in the portal. Customers can also view the currently active promotion codes and coupons on each of their subscriptions in the portal. - `active` boolean, required — Whether the promotion code is currently active. A promotion code is only active if the coupon is also valid. - `code` string, required — The customer-facing code. Regardless of case, this code must be unique across all active promotion codes for each customer. Valid characters are lower case letters (a-z), upper case letters (A-Z), digits (0-9), and dashes (-). - `created` integer, required — Time at which the object was created. Measured in seconds since the Unix epoch. - `customer` union — The customer who can use this promotion code. - … - `customer_account` string, nullable — The account representing the customer who can use this promotion code. - `expires_at` integer, nullable — Date at which the promotion code can no longer be redeemed. - `id` string, required — Unique identifier for the object. - `livemode` boolean, required — If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`. - `max_redemptions` integer, nullable — Maximum number of times this promotion code can be redeemed. - `metadata` object, nullable — Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. - `object` 'promotion_code', required — String representing the object's type. Objects of the same type share the same value. - `promotion` PromotionCodesResourcePromotion, required - … - `restrictions` PromotionCodesResourceRestrictions, required - … - `times_redeemed` integer, required — Number of times this promotion code has been used. - `excluded_payment_method_types` string[] — 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). - `expires_at` integer, required — The timestamp at which the Checkout Session will expire. - `id` string, required — Unique identifier for the object. - `integration_identifier` string, nullable — The integration identifier for this Checkout Session. Multiple Checkout Sessions can have the same integration identifier. - `invoice` union — ID of the invoice created by the Checkout Session, if it exists. - string - Invoice — Invoices are statements of amounts owed by a customer, and are either generated one-off, or generated periodically from a subscription. They contain [invoice items](https://api.stripe.com#invoiceitems), and proration adjustments that may be caused by subscription upgrades/downgrades (if necessary). If your invoice is configured to be billed through automatic charges, Stripe automatically finalizes your invoice and attempts payment. Note that finalizing the invoice, [when automatic](https://docs.stripe.com/invoicing/integration/automatic-advancement-collection), does not happen immediately as the invoice is created. Stripe waits until one hour after the last webhook was successfully sent (or the last webhook timed out after failing). If you (and the platforms you may have connected to) have no webhooks configured, Stripe waits one hour after creation to finalize the invoice. If your invoice is configured to be billed by sending an email, then based on your [email settings](https://dashboard.stripe.com/account/billing/automatic), Stripe will email the invoice to your customer and await payment. These emails can contain a link to a hosted page to pay the invoice. Stripe applies any customer credit on the account before determining the amount due for the invoice (i.e., the amount that will be actually charged). If the amount due for the invoice is less than Stripe's [minimum allowed charge per currency](/docs/currencies#minimum-and-maximum-charge-amounts), the invoice is automatically marked paid, and we add the amount due to the customer's credit balance which is applied to the next invoice. More details on the customer's credit balance are [here](https://docs.stripe.com/billing/customer/balance). Related guide: [Send invoices to customers](https://docs.stripe.com/billing/invoices/sending) - `account_country` string, nullable — The country of the business associated with this invoice, most often the business creating the invoice. - `account_name` string, nullable — The public name of the business associated with this invoice, most often the business creating the invoice. - `account_tax_ids` union[], nullable — The account tax IDs associated with the invoice. Only editable when the invoice is a draft. - union - … - `amount_due` integer, required — Final amount due at this time for this invoice. If the invoice's total is smaller than the minimum charge amount, for example, or if there is account credit that can be applied to the invoice, the `amount_due` may be 0. If there is a positive `starting_balance` for the invoice (the customer owes money), the `amount_due` will also take that into account. The charge that gets generated for the invoice will be for the amount specified in `amount_due`. - `amount_overpaid` integer, required — Amount that was overpaid on the invoice. The amount overpaid is credited to the customer's credit balance. - `amount_paid` integer, required — The amount, in cents (or local equivalent), that was paid. - `amount_paid_off_stripe` integer, required — Amount, in cents (or local equivalent), that was paid on the invoice outside of Stripe. - `amount_remaining` integer, required — The difference between amount_due and amount_paid, in cents (or local equivalent). - `amount_shipping` integer, required — This is the sum of all the shipping amounts. - `application` union — ID of the Connect Application that created the invoice. - string - Application - … - DeletedApplication - … - `attempt_count` integer, required — Number of payment attempts made for this invoice, from the perspective of the payment retry schedule. Any payment attempt counts as the first attempt, and subsequently only automatic retries increment the attempt count. In other words, manual payment attempts after the first attempt do not affect the retry schedule. If a failure is returned with a non-retryable return code, the invoice can no longer be retried unless a new payment method is obtained. Retries will continue to be scheduled, and attempt_count will continue to increment, but retries will only be executed if a new payment method is obtained. - `attempted` boolean, required — Whether an attempt has been made to pay the invoice. An invoice is not attempted until 1 hour after the `invoice.created` webhook, for example, so you might not want to display that invoice as unpaid to your users. - `auto_advance` boolean, required — Controls whether Stripe performs [automatic collection](https://docs.stripe.com/invoicing/integration/automatic-advancement-collection) of the invoice. If `false`, the invoice's state doesn't automatically advance without an explicit action. - `automatic_tax` AutomaticTax, required - `disabled_reason` 'finalization_requires_location_inputs' | 'finalization_system_error', nullable — If Stripe disabled automatic tax, this enum describes why. - `enabled` boolean, required — Whether Stripe automatically computes tax on this invoice. Note that incompatible invoice items (invoice items with manually specified [tax rates](https://docs.stripe.com/api/tax_rates), negative amounts, or `tax_behavior=unspecified`) cannot be added to automatic tax invoices. - `liability` ConnectAccountReference - … - `provider` string, nullable — The tax provider powering automatic tax. - `status` 'complete' | 'failed' | 'requires_location_inputs', nullable — The status of the most recent automated tax calculation for this invoice. - `automatically_finalizes_at` integer, nullable — The time when this invoice is currently scheduled to be automatically finalized. The field will be `null` if the invoice is not scheduled to finalize in the future. If the invoice is not in the draft state, this field will always be `null` - see `finalized_at` for the time when an already-finalized invoice was finalized. - `billing_reason` 'automatic_pending_invoice_item_invoice' | 'manual' | 'quote_accept' | 'subscription' | 'subscription_create' | 'subscription_cycle' | 'subscription_threshold' | 'subscription_update' | 'upcoming', nullable — Indicates the reason why the invoice was created. * `manual`: Unrelated to a subscription, for example, created via the invoice editor. * `subscription`: No longer in use. Applies to subscriptions from before May 2018 where no distinction was made between updates, cycles, and thresholds. * `subscription_create`: A new subscription was created. * `subscription_cycle`: A subscription advanced into a new period. * `subscription_threshold`: A subscription reached a billing threshold. * `subscription_update`: A subscription was updated. * `upcoming`: Reserved for upcoming invoices created through the Create Preview Invoice API or when an `invoice.upcoming` event is generated for an upcoming invoice on a subscription. - `collection_method` 'charge_automatically' | 'send_invoice', required — Either `charge_automatically`, or `send_invoice`. When charging automatically, Stripe will attempt to pay this invoice using the default source attached to the customer. When sending an invoice, Stripe will email this invoice to the customer with payment instructions. - `confirmation_secret` InvoicesResourceConfirmationSecret - `client_secret` string, required — The client_secret of the payment that Stripe creates for the invoice after finalization. - `type` string, required — The type of client_secret. Currently this is always payment_intent, referencing the default payment_intent that Stripe creates during invoice finalization - `created` integer, required — Time at which the object was created. Measured in seconds since the Unix epoch. - `currency` string, currency, required — 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). - `custom_fields` InvoiceSettingCustomField[], nullable — Custom fields displayed on the invoice. - `name` string, required — The name of the custom field. - `value` string, required — The value of the custom field. - `customer` union, required — The ID of the customer to bill. - string - Customer — This object represents a customer of your business. Use it to [create recurring charges](https://docs.stripe.com/invoicing/customer), [save payment](https://docs.stripe.com/payments/save-during-payment) and contact information, and track payments that belong to the same customer. - … - DeletedCustomer - … - `customer_account` string, nullable — The ID of the account representing the customer to bill. - `customer_address` Address - `city` string, nullable — City, district, suburb, town, or village. - `country` string, nullable — Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)). - `line1` string, nullable — Address line 1, such as the street, PO Box, or company name. - `line2` string, nullable — Address line 2, such as the apartment, suite, unit, or building. - `postal_code` string, nullable — ZIP or postal code. - `state` string, nullable — State, county, province, or region ([ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2)). - `customer_email` string, nullable — The customer's email. Until the invoice is finalized, this field will equal `customer.email`. Once the invoice is finalized, this field will no longer be updated. - `customer_name` string, nullable — The customer's name. Until the invoice is finalized, this field will equal `customer.name`. Once the invoice is finalized, this field will no longer be updated. - `customer_phone` string, nullable — The customer's phone number. Until the invoice is finalized, this field will equal `customer.phone`. Once the invoice is finalized, this field will no longer be updated. - `customer_shipping` Shipping - `address` Address - … - `carrier` string, nullable — The delivery service that shipped a physical product, such as Fedex, UPS, USPS, etc. - `name` string — Recipient name. - `phone` string, nullable — Recipient phone (including extension). - `tracking_number` string, nullable — 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. - `customer_tax_exempt` 'exempt' | 'none' | 'reverse', nullable — The customer's tax exempt status. Until the invoice is finalized, this field will equal `customer.tax_exempt`. Once the invoice is finalized, this field will no longer be updated. - `customer_tax_ids` InvoicesResourceInvoiceTaxId[], nullable — The customer's tax IDs. Until the invoice is finalized, this field will contain the same tax IDs as `customer.tax_ids`. Once the invoice is finalized, this field will no longer be updated. - `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' | 'fo_vat' | 'gb_vat' | 'ge_vat' | 'gi_tin' | 'gn_nif' | 'hk_br' | 'hr_oib' | 'hu_tin' | 'ic_nif' | 'id_npwp' | 'il_vat' | 'in_gst' | 'is_vat' | 'it_cf' | 'jp_cn' | 'jp_rn' | 'jp_trn' | 'ke_pin' | 'kg_tin' | 'kh_tin' | 'kr_brn' | 'kz_bin' | 'la_tin' | 'li_uid' | 'li_vat' | 'lk_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' | 'pl_nip' | 'py_ruc' | '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', required — 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`, `pl_nip`, `it_cf`, `fo_vat`, `gi_tin`, `py_ruc`, `tw_vat`, `th_vat`, `jp_cn`, `jp_rn`, `jp_trn`, `li_uid`, `li_vat`, `lk_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`, `ic_nif`, or `unknown` - `value` string, nullable — The value of the tax ID. - `default_payment_method` union — ID of the default payment method for the invoice. It must belong to the customer associated with the invoice. If not set, defaults to the subscription's default payment method, if any, or to the default payment method in the customer's invoice settings. - string - PaymentMethod — PaymentMethod objects represent your customer's payment instruments. You can use them with [PaymentIntents](https://docs.stripe.com/payments/payment-intents) to collect payments or save them to Customer objects to store instrument details for future payments. Related guides: [Payment Methods](https://docs.stripe.com/payments/payment-methods) and [More Payment Scenarios](https://docs.stripe.com/payments/more-payment-scenarios). - … - `default_source` union — ID of the default payment source for the invoice. It must belong to the customer associated with the invoice and be in a chargeable state. If not set, defaults to the subscription's default source, if any, or to the customer's default source. - string - BankAccount — These bank accounts are payment methods on `Customer` objects. On the other hand [External Accounts](/api#external_accounts) are transfer destinations on `Account` objects for connected accounts. They can be bank accounts or debit cards as well, and are documented in the links above. Related guide: [Bank debits and transfers](/payments/bank-debits-transfers) - … - Card — You can store multiple cards on a customer in order to charge the customer later. You can also store multiple debit cards on a recipient in order to transfer to those cards later. Related guide: [Card payments with Sources](https://docs.stripe.com/sources/cards) - … - Source — `Source` objects allow you to accept a variety of payment methods. They represent a customer's payment instrument, and can be used with the Stripe API just like a `Card` object: once chargeable, they can be charged, or can be attached to customers. Stripe doesn't recommend using the deprecated [Sources API](https://docs.stripe.com/api/sources). We recommend that you adopt the [PaymentMethods API](https://docs.stripe.com/api/payment_methods). This newer API provides access to our latest features and payment method types. Related guides: [Sources API](https://docs.stripe.com/sources) and [Sources & Customers](https://docs.stripe.com/sources/customers). - … - `default_tax_rates` TaxRate[], required — The tax rates applied to this invoice, if any. - `active` boolean, required — Defaults to `true`. When set to `false`, this tax rate cannot be used with new applications or Checkout Sessions, but will still work for subscriptions and invoices that already have it set. - `country` string, nullable — Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)). - `created` integer, required — Time at which the object was created. Measured in seconds since the Unix epoch. - `description` string, nullable — An arbitrary string attached to the tax rate for your internal use only. It will not be visible to your customers. - `display_name` string, required — The display name of the tax rates as it will appear to your customer on their receipt email, PDF, and the hosted invoice page. - `effective_percentage` number, nullable — Actual/effective tax rate percentage out of 100. For tax calculations with automatic_tax[enabled]=true, this percentage reflects the rate actually used to calculate tax based on the product's taxability and whether the user is registered to collect taxes in the corresponding jurisdiction. - `flat_amount` TaxRateFlatAmount — The amount of the tax rate when the `rate_type`` is `flat_amount`. Tax rates with `rate_type` `percentage` can vary based on the transaction, resulting in this field being `null`. This field exposes the amount and currency of the flat tax rate. - … - `id` string, required — Unique identifier for the object. - `inclusive` boolean, required — This specifies if the tax rate is inclusive or exclusive. - `jurisdiction` string, nullable — The jurisdiction for the tax rate. You can use this label field for tax reporting purposes. It also appears on your customer’s invoice. - `jurisdiction_level` 'city' | 'country' | 'county' | 'district' | 'multiple' | 'state', nullable — The level of the jurisdiction that imposes this tax rate. Will be `null` for manually defined tax rates. - `livemode` boolean, required — If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`. - `metadata` object, nullable — Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. - `object` 'tax_rate', required — String representing the object's type. Objects of the same type share the same value. - `percentage` number, required — Tax rate percentage out of 100. For tax calculations with automatic_tax[enabled]=true, this percentage includes the statutory tax rate of non-taxable jurisdictions. - `rate_type` 'flat_amount' | 'percentage', nullable — Indicates the type of tax rate applied to the taxable amount. This value can be `null` when no tax applies to the location. This field is only present for TaxRates created by Stripe Tax. - `state` string, nullable — [ISO 3166-2 subdivision code](https://en.wikipedia.org/wiki/ISO_3166-2), without country prefix. For example, "NY" for New York, United States. - `tax_type` 'amusement_tax' | 'communications_tax' | 'gst' | 'hst' | 'igst' | 'jct' | 'lease_tax' | 'mass_transit_parking_tax' | 'parking_tax' | 'pst' | 'qst' | 'retail_delivery_fee' | 'rst' | 'sales_tax' | 'service_tax' | 'vat', nullable — The high-level tax type, such as `vat` or `sales_tax`. - `description` string, nullable — An arbitrary string attached to the object. Often useful for displaying to users. Referenced as 'memo' in the Dashboard. - `discounts` union[], required — The discounts applied to the invoice. Line item discounts are applied before invoice discounts. Use `expand[]=discounts` to expand each discount. - union - … - `due_date` integer, nullable — The date on which payment for this invoice is due. This value will be `null` for invoices where `collection_method=charge_automatically`. - `effective_at` integer, nullable — The date when this invoice is in effect. Same as `finalized_at` unless overwritten. When defined, this value replaces the system-generated 'Date of issue' printed on the invoice PDF and receipt. - `ending_balance` integer, nullable — Ending customer balance after the invoice is finalized. Invoices are finalized approximately an hour after successful webhook delivery or when payment collection is attempted for the invoice. If the invoice has not been finalized yet, this will be null. - `footer` string, nullable — Footer displayed on the invoice. - `from_invoice` InvoicesResourceFromInvoice - `action` string, required — The relation between this invoice and the cloned invoice - `invoice` union, required — The invoice that was cloned. - … - `hosted_invoice_url` string, nullable — The URL for the hosted invoice page, which allows customers to view and pay an invoice. If the invoice has not been finalized yet, this will be null. - `id` string, required — Unique identifier for the object. For preview invoices created using the [create preview](https://stripe.com/docs/api/invoices/create_preview) endpoint, this id will be prefixed with `upcoming_in`. - `invoice_pdf` string, nullable — The link to download the PDF for the invoice. If the invoice has not been finalized yet, this will be null. - `issuer` ConnectAccountReference, required - `account` union — The connected account being referenced when `type` is `account`. - … - `type` 'account' | 'self', required — Type of the account referenced. - `last_finalization_error` ApiErrors - `advice_code` string — For card errors resulting from a card issuer decline, a short string indicating [how to proceed with an error](https://docs.stripe.com/declines#retrying-issuer-declines) if they provide one. - `charge` string — For card errors, the ID of the failed charge. - `code` string — For some errors that could be handled programmatically, a short string indicating the [error code](https://docs.stripe.com/error-codes) reported. - `decline_code` string — For card errors resulting from a card issuer decline, a short string indicating the [card issuer's reason for the decline](https://docs.stripe.com/declines#issuer-declines) if they provide one. - `doc_url` string — A URL to more information about the [error code](https://docs.stripe.com/error-codes) reported. - `message` string — A human-readable message providing more details about the error. For card errors, these messages can be shown to your users. - `network_advice_code` string — For card errors resulting from a card issuer decline, a 2 digit code which indicates the advice given to merchant by the card network on how to proceed with an error. - `network_decline_code` string — For payments declined by the network, an alphanumeric code which indicates the reason the payment failed. - `param` string — If the error is parameter-specific, the parameter related to the error. For example, you can use this to display a message near the correct form field. - `payment_intent` PaymentIntent — A PaymentIntent guides you through the process of collecting a payment from your customer. We recommend that you create exactly one PaymentIntent for each order or customer session in your system. You can reference the PaymentIntent later to see the history of payment attempts for a particular session. A PaymentIntent transitions through [multiple statuses](/payments/paymentintents/lifecycle) throughout its lifetime as it interfaces with Stripe.js to perform authentication flows and ultimately creates at most one successful charge. Related guide: [Payment Intents API](https://docs.stripe.com/payments/payment-intents) - … - `payment_method` PaymentMethod — PaymentMethod objects represent your customer's payment instruments. You can use them with [PaymentIntents](https://docs.stripe.com/payments/payment-intents) to collect payments or save them to Customer objects to store instrument details for future payments. Related guides: [Payment Methods](https://docs.stripe.com/payments/payment-methods) and [More Payment Scenarios](https://docs.stripe.com/payments/more-payment-scenarios). - … - `payment_method_type` string — If the error is specific to the type of payment method, the payment method type that had a problem. This field is only populated for invoice-related errors. - `request_log_url` string — A URL to the request log entry in your dashboard. - `setup_intent` SetupIntent — A SetupIntent guides you through the process of setting up and saving a customer's payment credentials for future payments. For example, you can use a SetupIntent to set up and save your customer's card without immediately collecting a payment. Later, you can use [PaymentIntents](https://api.stripe.com#payment_intents) to drive the payment flow. Create a SetupIntent when you're ready to collect your customer's payment credentials. Don't maintain long-lived, unconfirmed SetupIntents because they might not be valid. The SetupIntent transitions through multiple [statuses](https://docs.stripe.com/payments/intents#intent-statuses) as it guides you through the setup process. Successful SetupIntents result in payment credentials that are optimized for future payments. For example, cardholders in [certain regions](https://stripe.com/guides/strong-customer-authentication) might need to be run through [Strong Customer Authentication](https://docs.stripe.com/strong-customer-authentication) during payment method collection to streamline later [off-session payments](https://docs.stripe.com/payments/setup-intents). If you use the SetupIntent with a [Customer](https://api.stripe.com#setup_intent_object-customer), it automatically attaches the resulting payment method to that Customer after successful setup. We recommend using SetupIntents or [setup_future_usage](https://api.stripe.com#payment_intent_object-setup_future_usage) on PaymentIntents to save payment methods to prevent saving invalid or unoptimized payment methods. By using SetupIntents, you can reduce friction for your customers, even as regulations change over time. Related guide: [Setup Intents API](https://docs.stripe.com/payments/setup-intents) - … - `source` union — The [source object](https://docs.stripe.com/api/sources/object) for errors returned on a request involving a source. - … - `type` 'api_error' | 'card_error' | 'idempotency_error' | 'invalid_request_error', required — The type of error returned. One of `api_error`, `card_error`, `idempotency_error`, or `invalid_request_error` - `latest_revision` union — The ID of the most recent non-draft revision of this invoice - string - Invoice — recursive - `lines` object, required — The individual line items that make up the invoice. `lines` is sorted as follows: (1) pending invoice items (including prorations) in reverse chronological order, (2) subscription items in reverse chronological order, and (3) invoice items added after invoice creation in chronological order. - `data` LineItem[], required — Details about each object. - … - `has_more` boolean, required — True if this list has another page of items after this one that can be fetched. - `object` 'list', required — String representing the object's type. Objects of the same type share the same value. Always has the value `list`. - `url` string, required — The URL where this list can be accessed. - `livemode` boolean, required — If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`. - `metadata` object, nullable — Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. - `next_payment_attempt` integer, nullable — The time at which payment will next be attempted. This value will be `null` for invoices where `collection_method=send_invoice`. - `number` string, nullable — A unique, identifying string that appears on emails sent to the customer for this invoice. This starts with the customer's unique invoice_prefix if it is specified. - `object` 'invoice', required — String representing the object's type. Objects of the same type share the same value. - `on_behalf_of` union — The account (if any) for which the funds of the invoice payment are intended. If set, the invoice will be presented with the branding and support information of the specified account. See the [Invoices with Connect](https://docs.stripe.com/billing/invoices/connect) documentation for details. - string - Account — For new integrations, we recommend using the [Accounts v2 API](/api/v2/core/accounts), in place of /v1/accounts and /v1/customers to represent a user. This is an object representing a Stripe account. You can retrieve it to see properties on the account like its current requirements or if the account is enabled to make live charges or receive payouts. For accounts where [controller.requirement_collection](/api/accounts/object#account_object-controller-requirement_collection) is `application`, which includes Custom accounts, the properties below are always returned. For accounts where [controller.requirement_collection](/api/accounts/object#account_object-controller-requirement_collection) is `stripe`, which includes Standard and Express accounts, some properties are only returned until you create an [Account Link](/api/account_links) or [Account Session](/api/account_sessions) to start Connect Onboarding. Learn about the [differences between accounts](/connect/accounts). - … - `parent` BillingBillResourceInvoicingParentsInvoiceParent - `quote_details` BillingBillResourceInvoicingParentsInvoiceQuoteParent - … - `subscription_details` BillingBillResourceInvoicingParentsInvoiceSubscriptionParent - … - `type` 'quote_details' | 'subscription_details', required — The type of parent that generated this invoice - `payment_settings` InvoicesPaymentSettings, required - `default_mandate` string, nullable — ID of the mandate to be used for this invoice. It must correspond to the payment method used to pay the invoice, including the invoice's default_payment_method or default_source, if set. - `payment_method_options` InvoicesPaymentMethodOptions - … - `payment_method_types` string[], nullable — The list of payment method types (e.g. card) to provide to the invoice’s PaymentIntent. If not set, Stripe attempts to automatically determine the types to use by looking at the invoice’s default payment method, the subscription’s default payment method, the customer’s default payment method, and your [invoice template settings](https://dashboard.stripe.com/settings/billing/invoice). - `payments` object — Payments for this invoice. Use [invoice payment](/api/invoice-payment) to get more details. - `data` InvoicePayment[], required — Details about each object. - … - `has_more` boolean, required — True if this list has another page of items after this one that can be fetched. - `object` 'list', required — String representing the object's type. Objects of the same type share the same value. Always has the value `list`. - `url` string, required — The URL where this list can be accessed. - `period_end` integer, required — The latest timestamp at which invoice items can be associated with this invoice. Use the [line item period](/api/invoices/line_item#invoice_line_item_object-period) to get the service period for each price. - `period_start` integer, required — The earliest timestamp at which invoice items can be associated with this invoice. Use the [line item period](/api/invoices/line_item#invoice_line_item_object-period) to get the service period for each price. - `post_payment_credit_notes_amount` integer, required — Total amount of all post-payment credit notes issued for this invoice. - `pre_payment_credit_notes_amount` integer, required — Total amount of all pre-payment credit notes issued for this invoice. - `receipt_number` string, nullable — This is the transaction number that appears on email receipts sent for this invoice. - `rendering` InvoicesResourceInvoiceRendering - `amount_tax_display` string, nullable — How line-item prices and amounts will be displayed with respect to tax on invoice PDFs. - `pdf` InvoiceRenderingPdf - … - `template` string, nullable — ID of the rendering template that the invoice is formatted by. - `template_version` integer, nullable — Version of the rendering template that the invoice is using. - `shipping_cost` InvoicesResourceShippingCost - `amount_subtotal` integer, required — Total shipping cost before any taxes are applied. - `amount_tax` integer, required — Total tax amount applied due to shipping costs. If no tax was applied, defaults to 0. - `amount_total` integer, required — Total shipping cost after taxes are applied. - `shipping_rate` union — The ID of the ShippingRate for this invoice. - … - `taxes` LineItemsTaxAmount[] — The taxes applied to the shipping rate. - … - `shipping_details` Shipping - `address` Address - … - `carrier` string, nullable — The delivery service that shipped a physical product, such as Fedex, UPS, USPS, etc. - `name` string — Recipient name. - `phone` string, nullable — Recipient phone (including extension). - `tracking_number` string, nullable — 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. - `starting_balance` integer, required — Starting customer balance before the invoice is finalized. If the invoice has not been finalized yet, this will be the current customer balance. For revision invoices, this also includes any customer balance that was applied to the original invoice. - `statement_descriptor` string, nullable — Extra information about an invoice for the customer's credit card statement. - `status` 'draft' | 'open' | 'paid' | 'uncollectible' | 'void', nullable — The status of the invoice, one of `draft`, `open`, `paid`, `uncollectible`, or `void`. [Learn more](https://docs.stripe.com/billing/invoices/workflow#workflow-overview) - `status_transitions` InvoicesResourceStatusTransitions, required - `finalized_at` integer, nullable — The time that the invoice draft was finalized. - `marked_uncollectible_at` integer, nullable — The time that the invoice was marked uncollectible. - `paid_at` integer, nullable — The time that the invoice was paid. - `voided_at` integer, nullable — The time that the invoice was voided. - `subtotal` integer, required — Total of all subscriptions, invoice items, and prorations on the invoice before any invoice level discount or exclusive tax is applied. Item discounts are already incorporated - `subtotal_excluding_tax` integer, nullable — The integer amount in cents (or local equivalent) representing the subtotal of the invoice before any invoice level discount or tax is applied. Item discounts are already incorporated - `test_clock` union — ID of the test clock this invoice belongs to. - string - TestHelpersTestClock — A test clock enables deterministic control over objects in testmode. With a test clock, you can create objects at a frozen time in the past or future, and advance to a specific future time to observe webhooks and state changes. After the clock advances, you can either validate the current state of your scenario (and test your assumptions), change the current state of your scenario (and test more complex scenarios), or keep advancing forward in time. - … - `threshold_reason` InvoiceThresholdReason - `amount_gte` integer, nullable — The total invoice amount threshold boundary if it triggered the threshold invoice. - `item_reasons` InvoiceItemThresholdReason[], required — Indicates which line items triggered a threshold invoice. - … - `total` integer, required — Total after discounts and taxes. - `total_discount_amounts` DiscountsResourceDiscountAmount[], nullable — The aggregate amounts calculated per discount across all line items. - `amount` integer, required — The amount, in cents (or local equivalent), of the discount. - `discount` union, required — The discount that was applied to get this discount amount. - … - `total_excluding_tax` integer, nullable — The integer amount in cents (or local equivalent) representing the total amount of the invoice including all discounts but excluding all tax. - `total_pretax_credit_amounts` InvoicesResourcePretaxCreditAmount[], nullable — Contains pretax credit amounts (ex: discount, credit grants, etc) that apply to this invoice. This is a combined list of total_pretax_credit_amounts across all invoice line items. - `amount` integer, required — The amount, in cents (or local equivalent), of the pretax credit amount. - `credit_balance_transaction` union — The credit balance transaction that was applied to get this pretax credit amount. - … - `discount` union — The discount that was applied to get this pretax credit amount. - … - `type` 'credit_balance_transaction' | 'discount', required — Type of the pretax credit amount referenced. - `total_taxes` BillingBillResourceInvoicingTaxesTax[], nullable — The aggregate tax information of all line items. - `amount` integer, required — The amount of the tax, in cents (or local equivalent). - `tax_behavior` 'exclusive' | 'inclusive', required — Whether this tax is inclusive or exclusive. - `tax_rate_details` BillingBillResourceInvoicingTaxesTaxRateDetails - … - `taxability_reason` 'customer_exempt' | 'not_available' | 'not_collecting' | 'not_subject_to_tax' | 'not_supported' | 'portion_product_exempt' | 'portion_reduced_rated' | 'portion_standard_rated' | 'product_exempt' | 'product_exempt_holiday' | 'proportionally_rated' | 'reduced_rated' | 'reverse_charge' | 'standard_rated' | 'taxable_basis_reduced' | 'zero_rated', required — The reasoning behind this tax, for example, if the product is tax exempt. The possible values for this field may be extended as new tax rules are supported. - `taxable_amount` integer, nullable — The amount on which tax is calculated, in cents (or local equivalent). - `type` 'tax_rate_details', required — The type of tax information. - `webhooks_delivered_at` integer, nullable — Invoices are automatically paid or sent 1 hour after webhooks are delivered, or until all webhook delivery attempts have [been exhausted](https://docs.stripe.com/billing/webhooks#understand). This field tracks the time when webhooks for this invoice were successfully delivered. If the invoice had no webhooks to deliver, this will be set while the invoice is being created. - `invoice_creation` PaymentPagesCheckoutSessionInvoiceCreation - `enabled` boolean, required — Indicates whether invoice creation is enabled for the Checkout Session. - `invoice_data` PaymentPagesCheckoutSessionInvoiceSettings, required - `account_tax_ids` union[], nullable — The account tax IDs associated with the invoice. - union - … - `custom_fields` InvoiceSettingCustomField[], nullable — Custom fields displayed on the invoice. - `name` string, required — The name of the custom field. - `value` string, required — The value of the custom field. - `description` string, nullable — An arbitrary string attached to the object. Often useful for displaying to users. - `footer` string, nullable — Footer displayed on the invoice. - `issuer` ConnectAccountReference - `account` union — The connected account being referenced when `type` is `account`. - … - `type` 'account' | 'self', required — Type of the account referenced. - `metadata` object, nullable — Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. - `rendering_options` InvoiceSettingCheckoutRenderingOptions - `amount_tax_display` string, nullable — How line-item prices and amounts will be displayed with respect to tax on invoice PDFs. - `template` string, nullable — ID of the invoice rendering template to be used for the generated invoice. - `line_items` object — The line items purchased by the customer. - `data` Item[], required — Details about each object. - `adjustable_quantity` LineItemsAdjustableQuantity - `enabled` boolean, required - `maximum` integer, nullable - `minimum` integer, nullable - `amount_discount` integer, required — Total discount amount applied. If no discounts were applied, defaults to 0. - `amount_subtotal` integer, required — Total before any discounts or taxes are applied. - `amount_tax` integer, required — Total tax amount applied. If no tax was applied, defaults to 0. - `amount_total` integer, required — Total after discounts and taxes. - `currency` string, currency, required — 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). - `description` string, nullable — An arbitrary string attached to the object. Often useful for displaying to users. Defaults to product name. - `discounts` LineItemsDiscountAmount[] — The discounts applied to the line item. - `amount` integer, required — The amount discounted. - `discount` Discount, required — A discount represents the actual application of a [coupon](https://api.stripe.com#coupons) or [promotion code](https://api.stripe.com#promotion_codes). It contains information about when the discount began, when it will end, and what it is applied to. Related guide: [Applying discounts to subscriptions](https://docs.stripe.com/billing/subscriptions/discounts) - … - `id` string, required — Unique identifier for the object. - `metadata` object, nullable — Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. - `object` 'item', required — String representing the object's type. Objects of the same type share the same value. - `price` Price — Prices define the unit cost, currency, and (optional) billing cycle for both recurring and one-time purchases of products. [Products](https://api.stripe.com#products) help you track inventory or provisioning, and prices help you track payment terms. Different physical goods or levels of service should be represented by products, and pricing options should be represented by prices. This approach lets you change prices without having to change your provisioning scheme. For example, you might have a single "gold" product that has prices for $10/month, $100/year, and €9 once. Related guides: [Set up a subscription](https://docs.stripe.com/billing/subscriptions/set-up-subscription), [create an invoice](https://docs.stripe.com/billing/invoices/create), and more about [products and prices](https://docs.stripe.com/products-prices/overview). - `active` boolean, required — Whether the price can be used for new purchases. - `billing_scheme` 'per_unit' | 'tiered', required — Describes how to compute the price per period. Either `per_unit` or `tiered`. `per_unit` indicates that the fixed amount (specified in `unit_amount` or `unit_amount_decimal`) will be charged per unit in `quantity` (for prices with `usage_type=licensed`), or per unit of total usage (for prices with `usage_type=metered`). `tiered` indicates that the unit pricing will be computed using a tiering strategy as defined using the `tiers` and `tiers_mode` attributes. - `created` integer, required — Time at which the object was created. Measured in seconds since the Unix epoch. - `currency` string, currency, required — 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_options` object — Prices defined in each available currency option. Each key must be a three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html) and a [supported currency](https://stripe.com/docs/currencies). - `custom_unit_amount` CustomUnitAmount - … - `id` string, required — Unique identifier for the object. - `livemode` boolean, required — If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`. - `lookup_key` string, nullable — A lookup key used to retrieve prices dynamically from a static string. This may be up to 200 characters. - `metadata` object, required — Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. - `nickname` string, nullable — A brief description of the price, hidden from customers. - `object` 'price', required — String representing the object's type. Objects of the same type share the same value. - `product` union, required — The ID of the product this price is associated with. - … - `recurring` Recurring - … - `tax_behavior` 'exclusive' | 'inclusive' | 'unspecified', nullable — Only required if a [default tax behavior](https://docs.stripe.com/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. - `tiers` PriceTier[] — Each element represents a pricing tier. This parameter requires `billing_scheme` to be set to `tiered`. See also the documentation for `billing_scheme`. - … - `tiers_mode` 'graduated' | 'volume', nullable — Defines if the tiering price should be `graduated` or `volume` based. In `volume`-based tiering, the maximum quantity within a period determines the per unit price. In `graduated` tiering, pricing can change as the quantity grows. - `transform_quantity` TransformQuantity - … - `type` 'one_time' | 'recurring', required — One of `one_time` or `recurring` depending on whether the price is for a one-time purchase or a recurring (subscription) purchase. - `unit_amount` integer, nullable — The unit amount in cents (or local equivalent) to be charged, represented as a whole integer if possible. Only set if `billing_scheme=per_unit`. - `unit_amount_decimal` string, decimal, nullable — The unit amount in cents (or local equivalent) to be charged, represented as a decimal string with at most 12 decimal places. Only set if `billing_scheme=per_unit`. - `quantity` integer, nullable — The quantity of products being purchased. - `taxes` LineItemsTaxAmount[] — The taxes applied to the line item. - `amount` integer, required — Amount of tax applied for this rate. - `rate` TaxRate, required — Tax rates can be applied to [invoices](/invoicing/taxes/tax-rates), [subscriptions](/billing/taxes/tax-rates) and [Checkout Sessions](/payments/checkout/use-manual-tax-rates) to collect tax. Related guide: [Tax rates](/billing/taxes/tax-rates) - … - `taxability_reason` 'customer_exempt' | 'not_collecting' | 'not_subject_to_tax' | 'not_supported' | 'portion_product_exempt' | 'portion_reduced_rated' | 'portion_standard_rated' | 'product_exempt' | 'product_exempt_holiday' | 'proportionally_rated' | 'reduced_rated' | 'reverse_charge' | 'standard_rated' | 'taxable_basis_reduced' | 'zero_rated', nullable — The reasoning behind this tax, for example, if the product is tax exempt. The possible values for this field may be extended as new tax rules are supported. - `taxable_amount` integer, nullable — The amount on which tax is calculated, in cents (or local equivalent). - `has_more` boolean, required — True if this list has another page of items after this one that can be fetched. - `object` 'list', required — String representing the object's type. Objects of the same type share the same value. Always has the value `list`. - `url` string, required — The URL where this list can be accessed. - `livemode` boolean, required — If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`. - `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', nullable — The IETF language tag of the locale Checkout is displayed in. If blank or `auto`, the browser's locale is used. - `managed_payments` PaymentPagesCheckoutSessionManagedPayments - `enabled` boolean, required — Set to `true` to enable [Managed Payments](https://docs.stripe.com/payments/managed-payments), Stripe's merchant of record solution, for this session. - `metadata` object, nullable — Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. - `mode` 'payment' | 'setup' | 'subscription', required — The mode of the Checkout Session. - `name_collection` PaymentPagesCheckoutSessionNameCollection - `business` PaymentPagesCheckoutSessionBusinessName - `enabled` boolean, required — Indicates whether business name collection is enabled for the session - `optional` boolean, required — Whether the customer is required to complete the field before completing the Checkout Session. Defaults to `false`. - `individual` PaymentPagesCheckoutSessionIndividualName - `enabled` boolean, required — Indicates whether individual name collection is enabled for the session - `optional` boolean, required — Whether the customer is required to complete the field before completing the Checkout Session. Defaults to `false`. - `object` 'checkout.session', required — String representing the object's type. Objects of the same type share the same value. - `optional_items` PaymentPagesCheckoutSessionOptionalItem[], nullable — The optional items presented to the customer at checkout. - `adjustable_quantity` PaymentPagesCheckoutSessionOptionalItemAdjustableQuantity - `enabled` boolean, required — Set to true if the quantity can be adjusted to any non-negative integer. - `maximum` integer, nullable — The maximum quantity of this item the customer can purchase. By default this value is 99. You can specify a value up to 999999. - `minimum` integer, nullable — 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. - `price` string, required - `quantity` integer, required - `origin_context` 'mobile_app' | 'web', nullable — Where the user is coming from. This informs the optimizations that are applied to the session. - `payment_intent` union — 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://docs.stripe.com/api/checkout/sessions/expire) instead. - string - PaymentIntent — A PaymentIntent guides you through the process of collecting a payment from your customer. We recommend that you create exactly one PaymentIntent for each order or customer session in your system. You can reference the PaymentIntent later to see the history of payment attempts for a particular session. A PaymentIntent transitions through [multiple statuses](/payments/paymentintents/lifecycle) throughout its lifetime as it interfaces with Stripe.js to perform authentication flows and ultimately creates at most one successful charge. Related guide: [Payment Intents API](https://docs.stripe.com/payments/payment-intents) - `allowed_payment_method_types` string[], nullable — The list of payment method types allowed for use with this payment. Stripe automatically returns compatible payment methods from this list in the `payment_method_types` field of the response, based on the other PaymentIntent parameters, such as `currency`, `amount`, and `customer`. - `amount` integer — Amount intended to be collected by this PaymentIntent. A positive integer representing how much to charge in the [smallest currency unit](https://docs.stripe.com/currencies#zero-decimal) (e.g., 100 cents to charge $1.00 or 100 to charge ¥100, a zero-decimal currency). The minimum amount is $0.50 US or [equivalent in charge currency](https://docs.stripe.com/currencies#minimum-and-maximum-charge-amounts). The amount value supports up to eight digits (e.g., a value of 99999999 for a USD charge of $999,999.99). - `amount_capturable` integer — Amount that can be captured from this PaymentIntent. - `amount_details` union - PaymentFlowsAmountDetails - … - PaymentFlowsAmountDetailsClient - … - `amount_received` integer — Amount that this PaymentIntent collects. - `application` union — ID of the Connect application that created the PaymentIntent. - string - Application - … - `application_fee_amount` integer, nullable — 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://docs.stripe.com/payments/connected-accounts). - `automatic_payment_methods` PaymentFlowsAutomaticPaymentMethodsPaymentIntent - `allow_redirects` 'always' | 'never' — Controls whether this PaymentIntent will accept redirect-based payment methods. Redirect-based payment methods may require your customer to be redirected to a payment method's app or site for authentication or additional steps. To [confirm](https://docs.stripe.com/api/payment_intents/confirm) this PaymentIntent, you may be required to provide a `return_url` to redirect customers back to your site after they authenticate or complete the payment. - `enabled` boolean, required — Automatically calculates compatible payment methods - `canceled_at` integer, nullable — Populated when `status` is `canceled`, this is the time at which the PaymentIntent was canceled. Measured in seconds since the Unix epoch. - `cancellation_reason` 'abandoned' | 'automatic' | 'duplicate' | 'expired' | 'failed_invoice' | 'fraudulent' | 'requested_by_customer' | 'void_invoice', nullable — Reason for cancellation of this PaymentIntent, either user-provided (`duplicate`, `fraudulent`, `requested_by_customer`, or `abandoned`) or generated by Stripe internally (`failed_invoice`, `void_invoice`, `automatic`, or `expired`). - `capture_method` 'automatic' | 'automatic_async' | 'manual' — Controls when the funds will be captured from the customer's account. - `client_secret` string, nullable — The client secret of this PaymentIntent. Used for client-side retrieval using a publishable key. The client secret can be used to complete a payment from your frontend. It should not be stored, logged, or exposed to anyone other than the customer. Make sure that you have TLS enabled on any page that includes the client secret. Refer to our docs to [accept a payment](https://docs.stripe.com/payments/accept-a-payment?ui=elements) and learn about how `client_secret` should be handled. - `confirmation_method` 'automatic' | 'manual' — Describes whether we can confirm this PaymentIntent automatically, or if it requires customer action to confirm the payment. - `created` integer, required — Time at which the object was created. Measured in seconds since the Unix epoch. - `currency` string, currency — Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). - `customer` union — ID of the Customer this PaymentIntent belongs to, if one exists. Payment methods attached to other Customers cannot be used with this PaymentIntent. If [setup_future_usage](https://api.stripe.com#payment_intent_object-setup_future_usage) is set and this PaymentIntent's payment method is not `card_present`, then the payment method attaches to the Customer after the PaymentIntent has been confirmed and any required actions from the user are complete. If the payment method is `card_present` and isn't a digital wallet, then a [generated_card](https://docs.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card is created and attached to the Customer instead. - string - Customer — This object represents a customer of your business. Use it to [create recurring charges](https://docs.stripe.com/invoicing/customer), [save payment](https://docs.stripe.com/payments/save-during-payment) and contact information, and track payments that belong to the same customer. - … - DeletedCustomer - … - `customer_account` string, nullable — ID of the Account representing the customer that this PaymentIntent belongs to, if one exists. Payment methods attached to other Accounts cannot be used with this PaymentIntent. If [setup_future_usage](https://api.stripe.com#payment_intent_object-setup_future_usage) is set and this PaymentIntent's payment method is not `card_present`, then the payment method attaches to the Account after the PaymentIntent has been confirmed and any required actions from the user are complete. If the payment method is `card_present` and isn't a digital wallet, then a [generated_card](https://docs.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card is created and attached to the Account instead. - `description` string, nullable — An arbitrary string attached to the object. Often useful for displaying to users. - `excluded_payment_method_types` string[], nullable — The list of payment method types to exclude from use with this payment. - `hooks` PaymentFlowsPaymentIntentAsyncWorkflows - `inputs` PaymentFlowsPaymentIntentAsyncWorkflowsResourceInputs - … - `id` string, required — Unique identifier for the object. - `last_payment_error` ApiErrors - `advice_code` string — For card errors resulting from a card issuer decline, a short string indicating [how to proceed with an error](https://docs.stripe.com/declines#retrying-issuer-declines) if they provide one. - `charge` string — For card errors, the ID of the failed charge. - `code` string — For some errors that could be handled programmatically, a short string indicating the [error code](https://docs.stripe.com/error-codes) reported. - `decline_code` string — For card errors resulting from a card issuer decline, a short string indicating the [card issuer's reason for the decline](https://docs.stripe.com/declines#issuer-declines) if they provide one. - `doc_url` string — A URL to more information about the [error code](https://docs.stripe.com/error-codes) reported. - `message` string — A human-readable message providing more details about the error. For card errors, these messages can be shown to your users. - `network_advice_code` string — For card errors resulting from a card issuer decline, a 2 digit code which indicates the advice given to merchant by the card network on how to proceed with an error. - `network_decline_code` string — For payments declined by the network, an alphanumeric code which indicates the reason the payment failed. - `param` string — If the error is parameter-specific, the parameter related to the error. For example, you can use this to display a message near the correct form field. - `payment_intent` PaymentIntent — recursive - `payment_method` PaymentMethod — PaymentMethod objects represent your customer's payment instruments. You can use them with [PaymentIntents](https://docs.stripe.com/payments/payment-intents) to collect payments or save them to Customer objects to store instrument details for future payments. Related guides: [Payment Methods](https://docs.stripe.com/payments/payment-methods) and [More Payment Scenarios](https://docs.stripe.com/payments/more-payment-scenarios). - … - `payment_method_type` string — If the error is specific to the type of payment method, the payment method type that had a problem. This field is only populated for invoice-related errors. - `request_log_url` string — A URL to the request log entry in your dashboard. - `setup_intent` SetupIntent — A SetupIntent guides you through the process of setting up and saving a customer's payment credentials for future payments. For example, you can use a SetupIntent to set up and save your customer's card without immediately collecting a payment. Later, you can use [PaymentIntents](https://api.stripe.com#payment_intents) to drive the payment flow. Create a SetupIntent when you're ready to collect your customer's payment credentials. Don't maintain long-lived, unconfirmed SetupIntents because they might not be valid. The SetupIntent transitions through multiple [statuses](https://docs.stripe.com/payments/intents#intent-statuses) as it guides you through the setup process. Successful SetupIntents result in payment credentials that are optimized for future payments. For example, cardholders in [certain regions](https://stripe.com/guides/strong-customer-authentication) might need to be run through [Strong Customer Authentication](https://docs.stripe.com/strong-customer-authentication) during payment method collection to streamline later [off-session payments](https://docs.stripe.com/payments/setup-intents). If you use the SetupIntent with a [Customer](https://api.stripe.com#setup_intent_object-customer), it automatically attaches the resulting payment method to that Customer after successful setup. We recommend using SetupIntents or [setup_future_usage](https://api.stripe.com#payment_intent_object-setup_future_usage) on PaymentIntents to save payment methods to prevent saving invalid or unoptimized payment methods. By using SetupIntents, you can reduce friction for your customers, even as regulations change over time. Related guide: [Setup Intents API](https://docs.stripe.com/payments/setup-intents) - … - `source` union — The [source object](https://docs.stripe.com/api/sources/object) for errors returned on a request involving a source. - … - `type` 'api_error' | 'card_error' | 'idempotency_error' | 'invalid_request_error', required — The type of error returned. One of `api_error`, `card_error`, `idempotency_error`, or `invalid_request_error` - `latest_charge` union — ID of the latest [Charge object](https://docs.stripe.com/api/charges) created by this PaymentIntent. This property is `null` until PaymentIntent confirmation is attempted. - string - Charge — The `Charge` object represents a single attempt to move money into your Stripe account. PaymentIntent confirmation is the most common way to create Charges, but [Account Debits](https://docs.stripe.com/connect/account-debits) may also create Charges. Some legacy payment flows create Charges directly, which is not recommended for new integrations. - … - `livemode` boolean, required — If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`. - `managed_payments` SmorResourceManagedPayments - `enabled` boolean, required — Set to `true` to enable [Managed Payments](https://docs.stripe.com/payments/managed-payments), Stripe's merchant of record solution, for this session. - `metadata` object — Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Learn more about [storing information in metadata](https://docs.stripe.com/payments/payment-intents/creating-payment-intents#storing-information-in-metadata). - `next_action` PaymentIntentNextAction - `alipay_handle_redirect` PaymentIntentNextActionAlipayHandleRedirect - … - `blik_authorize` PaymentIntentNextActionBlikAuthorize - `boleto_display_details` PaymentIntentNextActionBoleto - … - `card_await_notification` PaymentIntentNextActionCardAwaitNotification - … - `cashapp_handle_redirect_or_display_qr_code` PaymentIntentNextActionCashappHandleRedirectOrDisplayQrCode - … - `display_bank_transfer_instructions` PaymentIntentNextActionDisplayBankTransferInstructions - … - `klarna_display_qr_code` PaymentIntentNextActionKlarnaDisplayQrCode - … - `konbini_display_details` PaymentIntentNextActionKonbini - … - `multibanco_display_details` PaymentIntentNextActionDisplayMultibancoDetails - … - `oxxo_display_details` PaymentIntentNextActionDisplayOxxoDetails - … - `paynow_display_qr_code` PaymentIntentNextActionPaynowDisplayQrCode - … - `pix_display_qr_code` PaymentIntentNextActionPixDisplayQrCode - … - `promptpay_display_qr_code` PaymentIntentNextActionPromptpayDisplayQrCode - … - `redirect_to_url` PaymentIntentNextActionRedirectToUrl - … - `swish_handle_redirect_or_display_qr_code` PaymentIntentNextActionSwishHandleRedirectOrDisplayQrCode - … - `type` string, required — Type of the next action to perform. Refer to the other child attributes under `next_action` for available values. Examples include: `redirect_to_url`, `use_stripe_sdk`, `alipay_handle_redirect`, `oxxo_display_details`, or `verify_with_microdeposits`. - `upi_handle_redirect_or_display_qr_code` PaymentIntentNextActionUpiHandleRedirectOrDisplayQrCode - … - `use_stripe_sdk` object — When confirming a PaymentIntent with Stripe.js, Stripe.js depends on the contents of this dictionary to invoke authentication flows. The shape of the contents is subject to change and is only intended to be used by Stripe.js. - `verify_with_microdeposits` PaymentIntentNextActionVerifyWithMicrodeposits - … - `wechat_pay_display_qr_code` PaymentIntentNextActionWechatPayDisplayQrCode - … - `wechat_pay_redirect_to_android_app` PaymentIntentNextActionWechatPayRedirectToAndroidApp - … - `wechat_pay_redirect_to_ios_app` PaymentIntentNextActionWechatPayRedirectToIosApp - … - `object` 'payment_intent', required — String representing the object's type. Objects of the same type share the same value. - `on_behalf_of` union — You can specify the settlement merchant as the connected account using the `on_behalf_of` attribute on the charge. See the PaymentIntents [use case for connected accounts](/payments/connected-accounts) for details. - string - Account — For new integrations, we recommend using the [Accounts v2 API](/api/v2/core/accounts), in place of /v1/accounts and /v1/customers to represent a user. This is an object representing a Stripe account. You can retrieve it to see properties on the account like its current requirements or if the account is enabled to make live charges or receive payouts. For accounts where [controller.requirement_collection](/api/accounts/object#account_object-controller-requirement_collection) is `application`, which includes Custom accounts, the properties below are always returned. For accounts where [controller.requirement_collection](/api/accounts/object#account_object-controller-requirement_collection) is `stripe`, which includes Standard and Express accounts, some properties are only returned until you create an [Account Link](/api/account_links) or [Account Session](/api/account_sessions) to start Connect Onboarding. Learn about the [differences between accounts](/connect/accounts). - … - `payment_details` PaymentFlowsPaymentDetails - `customer_reference` string, nullable — A unique value to identify the customer. This field is available only for card payments. This field is truncated to 25 alphanumeric characters, excluding spaces, before being sent to card networks. - `order_reference` string, nullable — A unique value assigned by the business to identify the transaction. Required for L2 and L3 rates. For Cards, this field is truncated to 25 alphanumeric characters, excluding spaces, before being sent to card networks. For Klarna, this field is truncated to 255 characters and is visible to customers when they view the order in the Klarna app. - `payment_method` union — ID of the payment method used in this PaymentIntent. - string - PaymentMethod — PaymentMethod objects represent your customer's payment instruments. You can use them with [PaymentIntents](https://docs.stripe.com/payments/payment-intents) to collect payments or save them to Customer objects to store instrument details for future payments. Related guides: [Payment Methods](https://docs.stripe.com/payments/payment-methods) and [More Payment Scenarios](https://docs.stripe.com/payments/more-payment-scenarios). - … - `payment_method_configuration_details` PaymentMethodConfigBizPaymentMethodConfigurationDetails - `id` string, required — ID of the payment method configuration used. - `parent` string, nullable — ID of the parent payment method configuration used. - `payment_method_options` PaymentIntentPaymentMethodOptions - `acss_debit` union - … - `affirm` union - … - `afterpay_clearpay` union - … - `alipay` union - … - `alma` union - … - `amazon_pay` union - … - `au_becs_debit` union - … - `bacs_debit` union - … - `bancontact` union - … - `billie` union - … - `bizum` union - … - `blik` union - … - `boleto` union - … - `card` union - … - `card_present` union - … - `cashapp` union - … - `crypto` union - … - `customer_balance` union - … - `eps` union - … - `fpx` union - … - `giropay` union - … - `grabpay` union - … - `ideal` union - … - `interac_present` union - … - `kakao_pay` union - … - `klarna` union - … - `konbini` union - … - `kr_card` union - … - `link` union - … - `mb_way` union - … - `mobilepay` union - … - `multibanco` union - … - `naver_pay` union - … - `nz_bank_account` union - … - `oxxo` union - … - `p24` union - … - `pay_by_bank` union - … - `payco` union - … - `paynow` union - … - `paypal` union - … - `payto` union - … - `pix` union - … - `promptpay` union - … - `revolut_pay` union - … - `samsung_pay` union - … - `satispay` union - … - `scalapay` union - … - `sepa_debit` union - … - `sofort` union - … - `sunbit` union - … - `swish` union - … - `twint` union - … - `upi` union - … - `us_bank_account` union - … - `wechat_pay` union - … - `zip` union - … - `payment_method_types` string[] — The list of payment method types (e.g. card) that this PaymentIntent is allowed to use. A comprehensive list of valid payment method types can be found [here](https://docs.stripe.com/api/payment_methods/object#payment_method_object-type). - `presentment_details` PaymentFlowsPaymentIntentPresentmentDetails - `presentment_amount` integer, required — Amount intended to be collected by this payment, denominated in `presentment_currency`. - `presentment_currency` string, required — Currency presented to the customer during payment. - `processing` PaymentIntentProcessing - `card` PaymentIntentCardProcessing - … - `type` 'card', required — Type of the payment method for which payment is in `processing` state, one of `card`. - `receipt_email` string, nullable — 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). - `review` union — ID of the review associated with this PaymentIntent, if any. - string - Review — Reviews can be used to supplement automated fraud detection with human expertise. Learn more about [Radar](/radar) and reviewing payments [here](https://docs.stripe.com/radar/reviews). - … - `setup_future_usage` 'off_session' | 'on_session', nullable — 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](/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](/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](/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](/strong-customer-authentication). - `shipping` Shipping - `address` Address - … - `carrier` string, nullable — The delivery service that shipped a physical product, such as Fedex, UPS, USPS, etc. - `name` string — Recipient name. - `phone` string, nullable — Recipient phone (including extension). - `tracking_number` string, nullable — 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. - `statement_descriptor` string, nullable — 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_suffix` string, nullable — 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. - `status` 'canceled' | 'processing' | 'requires_action' | 'requires_capture' | 'requires_confirmation' | 'requires_payment_method' | 'succeeded', required — Status of this PaymentIntent, one of `requires_payment_method`, `requires_confirmation`, `requires_action`, `processing`, `requires_capture`, `canceled`, or `succeeded`. Read more about each PaymentIntent [status](https://docs.stripe.com/payments/intents#intent-statuses). - `transfer_data` TransferData - `amount` integer — The amount transferred to the destination account. This transfer will occur automatically after the payment succeeds. If no amount is specified, by default the entire payment amount is transferred to the destination account. The amount must be less than or equal to the [amount](https://docs.stripe.com/api/payment_intents/object#payment_intent_object-amount), and must be a positive integer representing how much to transfer in the smallest currency unit (e.g., 100 cents to charge $1.00). - `description` string — An arbitrary string attached to the transfer. Often useful for displaying to users. - `destination` union, required — The account (if any) that the payment is attributed to for tax reporting, and where funds from the payment are transferred to after payment success. - … - `metadata` object — Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. - `payment_data` PaymentData - … - `transfer_group` string, nullable — A string that identifies the resulting payment as part of a group. Learn more about the [use case for connected accounts](https://docs.stripe.com/connect/separate-charges-and-transfers). - `payment_link` union — The ID of the Payment Link that created this Session. - string - PaymentLink — A payment link is a shareable URL that will take your customers to a hosted payment page. A payment link can be shared and used multiple times. When a customer opens a payment link it will open a new [checkout session](https://docs.stripe.com/api/checkout/sessions) to render the payment page. You can use [checkout session events](https://docs.stripe.com/api/events/types#event_types-checkout.session.completed) to track payments through payment links. Related guide: [Payment Links API](https://docs.stripe.com/payment-links) - `active` boolean, required — Whether the payment link's `url` is active. If `false`, customers visiting the URL will be shown a page saying that the link has been deactivated. - `after_completion` PaymentLinksResourceAfterCompletion, required - `hosted_confirmation` PaymentLinksResourceCompletionBehaviorConfirmationPage - … - `redirect` PaymentLinksResourceCompletionBehaviorRedirect - … - `type` 'hosted_confirmation' | 'redirect', required — The specified behavior after the purchase is complete. - `allow_promotion_codes` boolean, required — Whether user redeemable promotion codes are enabled. - `application` union — The ID of the Connect application that created the Payment Link. - string - Application - … - DeletedApplication - … - `application_fee_amount` integer, nullable — 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. - `application_fee_percent` number, nullable — This represents the percentage of the subscription invoice total that will be transferred to the application owner's Stripe account. - `automatic_tax` PaymentLinksResourceAutomaticTax, required - `enabled` boolean, required — If `true`, tax will be calculated automatically using the customer's location. - `liability` ConnectAccountReference - … - `billing_address_collection` 'auto' | 'required', required — Configuration for collecting the customer's billing address. Defaults to `auto`. - `consent_collection` PaymentLinksResourceConsentCollection - `payment_method_reuse_agreement` PaymentLinksResourcePaymentMethodReuseAgreement - … - `promotions` 'auto' | 'none', nullable — If set to `auto`, enables the collection of customer consent for promotional communications. - `terms_of_service` 'none' | 'required', nullable — If set to `required`, it requires cutomers to accept the terms of service before being able to pay. If set to `none`, customers won't be shown a checkbox to accept the terms of service. - `currency` string, currency, required — 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). - `custom_fields` PaymentLinksResourceCustomFields[], required — Collect additional information from your customer using custom fields. Up to 3 fields are supported. You can't set this parameter if `ui_mode` is `custom`. - `dropdown` PaymentLinksResourceCustomFieldsDropdown - … - `key` string, required — 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. - `label` PaymentLinksResourceCustomFieldsLabel, required - … - `numeric` PaymentLinksResourceCustomFieldsNumeric - … - `optional` boolean, required — Whether the customer is required to complete the field before completing the Checkout Session. Defaults to `false`. - `text` PaymentLinksResourceCustomFieldsText - … - `type` 'dropdown' | 'numeric' | 'text', required — The type of the field. - `custom_text` PaymentLinksResourceCustomText, required - `after_submit` PaymentLinksResourceCustomTextPosition - … - `shipping_address` PaymentLinksResourceCustomTextPosition - … - `submit` PaymentLinksResourceCustomTextPosition - … - `terms_of_service_acceptance` PaymentLinksResourceCustomTextPosition - … - `customer_creation` 'always' | 'if_required', required — Configuration for Customer creation during checkout. - `id` string, required — Unique identifier for the object. - `inactive_message` string, nullable — The custom message to be displayed to a customer when a payment link is no longer active. - `invoice_creation` PaymentLinksResourceInvoiceCreation - `enabled` boolean, required — Enable creating an invoice on successful payment. - `invoice_data` PaymentLinksResourceInvoiceSettings - … - `line_items` object — The line items representing what is being sold. - `data` Item[], required — Details about each object. - … - `has_more` boolean, required — True if this list has another page of items after this one that can be fetched. - `object` 'list', required — String representing the object's type. Objects of the same type share the same value. Always has the value `list`. - `url` string, required — The URL where this list can be accessed. - `livemode` boolean, required — If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`. - `managed_payments` PaymentPagesCheckoutSessionManagedPayments - `enabled` boolean, required — Set to `true` to enable [Managed Payments](https://docs.stripe.com/payments/managed-payments), Stripe's merchant of record solution, for this session. - `metadata` object, required — Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. - `name_collection` PaymentLinksResourceNameCollection - `business` PaymentLinksResourceBusinessName - … - `individual` PaymentLinksResourceIndividualName - … - `object` 'payment_link', required — String representing the object's type. Objects of the same type share the same value. - `on_behalf_of` union — The account on behalf of which to charge. See the [Connect documentation](https://support.stripe.com/questions/sending-invoices-on-behalf-of-connected-accounts) for details. - string - Account — For new integrations, we recommend using the [Accounts v2 API](/api/v2/core/accounts), in place of /v1/accounts and /v1/customers to represent a user. This is an object representing a Stripe account. You can retrieve it to see properties on the account like its current requirements or if the account is enabled to make live charges or receive payouts. For accounts where [controller.requirement_collection](/api/accounts/object#account_object-controller-requirement_collection) is `application`, which includes Custom accounts, the properties below are always returned. For accounts where [controller.requirement_collection](/api/accounts/object#account_object-controller-requirement_collection) is `stripe`, which includes Standard and Express accounts, some properties are only returned until you create an [Account Link](/api/account_links) or [Account Session](/api/account_sessions) to start Connect Onboarding. Learn about the [differences between accounts](/connect/accounts). - … - `optional_items` PaymentLinksResourceOptionalItem[], nullable — The optional items presented to the customer at checkout. - `adjustable_quantity` PaymentLinksResourceOptionalItemAdjustableQuantity - … - `price` string, required - `quantity` integer, required - `payment_intent_data` PaymentLinksResourcePaymentIntentData - `capture_method` 'automatic' | 'automatic_async' | 'manual', nullable — Indicates when the funds will be captured from the customer's account. - `description` string, nullable — An arbitrary string attached to the object. Often useful for displaying to users. - `metadata` object, required — Set of [key-value pairs](https://docs.stripe.com/api/metadata) that will set metadata on [Payment Intents](https://docs.stripe.com/api/payment_intents) generated from this payment link. - `setup_future_usage` 'off_session' | 'on_session', nullable — Indicates that you intend to make future payments with the payment method collected during checkout. - `statement_descriptor` string, nullable — For a non-card payment, information about the charge that appears on the customer's statement when this payment succeeds in creating a charge. - `statement_descriptor_suffix` string, nullable — For a card payment, information about the charge that appears on the customer's statement when this payment succeeds in creating a charge. Concatenated with the account's statement descriptor prefix to form the complete statement descriptor. - `transfer_group` string, nullable — A string that identifies the resulting payment as part of a group. See the PaymentIntents [use case for connected accounts](https://docs.stripe.com/connect/separate-charges-and-transfers) for details. - `payment_method_collection` 'always' | 'if_required', required — Configuration for collecting a payment method during checkout. Defaults to `always`. - `payment_method_options` PaymentLinksResourcePaymentMethodOptions - `card` PaymentLinksResourceCardPaymentMethodOptions - … - `payment_method_types` string[], nullable — The list of payment method types that customers can use. When `null`, Stripe will dynamically show relevant payment methods you've enabled in your [payment method settings](https://dashboard.stripe.com/settings/payment_methods). - `phone_number_collection` PaymentLinksResourcePhoneNumberCollection, required - `enabled` boolean, required — If `true`, a phone number will be collected during checkout. - `restrictions` PaymentLinksResourceRestrictions - `completed_sessions` PaymentLinksResourceCompletedSessions, required - … - `shipping_address_collection` PaymentLinksResourceShippingAddressCollection - `allowed_countries` string[], required — An array of two-letter ISO country codes representing which countries Checkout should provide as options for shipping locations. Unsupported country codes: `AS, CX, CC, CU, HM, IR, KP, MH, FM, NF, MP, PW, SD, SY, UM, VI`. - `shipping_options` PaymentLinksResourceShippingOption[], required — The shipping rate options applied to the session. - `shipping_amount` integer, required — A non-negative integer in cents representing how much to charge. - `shipping_rate` union, required — The ID of the Shipping Rate to use for this shipping option. - … - `submit_type` 'auto' | 'book' | 'donate' | 'pay' | 'subscribe', required — Indicates the type of transaction being performed which customizes relevant text on the page, such as the submit button. - `subscription_data` PaymentLinksResourceSubscriptionData - `description` string, nullable — The subscription's description, meant to be displayable to the customer. Use this field to optionally store an explanation of the subscription for rendering in Stripe surfaces and certain local payment methods UIs. - `invoice_settings` PaymentLinksResourceSubscriptionDataInvoiceSettings, required - … - `metadata` object, required — Set of [key-value pairs](https://docs.stripe.com/api/metadata) that will set metadata on [Subscriptions](https://docs.stripe.com/api/subscriptions) generated from this payment link. - `trial_period_days` integer, nullable — Integer representing the number of trial period days before the customer is charged for the first time. - `trial_settings` SubscriptionsTrialsResourceTrialSettings — Configures how this subscription behaves during the trial period. - … - `tax_id_collection` PaymentLinksResourceTaxIdCollection, required - `enabled` boolean, required — Indicates whether tax ID collection is enabled for the session. - `required` 'if_supported' | 'never', required - `transfer_data` PaymentLinksResourceTransferData - `amount` integer, nullable — The amount in cents (or local equivalent) that will be transferred to the destination account. By default, the entire amount is transferred to the destination. - `destination` union, required — The connected account receiving the transfer. - … - `url` string, required — The public URL that can be shared with customers. - `payment_method_collection` 'always' | 'if_required', nullable — Configure whether a Checkout Session should collect a payment method. Defaults to `always`. - `payment_method_configuration_details` PaymentMethodConfigBizPaymentMethodConfigurationDetails - `id` string, required — ID of the payment method configuration used. - `parent` string, nullable — ID of the parent payment method configuration used. - `payment_method_options` CheckoutSessionPaymentMethodOptions - `acss_debit` CheckoutAcssDebitPaymentMethodOptions - `currency` 'cad' | 'usd' — Currency supported by the bank account. Returned when the Session is in `setup` mode. - `mandate_options` CheckoutAcssDebitMandateOptions - `custom_mandate_url` string — A URL for custom mandate text - `default_for` string[] — List of Stripe products where this mandate can be selected automatically. Returned when the Session is in `setup` mode. - `interval_description` string, nullable — Description of the interval. Only required if the 'payment_schedule' parameter is 'interval' or 'combined'. - `payment_schedule` 'combined' | 'interval' | 'sporadic', nullable — Payment schedule for the mandate. - `transaction_type` 'business' | 'personal', nullable — Transaction type of the mandate. - `setup_future_usage` 'none' | 'off_session' | 'on_session' — 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](/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](/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](/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](/strong-customer-authentication). - `target_date` string — 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. - `verification_method` 'automatic' | 'instant' | 'microdeposits' — Bank account verification method. The default value is `automatic`. - `affirm` CheckoutAffirmPaymentMethodOptions - `capture_method` 'manual' — Controls when the funds will be captured from the customer's account. - `setup_future_usage` 'none' — 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](/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](/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](/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](/strong-customer-authentication). - `afterpay_clearpay` CheckoutAfterpayClearpayPaymentMethodOptions - `capture_method` 'manual' — Controls when the funds will be captured from the customer's account. - `setup_future_usage` 'none' — 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](/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](/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](/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](/strong-customer-authentication). - `alipay` CheckoutAlipayPaymentMethodOptions - `setup_future_usage` 'none' — 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](/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](/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](/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](/strong-customer-authentication). - `alma` CheckoutAlmaPaymentMethodOptions - `capture_method` 'manual' — Controls when the funds will be captured from the customer's account. - `amazon_pay` CheckoutAmazonPayPaymentMethodOptions - `capture_method` 'manual' — Controls when the funds will be captured from the customer's account. - `setup_future_usage` 'none' | 'off_session' — 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](/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](/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](/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](/strong-customer-authentication). - `au_becs_debit` CheckoutAuBecsDebitPaymentMethodOptions - `setup_future_usage` 'none' — 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](/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](/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](/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](/strong-customer-authentication). - `target_date` string — 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. - `bacs_debit` CheckoutBacsDebitPaymentMethodOptions - `mandate_options` CheckoutPaymentMethodOptionsMandateOptionsBacsDebit - `reference_prefix` string — Prefix used to generate the Mandate reference. Must be at most 12 characters long. Must consist of only uppercase letters, numbers, spaces, or the following special characters: '/', '_', '-', '&', '.'. Cannot begin with 'DDIC' or 'STRIPE'. - `setup_future_usage` 'none' | 'off_session' | 'on_session' — 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](/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](/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](/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](/strong-customer-authentication). - `target_date` string — 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. - `bancontact` CheckoutBancontactPaymentMethodOptions - `setup_future_usage` 'none' — 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](/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](/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](/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](/strong-customer-authentication). - `billie` CheckoutBilliePaymentMethodOptions - `capture_method` 'manual' — Controls when the funds will be captured from the customer's account. - `boleto` CheckoutBoletoPaymentMethodOptions - `expires_after_days` integer, required — The number of calendar days before a Boleto voucher expires. For example, if you create a Boleto voucher on Monday and you set expires_after_days to 2, the Boleto voucher will expire on Wednesday at 23:59 America/Sao_Paulo time. - `setup_future_usage` 'none' | 'off_session' | 'on_session' — 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](/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](/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](/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](/strong-customer-authentication). - `card` CheckoutCardPaymentMethodOptions - `capture_method` 'manual' — Controls when the funds will be captured from the customer's account. - `installments` CheckoutCardInstallmentsOptions - `enabled` boolean — Indicates if installments are enabled - `request_extended_authorization` 'if_available' | 'never' — Request ability to [capture beyond the standard authorization validity window](/payments/extended-authorization) for this CheckoutSession. - `request_incremental_authorization` 'if_available' | 'never' — Request ability to [increment the authorization](/payments/incremental-authorization) for this CheckoutSession. - `request_multicapture` 'if_available' | 'never' — Request ability to make [multiple captures](/payments/multicapture) for this CheckoutSession. - `request_overcapture` 'if_available' | 'never' — Request ability to [overcapture](/payments/overcapture) for this CheckoutSession. - `request_three_d_secure` 'any' | 'automatic' | 'challenge', required — We strongly recommend that you rely on our SCA Engine to automatically prompt your customers for authentication based on risk level and [other requirements](https://docs.stripe.com/strong-customer-authentication). However, if you wish to request 3D Secure based on logic from your own fraud engine, provide this option. If not provided, this value defaults to `automatic`. Read our guide on [manually requesting 3D Secure](https://docs.stripe.com/payments/3d-secure/authentication-flow#manual-three-ds) for more information on how this configuration interacts with Radar and our SCA Engine. - `restrictions` PaymentPagesPrivateCardPaymentMethodOptionsResourceRestrictions - `brands_blocked` string[] — The card brands to block. If a customer enters or selects a card belonging to a blocked brand, they can't complete the payment. - `setup_future_usage` 'none' | 'off_session' | 'on_session' — 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](/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](/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](/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](/strong-customer-authentication). - `statement_descriptor_suffix_kana` string — Provides information about a card payment that customers see on their statements. Concatenated with the Kana prefix (shortened Kana descriptor) or Kana statement descriptor that’s set on the account to form the complete statement descriptor. Maximum 22 characters. On card statements, the *concatenation* of both prefix and suffix (including separators) will appear truncated to 22 characters. - `statement_descriptor_suffix_kanji` string — Provides information about a card payment that customers see on their statements. Concatenated with the Kanji prefix (shortened Kanji descriptor) or Kanji statement descriptor that’s set on the account to form the complete statement descriptor. Maximum 17 characters. On card statements, the *concatenation* of both prefix and suffix (including separators) will appear truncated to 17 characters. - `cashapp` CheckoutCashappPaymentMethodOptions - `capture_method` 'manual' — Controls when the funds will be captured from the customer's account. - `setup_future_usage` 'none' — 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](/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](/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](/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](/strong-customer-authentication). - `customer_balance` CheckoutCustomerBalancePaymentMethodOptions - `bank_transfer` CheckoutCustomerBalanceBankTransferPaymentMethodOptions - `eu_bank_transfer` PaymentMethodOptionsCustomerBalanceEuBankAccount - … - `requested_address_types` string[] — List of address types that should be returned in the financial_addresses response. If not specified, all valid types will be returned. Permitted values include: `sort_code`, `zengin`, `iban`, or `spei`. - `type` 'eu_bank_transfer' | 'gb_bank_transfer' | 'jp_bank_transfer' | 'mx_bank_transfer' | 'us_bank_transfer', nullable — The bank transfer type that this PaymentIntent is allowed to use for funding Permitted values include: `eu_bank_transfer`, `gb_bank_transfer`, `jp_bank_transfer`, `mx_bank_transfer`, or `us_bank_transfer`. - `funding_type` 'bank_transfer', nullable — The funding method type to be used when there are not enough funds in the customer balance. Permitted values include: `bank_transfer`. - `setup_future_usage` 'none' — 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](/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](/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](/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](/strong-customer-authentication). - `eps` CheckoutEpsPaymentMethodOptions - `setup_future_usage` 'none' — 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](/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](/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](/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](/strong-customer-authentication). - `fpx` CheckoutFpxPaymentMethodOptions - `setup_future_usage` 'none' — 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](/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](/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](/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](/strong-customer-authentication). - `giropay` CheckoutGiropayPaymentMethodOptions - `setup_future_usage` 'none' — 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](/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](/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](/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](/strong-customer-authentication). - `grabpay` CheckoutGrabPayPaymentMethodOptions - `setup_future_usage` 'none' — 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](/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](/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](/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](/strong-customer-authentication). - `ideal` CheckoutIdealPaymentMethodOptions - `setup_future_usage` 'none' — 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](/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](/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](/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](/strong-customer-authentication). - `kakao_pay` CheckoutKakaoPayPaymentMethodOptions - `capture_method` 'manual' — Controls when the funds will be captured from the customer's account. - `setup_future_usage` 'none' | 'off_session' — 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](/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](/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](/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](/strong-customer-authentication). - `klarna` CheckoutKlarnaPaymentMethodOptions - `capture_method` 'manual' — Controls when the funds will be captured from the customer's account. - `setup_future_usage` 'none' | 'off_session' | 'on_session' — 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](/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](/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](/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](/strong-customer-authentication). - `konbini` CheckoutKonbiniPaymentMethodOptions - `expires_after_days` integer, nullable — The number of calendar days (between 1 and 60) after which Konbini payment instructions will expire. For example, if a PaymentIntent is confirmed with Konbini and `expires_after_days` set to 2 on Monday JST, the instructions will expire on Wednesday 23:59:59 JST. - `setup_future_usage` 'none' — 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](/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](/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](/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](/strong-customer-authentication). - `kr_card` CheckoutKrCardPaymentMethodOptions - `capture_method` 'manual' — Controls when the funds will be captured from the customer's account. - `setup_future_usage` 'none' | 'off_session' — 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](/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](/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](/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](/strong-customer-authentication). - `link` CheckoutLinkPaymentMethodOptions - `capture_method` 'manual' — Controls when the funds will be captured from the customer's account. - `setup_future_usage` 'none' | 'off_session' — 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](/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](/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](/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](/strong-customer-authentication). - `mobilepay` CheckoutMobilepayPaymentMethodOptions - `capture_method` 'manual' — Controls when the funds will be captured from the customer's account. - `setup_future_usage` 'none' — 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](/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](/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](/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](/strong-customer-authentication). - `multibanco` CheckoutMultibancoPaymentMethodOptions - `setup_future_usage` 'none' — 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](/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](/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](/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](/strong-customer-authentication). - `naver_pay` CheckoutNaverPayPaymentMethodOptions - `capture_method` 'manual' — Controls when the funds will be captured from the customer's account. - `setup_future_usage` 'none' | 'off_session' — 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](/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](/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](/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](/strong-customer-authentication). - `oxxo` CheckoutOxxoPaymentMethodOptions - `expires_after_days` integer, required — The number of calendar days before an OXXO invoice expires. For example, if you create an OXXO invoice on Monday and you set expires_after_days to 2, the OXXO invoice will expire on Wednesday at 23:59 America/Mexico_City time. - `setup_future_usage` 'none' — 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](/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](/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](/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](/strong-customer-authentication). - `p24` CheckoutP24PaymentMethodOptions - `setup_future_usage` 'none' — 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](/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](/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](/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](/strong-customer-authentication). - `payco` CheckoutPaycoPaymentMethodOptions - `capture_method` 'manual' — Controls when the funds will be captured from the customer's account. - `setup_future_usage` 'none' — 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](/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](/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](/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](/strong-customer-authentication). - `paynow` CheckoutPaynowPaymentMethodOptions - `setup_future_usage` 'none' — 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](/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](/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](/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](/strong-customer-authentication). - `paypal` CheckoutPaypalPaymentMethodOptions - `capture_method` 'manual' — Controls when the funds will be captured from the customer's account. - `preferred_locale` string, nullable — Preferred locale of the PayPal checkout page that the customer is redirected to. - `reference` string, nullable — A reference of the PayPal transaction visible to customer which is mapped to PayPal's invoice ID. This must be a globally unique ID if you have configured in your PayPal settings to block multiple payments per invoice ID. - `setup_future_usage` 'none' | 'off_session' — 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](/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](/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](/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](/strong-customer-authentication). - `payto` CheckoutPaytoPaymentMethodOptions - `mandate_options` MandateOptionsPayto - `amount` integer, nullable — Amount that will be collected. It is required when `amount_type` is `fixed`. - `amount_type` 'fixed' | 'maximum', nullable — The type of amount that will be collected. The amount charged must be exact or up to the value of `amount` param for `fixed` or `maximum` type respectively. Defaults to `maximum`. - `end_date` string, nullable — Date, in YYYY-MM-DD format, after which payments will not be collected. Defaults to no end date. - `payment_schedule` 'adhoc' | 'annual' | 'daily' | 'fortnightly' | 'monthly' | 'quarterly' | 'semi_annual' | 'weekly', nullable — The periodicity at which payments will be collected. Defaults to `adhoc`. - `payments_per_period` integer, nullable — The number of payments that will be made during a payment period. Defaults to 1 except for when `payment_schedule` is `adhoc`. In that case, it defaults to no limit. - `purpose` 'dependant_support' | 'government' | 'loan' | 'mortgage' | 'other' | 'pension' | 'personal' | 'retail' | 'salary' | 'tax' | 'utility', nullable — The purpose for which payments are made. Has a default value based on your merchant category code. - `start_date` string, nullable — Date, in YYYY-MM-DD format, from which payments will be collected. Defaults to confirmation time. - `setup_future_usage` 'none' | 'off_session' — 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](/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](/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](/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](/strong-customer-authentication). - `pix` CheckoutPixPaymentMethodOptions - `amount_includes_iof` 'always' | 'never' — Determines if the amount includes the IOF tax. - `expires_after_seconds` integer, nullable — The number of seconds after which Pix payment will expire. - `mandate_options` PaymentMethodOptionsMandateOptionsPix - `amount` integer — Amount to be charged for future payments. - `amount_includes_iof` 'always' | 'never' — Determines if the amount includes the IOF tax. - `amount_type` 'fixed' | 'maximum' — Type of amount. - `currency` string, currency — Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. - `end_date` string — Date when the mandate expires and no further payments will be charged, in `YYYY-MM-DD`. - `payment_schedule` 'halfyearly' | 'monthly' | 'quarterly' | 'weekly' | 'yearly' — Schedule at which the future payments will be charged. - `reference` string — Subscription name displayed to buyers in their bank app. - `start_date` string — Start date of the mandate, in `YYYY-MM-DD`. - `setup_future_usage` 'none' | 'off_session' — 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](/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](/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](/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](/strong-customer-authentication). - `revolut_pay` CheckoutRevolutPayPaymentMethodOptions - `capture_method` 'manual' — Controls when the funds will be captured from the customer's account. - `setup_future_usage` 'none' | 'off_session' — 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](/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](/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](/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](/strong-customer-authentication). - `samsung_pay` CheckoutSamsungPayPaymentMethodOptions - `capture_method` 'manual' — Controls when the funds will be captured from the customer's account. - `setup_future_usage` 'none' — 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](/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](/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](/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](/strong-customer-authentication). - `satispay` CheckoutSatispayPaymentMethodOptions - `capture_method` 'manual' — Controls when the funds will be captured from the customer's account. - `scalapay` CheckoutScalapayPaymentMethodOptions - `capture_method` 'manual' — Controls when the funds will be captured from the customer's account. - `sepa_debit` CheckoutSepaDebitPaymentMethodOptions - `mandate_options` CheckoutPaymentMethodOptionsMandateOptionsSepaDebit - `reference_prefix` string — Prefix used to generate the Mandate reference. Must be at most 12 characters long. Must consist of only uppercase letters, numbers, spaces, or the following special characters: '/', '_', '-', '&', '.'. Cannot begin with 'STRIPE'. - `setup_future_usage` 'none' | 'off_session' | 'on_session' — 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](/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](/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](/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](/strong-customer-authentication). - `target_date` string — 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. - `sofort` CheckoutSofortPaymentMethodOptions - `setup_future_usage` 'none' — 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](/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](/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](/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](/strong-customer-authentication). - `sunbit` CheckoutSunbitPaymentMethodOptions - `capture_method` 'manual' — Controls when the funds will be captured from the customer's account. - `setup_future_usage` 'none' — 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](/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](/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](/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](/strong-customer-authentication). - `swish` CheckoutSwishPaymentMethodOptions - `reference` string, nullable — The order reference that will be displayed to customers in the Swish application. Defaults to the `id` of the Payment Intent. - `twint` CheckoutTwintPaymentMethodOptions - `setup_future_usage` 'none' | 'off_session' — 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](/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](/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](/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](/strong-customer-authentication). - `upi` CheckoutUpiPaymentMethodOptions - `mandate_options` MandateOptionsUpi - `amount` integer, nullable — Amount to be charged for future payments. - `amount_type` 'fixed' | 'maximum', nullable — One of `fixed` or `maximum`. If `fixed`, the `amount` param refers to the exact amount to be charged in future payments. If `maximum`, the amount charged can be up to the value passed for the `amount` param. - `description` string, nullable — A description of the mandate or subscription that is meant to be displayed to the customer. - `end_date` integer, nullable — End date of the mandate or subscription. - `setup_future_usage` 'none' | 'off_session' | 'on_session' — 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](/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](/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](/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](/strong-customer-authentication). - `us_bank_account` CheckoutUsBankAccountPaymentMethodOptions - `financial_connections` LinkedAccountOptionsCommon - `filters` PaymentFlowsPrivatePaymentMethodsFinancialConnectionsCommonLinkedAccountOptionsFilters - … - `permissions` string[] — The list of permissions to request. The `payment_method` permission must be included. - `prefetch` string[], nullable — Data features requested to be retrieved upon account creation. - `return_url` string — For webview integrations only. Upon completing OAuth login in the native browser, the user will be redirected to this URL to return to your app. - `setup_future_usage` 'none' | 'off_session' | 'on_session' — 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](/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](/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](/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](/strong-customer-authentication). - `target_date` string — 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. - `verification_method` 'automatic' | 'instant' — Bank account verification method. The default value is `automatic`. - `wechat_pay` CheckoutWechatPayPaymentMethodOptions - `app_id` string, nullable — The app ID registered with WeChat Pay. Only required when client is iOS or Android. - `client` 'android' | 'ios' | 'web', nullable — The client type that the end customer will pay from - `setup_future_usage` 'none' — 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](/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](/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](/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](/strong-customer-authentication). - `payment_method_types` string[], required — A list of the types of payment methods (e.g. card) this Checkout Session is allowed to accept. - `payment_status` 'no_payment_required' | 'paid' | 'unpaid', required — 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. - `permissions` PaymentPagesCheckoutSessionPermissions - `update_shipping_details` 'client_only' | 'server_only', nullable — Determines which entity is allowed to update the shipping details. Default is `client_only`. Stripe Checkout client will automatically update the shipping details. If set to `server_only`, only your server is allowed to update the shipping details. When set to `server_only`, you must add the onShippingDetailsChange event handler when initializing the Stripe Checkout client and manually update the shipping details from your server using the Stripe API. - `phone_number_collection` PaymentPagesCheckoutSessionPhoneNumberCollection - `enabled` boolean, required — Indicates whether phone number collection is enabled for the session - `presentment_details` PaymentFlowsPaymentIntentPresentmentDetails - `presentment_amount` integer, required — Amount intended to be collected by this payment, denominated in `presentment_currency`. - `presentment_currency` string, required — Currency presented to the customer during payment. - `recovered_from` string, nullable — The ID of the original expired Checkout Session that triggered the recovery flow. - `redirect_on_completion` 'always' | 'if_required' | 'never' — This parameter applies to `ui_mode: embedded_page`. Learn more about the [redirect behavior](https://docs.stripe.com/payments/checkout/custom-success-page?payment-ui=embedded-form) of embedded sessions. Defaults to `always`. - `return_url` string — Applies to Checkout Sessions with `ui_mode: embedded_page` or `ui_mode: elements`. The URL to redirect your customer back to after they authenticate or cancel their payment on the payment method's app or site. - `saved_payment_method_options` PaymentPagesCheckoutSessionSavedPaymentMethodOptions - `allow_redisplay_filters` string[], nullable — Uses the `allow_redisplay` value of each saved payment method to filter the set presented to a returning customer. By default, only saved payment methods with ’allow_redisplay: ‘always’ are shown in Checkout. - `payment_method_remove` 'disabled' | 'enabled', nullable — Enable customers to choose if they wish to remove their saved payment methods. Disabled by default. - `payment_method_save` 'disabled' | 'enabled', nullable — Enable customers to choose if they wish to save their payment method for future use. Disabled by default. - `setup_intent` union — 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://docs.stripe.com/api/checkout/sessions/expire) instead. - string - SetupIntent — A SetupIntent guides you through the process of setting up and saving a customer's payment credentials for future payments. For example, you can use a SetupIntent to set up and save your customer's card without immediately collecting a payment. Later, you can use [PaymentIntents](https://api.stripe.com#payment_intents) to drive the payment flow. Create a SetupIntent when you're ready to collect your customer's payment credentials. Don't maintain long-lived, unconfirmed SetupIntents because they might not be valid. The SetupIntent transitions through multiple [statuses](https://docs.stripe.com/payments/intents#intent-statuses) as it guides you through the setup process. Successful SetupIntents result in payment credentials that are optimized for future payments. For example, cardholders in [certain regions](https://stripe.com/guides/strong-customer-authentication) might need to be run through [Strong Customer Authentication](https://docs.stripe.com/strong-customer-authentication) during payment method collection to streamline later [off-session payments](https://docs.stripe.com/payments/setup-intents). If you use the SetupIntent with a [Customer](https://api.stripe.com#setup_intent_object-customer), it automatically attaches the resulting payment method to that Customer after successful setup. We recommend using SetupIntents or [setup_future_usage](https://api.stripe.com#payment_intent_object-setup_future_usage) on PaymentIntents to save payment methods to prevent saving invalid or unoptimized payment methods. By using SetupIntents, you can reduce friction for your customers, even as regulations change over time. Related guide: [Setup Intents API](https://docs.stripe.com/payments/setup-intents) - `allowed_payment_method_types` string[], nullable — The list of payment method types to allow for this SetupIntent. Stripe will only use methods in this list when determining the payment methods to offer. - `application` union — ID of the Connect application that created the SetupIntent. - string - Application - … - `attach_to_self` boolean — If present, the SetupIntent's payment method will be attached to the in-context Stripe Account. It can only be used for this Stripe Account’s own money movement flows like InboundTransfer and OutboundTransfers. It cannot be set to true when setting up a PaymentMethod for a Customer, and defaults to false when attaching a PaymentMethod to a Customer. - `automatic_payment_methods` PaymentFlowsAutomaticPaymentMethodsSetupIntent - `allow_redirects` 'always' | 'never' — Controls whether this SetupIntent will accept redirect-based payment methods. Redirect-based payment methods may require your customer to be redirected to a payment method's app or site for authentication or additional steps. To [confirm](https://docs.stripe.com/api/setup_intents/confirm) this SetupIntent, you may be required to provide a `return_url` to redirect customers back to your site after they authenticate or complete the setup. - `enabled` boolean, nullable — Automatically calculates compatible payment methods - `cancellation_reason` 'abandoned' | 'duplicate' | 'requested_by_customer', nullable — Reason for cancellation of this SetupIntent, one of `abandoned`, `requested_by_customer`, or `duplicate`. - `client_secret` string, nullable — The client secret of this SetupIntent. Used for client-side retrieval using a publishable key. The client secret can be used to complete payment setup from your frontend. It should not be stored, logged, or exposed to anyone other than the customer. Make sure that you have TLS enabled on any page that includes the client secret. - `created` integer, required — Time at which the object was created. Measured in seconds since the Unix epoch. - `customer` union — ID of the Customer this SetupIntent belongs to, if one exists. If present, the SetupIntent's payment method will be attached to the Customer on successful setup. Payment methods attached to other Customers cannot be used with this SetupIntent. - string - Customer — This object represents a customer of your business. Use it to [create recurring charges](https://docs.stripe.com/invoicing/customer), [save payment](https://docs.stripe.com/payments/save-during-payment) and contact information, and track payments that belong to the same customer. - … - DeletedCustomer - … - `customer_account` string, nullable — ID of the Account this SetupIntent belongs to, if one exists. If present, the SetupIntent's payment method will be attached to the Account on successful setup. Payment methods attached to other Accounts cannot be used with this SetupIntent. - `description` string, nullable — An arbitrary string attached to the object. Often useful for displaying to users. - `excluded_payment_method_types` string[], nullable — Payment method types that are excluded from this SetupIntent. - `flow_directions` string[], nullable — Indicates the directions of money movement for which this payment method is intended to be used. Include `inbound` if you intend to use the payment method as the origin to pull funds from. Include `outbound` if you intend to use the payment method as the destination to send funds to. You can include both if you intend to use the payment method for both purposes. - `id` string, required — Unique identifier for the object. - `last_setup_error` ApiErrors - `advice_code` string — For card errors resulting from a card issuer decline, a short string indicating [how to proceed with an error](https://docs.stripe.com/declines#retrying-issuer-declines) if they provide one. - `charge` string — For card errors, the ID of the failed charge. - `code` string — For some errors that could be handled programmatically, a short string indicating the [error code](https://docs.stripe.com/error-codes) reported. - `decline_code` string — For card errors resulting from a card issuer decline, a short string indicating the [card issuer's reason for the decline](https://docs.stripe.com/declines#issuer-declines) if they provide one. - `doc_url` string — A URL to more information about the [error code](https://docs.stripe.com/error-codes) reported. - `message` string — A human-readable message providing more details about the error. For card errors, these messages can be shown to your users. - `network_advice_code` string — For card errors resulting from a card issuer decline, a 2 digit code which indicates the advice given to merchant by the card network on how to proceed with an error. - `network_decline_code` string — For payments declined by the network, an alphanumeric code which indicates the reason the payment failed. - `param` string — If the error is parameter-specific, the parameter related to the error. For example, you can use this to display a message near the correct form field. - `payment_intent` PaymentIntent — A PaymentIntent guides you through the process of collecting a payment from your customer. We recommend that you create exactly one PaymentIntent for each order or customer session in your system. You can reference the PaymentIntent later to see the history of payment attempts for a particular session. A PaymentIntent transitions through [multiple statuses](/payments/paymentintents/lifecycle) throughout its lifetime as it interfaces with Stripe.js to perform authentication flows and ultimately creates at most one successful charge. Related guide: [Payment Intents API](https://docs.stripe.com/payments/payment-intents) - … - `payment_method` PaymentMethod — PaymentMethod objects represent your customer's payment instruments. You can use them with [PaymentIntents](https://docs.stripe.com/payments/payment-intents) to collect payments or save them to Customer objects to store instrument details for future payments. Related guides: [Payment Methods](https://docs.stripe.com/payments/payment-methods) and [More Payment Scenarios](https://docs.stripe.com/payments/more-payment-scenarios). - … - `payment_method_type` string — If the error is specific to the type of payment method, the payment method type that had a problem. This field is only populated for invoice-related errors. - `request_log_url` string — A URL to the request log entry in your dashboard. - `setup_intent` SetupIntent — recursive - `source` union — The [source object](https://docs.stripe.com/api/sources/object) for errors returned on a request involving a source. - … - `type` 'api_error' | 'card_error' | 'idempotency_error' | 'invalid_request_error', required — The type of error returned. One of `api_error`, `card_error`, `idempotency_error`, or `invalid_request_error` - `latest_attempt` union — The most recent SetupAttempt for this SetupIntent. - string - SetupAttempt — A SetupAttempt describes one attempted confirmation of a SetupIntent, whether that confirmation is successful or unsuccessful. You can use SetupAttempts to inspect details of a specific attempt at setting up a payment method using a SetupIntent. - … - `livemode` boolean, required — If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`. - `managed_payments` SmorResourceManagedPayments - `enabled` boolean, required — Set to `true` to enable [Managed Payments](https://docs.stripe.com/payments/managed-payments), Stripe's merchant of record solution, for this session. - `mandate` union — ID of the multi use Mandate generated by the SetupIntent. - string - Mandate — A Mandate is a record of the permission that your customer gives you to debit their payment method. - … - `metadata` object, nullable — Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. - `next_action` SetupIntentNextAction - `blik_authorize` PaymentIntentNextActionBlikAuthorize - `cashapp_handle_redirect_or_display_qr_code` PaymentIntentNextActionCashappHandleRedirectOrDisplayQrCode - … - `pix_display_qr_code` SetupIntentNextActionPixDisplayQrCode - … - `redirect_to_url` SetupIntentNextActionRedirectToUrl - … - `type` string, required — Type of the next action to perform. Refer to the other child attributes under `next_action` for available values. Examples include: `redirect_to_url`, `use_stripe_sdk`, `alipay_handle_redirect`, `oxxo_display_details`, or `verify_with_microdeposits`. - `upi_handle_redirect_or_display_qr_code` PaymentIntentNextActionUpiHandleRedirectOrDisplayQrCode - … - `use_stripe_sdk` object — When confirming a SetupIntent with Stripe.js, Stripe.js depends on the contents of this dictionary to invoke authentication flows. The shape of the contents is subject to change and is only intended to be used by Stripe.js. - `verify_with_microdeposits` SetupIntentNextActionVerifyWithMicrodeposits - … - `object` 'setup_intent', required — String representing the object's type. Objects of the same type share the same value. - `on_behalf_of` union — The account (if any) for which the setup is intended. - string - Account — For new integrations, we recommend using the [Accounts v2 API](/api/v2/core/accounts), in place of /v1/accounts and /v1/customers to represent a user. This is an object representing a Stripe account. You can retrieve it to see properties on the account like its current requirements or if the account is enabled to make live charges or receive payouts. For accounts where [controller.requirement_collection](/api/accounts/object#account_object-controller-requirement_collection) is `application`, which includes Custom accounts, the properties below are always returned. For accounts where [controller.requirement_collection](/api/accounts/object#account_object-controller-requirement_collection) is `stripe`, which includes Standard and Express accounts, some properties are only returned until you create an [Account Link](/api/account_links) or [Account Session](/api/account_sessions) to start Connect Onboarding. Learn about the [differences between accounts](/connect/accounts). - … - `payment_method` union — ID of the payment method used with this SetupIntent. If the payment method is `card_present` and isn't a digital wallet, then the [generated_card](https://docs.stripe.com/api/setup_attempts/object#setup_attempt_object-payment_method_details-card_present-generated_card) associated with the `latest_attempt` is attached to the Customer instead. - string - PaymentMethod — PaymentMethod objects represent your customer's payment instruments. You can use them with [PaymentIntents](https://docs.stripe.com/payments/payment-intents) to collect payments or save them to Customer objects to store instrument details for future payments. Related guides: [Payment Methods](https://docs.stripe.com/payments/payment-methods) and [More Payment Scenarios](https://docs.stripe.com/payments/more-payment-scenarios). - … - `payment_method_configuration_details` PaymentMethodConfigBizPaymentMethodConfigurationDetails - `id` string, required — ID of the payment method configuration used. - `parent` string, nullable — ID of the parent payment method configuration used. - `payment_method_options` SetupIntentPaymentMethodOptions - `acss_debit` union - … - `amazon_pay` union - … - `bacs_debit` union - … - `bizum` union - … - `card` union - … - `card_present` union - … - `klarna` union - … - `link` union - … - `paypal` union - … - `payto` union - … - `pix` union - … - `sepa_debit` union - … - `upi` union - … - `us_bank_account` union - … - `payment_method_types` string[], required — The list of payment method types (e.g. card) that this SetupIntent is allowed to set up. A list of valid payment method types can be found [here](https://docs.stripe.com/api/payment_methods/object#payment_method_object-type). - `single_use_mandate` union — ID of the single_use Mandate generated by the SetupIntent. - string - Mandate — A Mandate is a record of the permission that your customer gives you to debit their payment method. - … - `status` 'canceled' | 'processing' | 'requires_action' | 'requires_confirmation' | 'requires_payment_method' | 'succeeded', required — [Status](https://docs.stripe.com/payments/intents#intent-statuses) of this SetupIntent, one of `requires_payment_method`, `requires_confirmation`, `requires_action`, `processing`, `canceled`, or `succeeded`. - `usage` string, required — Indicates how the payment method is intended to be used in the future. Use `on_session` if you intend to only reuse the payment method when the customer is in your checkout flow. Use `off_session` if your customer may or may not be in your checkout flow. If not provided, this value defaults to `off_session`. - `shipping_address_collection` PaymentPagesCheckoutSessionShippingAddressCollection - `allowed_countries` string[], required — An array of two-letter ISO country codes representing which countries Checkout should provide as options for shipping locations. Unsupported country codes: `AS, CX, CC, CU, HM, IR, KP, MH, FM, NF, MP, PW, SY, UM, VI`. - `shipping_cost` PaymentPagesCheckoutSessionShippingCost - `amount_subtotal` integer, required — Total shipping cost before any discounts or taxes are applied. - `amount_tax` integer, required — Total tax amount applied due to shipping costs. If no tax was applied, defaults to 0. - `amount_total` integer, required — Total shipping cost after discounts and taxes are applied. - `shipping_rate` union — The ID of the ShippingRate for this order. - string - ShippingRate — Shipping rates describe the price of shipping presented to your customers and applied to a purchase. For more information, see [Charge for shipping](https://docs.stripe.com/payments/during-payment/charge-shipping). - `active` boolean, required — Whether the shipping rate can be used for new purchases. Defaults to `true`. - `created` integer, required — Time at which the object was created. Measured in seconds since the Unix epoch. - `delivery_estimate` ShippingRateDeliveryEstimate - … - `display_name` string, nullable — The name of the shipping rate, meant to be displayable to the customer. This will appear on CheckoutSessions. - `fixed_amount` ShippingRateFixedAmount - … - `id` string, required — Unique identifier for the object. - `livemode` boolean, required — If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`. - `metadata` object, required — Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. - `object` 'shipping_rate', required — String representing the object's type. Objects of the same type share the same value. - `tax_behavior` 'exclusive' | 'inclusive' | 'unspecified', nullable — Specifies whether the rate is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. - `tax_code` union — A [tax code](https://docs.stripe.com/tax/tax-categories) ID. The Shipping tax code is `txcd_92010001`. - … - `type` 'fixed_amount', required — The type of calculation to use on the shipping rate. - `taxes` LineItemsTaxAmount[] — The taxes applied to the shipping rate. - `amount` integer, required — Amount of tax applied for this rate. - `rate` TaxRate, required — Tax rates can be applied to [invoices](/invoicing/taxes/tax-rates), [subscriptions](/billing/taxes/tax-rates) and [Checkout Sessions](/payments/checkout/use-manual-tax-rates) to collect tax. Related guide: [Tax rates](/billing/taxes/tax-rates) - `active` boolean, required — Defaults to `true`. When set to `false`, this tax rate cannot be used with new applications or Checkout Sessions, but will still work for subscriptions and invoices that already have it set. - `country` string, nullable — Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)). - `created` integer, required — Time at which the object was created. Measured in seconds since the Unix epoch. - `description` string, nullable — An arbitrary string attached to the tax rate for your internal use only. It will not be visible to your customers. - `display_name` string, required — The display name of the tax rates as it will appear to your customer on their receipt email, PDF, and the hosted invoice page. - `effective_percentage` number, nullable — Actual/effective tax rate percentage out of 100. For tax calculations with automatic_tax[enabled]=true, this percentage reflects the rate actually used to calculate tax based on the product's taxability and whether the user is registered to collect taxes in the corresponding jurisdiction. - `flat_amount` TaxRateFlatAmount — The amount of the tax rate when the `rate_type`` is `flat_amount`. Tax rates with `rate_type` `percentage` can vary based on the transaction, resulting in this field being `null`. This field exposes the amount and currency of the flat tax rate. - … - `id` string, required — Unique identifier for the object. - `inclusive` boolean, required — This specifies if the tax rate is inclusive or exclusive. - `jurisdiction` string, nullable — The jurisdiction for the tax rate. You can use this label field for tax reporting purposes. It also appears on your customer’s invoice. - `jurisdiction_level` 'city' | 'country' | 'county' | 'district' | 'multiple' | 'state', nullable — The level of the jurisdiction that imposes this tax rate. Will be `null` for manually defined tax rates. - `livemode` boolean, required — If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`. - `metadata` object, nullable — Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. - `object` 'tax_rate', required — String representing the object's type. Objects of the same type share the same value. - `percentage` number, required — Tax rate percentage out of 100. For tax calculations with automatic_tax[enabled]=true, this percentage includes the statutory tax rate of non-taxable jurisdictions. - `rate_type` 'flat_amount' | 'percentage', nullable — Indicates the type of tax rate applied to the taxable amount. This value can be `null` when no tax applies to the location. This field is only present for TaxRates created by Stripe Tax. - `state` string, nullable — [ISO 3166-2 subdivision code](https://en.wikipedia.org/wiki/ISO_3166-2), without country prefix. For example, "NY" for New York, United States. - `tax_type` 'amusement_tax' | 'communications_tax' | 'gst' | 'hst' | 'igst' | 'jct' | 'lease_tax' | 'mass_transit_parking_tax' | 'parking_tax' | 'pst' | 'qst' | 'retail_delivery_fee' | 'rst' | 'sales_tax' | 'service_tax' | 'vat', nullable — The high-level tax type, such as `vat` or `sales_tax`. - `taxability_reason` 'customer_exempt' | 'not_collecting' | 'not_subject_to_tax' | 'not_supported' | 'portion_product_exempt' | 'portion_reduced_rated' | 'portion_standard_rated' | 'product_exempt' | 'product_exempt_holiday' | 'proportionally_rated' | 'reduced_rated' | 'reverse_charge' | 'standard_rated' | 'taxable_basis_reduced' | 'zero_rated', nullable — The reasoning behind this tax, for example, if the product is tax exempt. The possible values for this field may be extended as new tax rules are supported. - `taxable_amount` integer, nullable — The amount on which tax is calculated, in cents (or local equivalent). - `shipping_options` PaymentPagesCheckoutSessionShippingOption[], required — The shipping rate options applied to this Session. - `shipping_amount` integer, required — A non-negative integer in cents representing how much to charge. - `shipping_rate` union, required — The shipping rate. - string - ShippingRate — Shipping rates describe the price of shipping presented to your customers and applied to a purchase. For more information, see [Charge for shipping](https://docs.stripe.com/payments/during-payment/charge-shipping). - `active` boolean, required — Whether the shipping rate can be used for new purchases. Defaults to `true`. - `created` integer, required — Time at which the object was created. Measured in seconds since the Unix epoch. - `delivery_estimate` ShippingRateDeliveryEstimate - … - `display_name` string, nullable — The name of the shipping rate, meant to be displayable to the customer. This will appear on CheckoutSessions. - `fixed_amount` ShippingRateFixedAmount - … - `id` string, required — Unique identifier for the object. - `livemode` boolean, required — If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`. - `metadata` object, required — Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. - `object` 'shipping_rate', required — String representing the object's type. Objects of the same type share the same value. - `tax_behavior` 'exclusive' | 'inclusive' | 'unspecified', nullable — Specifies whether the rate is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. - `tax_code` union — A [tax code](https://docs.stripe.com/tax/tax-categories) ID. The Shipping tax code is `txcd_92010001`. - … - `type` 'fixed_amount', required — The type of calculation to use on the shipping rate. - `status` 'complete' | 'expired' | 'open', nullable — The status of the Checkout Session, one of `open`, `complete`, or `expired`. - `submit_type` 'auto' | 'book' | 'donate' | 'pay' | 'subscribe', nullable — 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. - `subscription` union — The ID of the [Subscription](https://docs.stripe.com/api/subscriptions) for Checkout Sessions in `subscription` mode. - string - Subscription — Subscriptions allow you to charge a customer on a recurring basis. Related guide: [Creating subscriptions](https://docs.stripe.com/billing/subscriptions/creating) - `application` union — ID of the Connect Application that created the subscription. - string - Application - … - DeletedApplication - … - `application_fee_percent` number, nullable — A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice total that will be transferred to the application owner's Stripe account. - `automatic_tax` SubscriptionAutomaticTax, required - `disabled_reason` 'requires_location_inputs', nullable — If Stripe disabled automatic tax, this enum describes why. - `enabled` boolean, required — Whether Stripe automatically computes tax on this subscription. - `liability` ConnectAccountReference - … - `billing_cycle_anchor` integer, required — The reference point that aligns future [billing cycle](https://docs.stripe.com/subscriptions/billing-cycle) dates. It sets the day of week for `week` intervals, the day of month for `month` and `year` intervals, and the month of year for `year` intervals. The timestamp is in UTC format. - `billing_cycle_anchor_config` SubscriptionsResourceBillingCycleAnchorConfig - `day_of_month` integer, required — The day of the month of the billing_cycle_anchor. - `hour` integer, nullable — The hour of the day of the billing_cycle_anchor. - `minute` integer, nullable — The minute of the hour of the billing_cycle_anchor. - `month` integer, nullable — The month to start full cycle billing periods. - `second` integer, nullable — The second of the minute of the billing_cycle_anchor. - `billing_mode` SubscriptionsResourceBillingMode, required — The billing mode of the subscription. - `flexible` SubscriptionsResourceBillingModeFlexible - … - `type` 'classic' | 'flexible', required — Controls how prorations and invoices for subscriptions are calculated and orchestrated. - `updated_at` integer — Details on when the current billing_mode was adopted. - `billing_schedules` SubscriptionsResourceBillingSchedules[], required — Billing schedules for this subscription. - `applies_to` SubscriptionsResourceBillingSchedulesAppliesTo[], nullable — Specifies which subscription items the billing schedule applies to. - … - `bill_until` SubscriptionsResourceBillingSchedulesBillUntil, required — Specifies the end of billing period. - … - `key` string, required — Unique identifier for the billing schedule. - `billing_thresholds` SubscriptionBillingThresholds - `amount_gte` integer, nullable — Monetary threshold that triggers the subscription to create an invoice - `reset_billing_cycle_anchor` boolean, nullable — Indicates if the `billing_cycle_anchor` should be reset when a threshold is reached. If true, `billing_cycle_anchor` will be updated to the date/time the threshold was last reached; otherwise, the value will remain unchanged. This value may not be `true` if the subscription contains items with plans that have `aggregate_usage=last_ever`. - `cancel_at` integer, nullable — A date in the future at which the subscription will automatically get canceled - `cancel_at_period_end` boolean, required — Whether this subscription will (if `status=active`) or did (if `status=canceled`) cancel at the end of the current billing period. - `canceled_at` integer, nullable — If the subscription has been canceled, the date of that cancellation. If the subscription was canceled with `cancel_at_period_end`, `canceled_at` will reflect the time of the most recent update request, not the end of the subscription period when the subscription is automatically moved to a canceled state. - `cancellation_details` CancellationDetails - `comment` string, nullable — Additional comments about why the user canceled the subscription, if the subscription was canceled explicitly by the user. - `feedback` 'customer_service' | 'low_quality' | 'missing_features' | 'other' | 'switched_service' | 'too_complex' | 'too_expensive' | 'unused', nullable — The customer submitted reason for why they canceled, if the subscription was canceled explicitly by the user. - `reason` 'canceled_by_retention_policy' | 'cancellation_requested' | 'payment_disputed' | 'payment_failed', nullable — Why this subscription was canceled. - `collection_method` 'charge_automatically' | 'send_invoice', required — Either `charge_automatically`, or `send_invoice`. When charging automatically, Stripe will attempt to pay this subscription at the end of the cycle using the default source attached to the customer. When sending an invoice, Stripe will email your customer an invoice with payment instructions and mark the subscription as `active`. - `created` integer, required — Time at which the object was created. Measured in seconds since the Unix epoch. - `currency` string, currency, required — 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). - `customer` union, required — ID of the customer who owns the subscription. - string - Customer — This object represents a customer of your business. Use it to [create recurring charges](https://docs.stripe.com/invoicing/customer), [save payment](https://docs.stripe.com/payments/save-during-payment) and contact information, and track payments that belong to the same customer. - … - DeletedCustomer - … - `customer_account` string, nullable — ID of the account representing the customer who owns the subscription. - `days_until_due` integer, nullable — Number of days a customer has to pay invoices generated by this subscription. This value will be `null` for subscriptions where `collection_method=charge_automatically`. - `default_payment_method` union — ID of the default payment method for the subscription. It must belong to the customer associated with the subscription. This takes precedence over `default_source`. If neither are set, invoices will use the customer's [invoice_settings.default_payment_method](https://docs.stripe.com/api/customers/object#customer_object-invoice_settings-default_payment_method) or [default_source](https://docs.stripe.com/api/customers/object#customer_object-default_source). - string - PaymentMethod — PaymentMethod objects represent your customer's payment instruments. You can use them with [PaymentIntents](https://docs.stripe.com/payments/payment-intents) to collect payments or save them to Customer objects to store instrument details for future payments. Related guides: [Payment Methods](https://docs.stripe.com/payments/payment-methods) and [More Payment Scenarios](https://docs.stripe.com/payments/more-payment-scenarios). - … - `default_source` union — ID of the default payment source for the subscription. It must belong to the customer associated with the subscription and be in a chargeable state. If `default_payment_method` is also set, `default_payment_method` will take precedence. If neither are set, invoices will use the customer's [invoice_settings.default_payment_method](https://docs.stripe.com/api/customers/object#customer_object-invoice_settings-default_payment_method) or [default_source](https://docs.stripe.com/api/customers/object#customer_object-default_source). - string - BankAccount — These bank accounts are payment methods on `Customer` objects. On the other hand [External Accounts](/api#external_accounts) are transfer destinations on `Account` objects for connected accounts. They can be bank accounts or debit cards as well, and are documented in the links above. Related guide: [Bank debits and transfers](/payments/bank-debits-transfers) - … - Card — You can store multiple cards on a customer in order to charge the customer later. You can also store multiple debit cards on a recipient in order to transfer to those cards later. Related guide: [Card payments with Sources](https://docs.stripe.com/sources/cards) - … - Source — `Source` objects allow you to accept a variety of payment methods. They represent a customer's payment instrument, and can be used with the Stripe API just like a `Card` object: once chargeable, they can be charged, or can be attached to customers. Stripe doesn't recommend using the deprecated [Sources API](https://docs.stripe.com/api/sources). We recommend that you adopt the [PaymentMethods API](https://docs.stripe.com/api/payment_methods). This newer API provides access to our latest features and payment method types. Related guides: [Sources API](https://docs.stripe.com/sources) and [Sources & Customers](https://docs.stripe.com/sources/customers). - … - `default_tax_rates` TaxRate[], nullable — The tax rates that will apply to any subscription item that does not have `tax_rates` set. Invoices created will have their `default_tax_rates` populated from the subscription. - `active` boolean, required — Defaults to `true`. When set to `false`, this tax rate cannot be used with new applications or Checkout Sessions, but will still work for subscriptions and invoices that already have it set. - `country` string, nullable — Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)). - `created` integer, required — Time at which the object was created. Measured in seconds since the Unix epoch. - `description` string, nullable — An arbitrary string attached to the tax rate for your internal use only. It will not be visible to your customers. - `display_name` string, required — The display name of the tax rates as it will appear to your customer on their receipt email, PDF, and the hosted invoice page. - `effective_percentage` number, nullable — Actual/effective tax rate percentage out of 100. For tax calculations with automatic_tax[enabled]=true, this percentage reflects the rate actually used to calculate tax based on the product's taxability and whether the user is registered to collect taxes in the corresponding jurisdiction. - `flat_amount` TaxRateFlatAmount — The amount of the tax rate when the `rate_type`` is `flat_amount`. Tax rates with `rate_type` `percentage` can vary based on the transaction, resulting in this field being `null`. This field exposes the amount and currency of the flat tax rate. - … - `id` string, required — Unique identifier for the object. - `inclusive` boolean, required — This specifies if the tax rate is inclusive or exclusive. - `jurisdiction` string, nullable — The jurisdiction for the tax rate. You can use this label field for tax reporting purposes. It also appears on your customer’s invoice. - `jurisdiction_level` 'city' | 'country' | 'county' | 'district' | 'multiple' | 'state', nullable — The level of the jurisdiction that imposes this tax rate. Will be `null` for manually defined tax rates. - `livemode` boolean, required — If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`. - `metadata` object, nullable — Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. - `object` 'tax_rate', required — String representing the object's type. Objects of the same type share the same value. - `percentage` number, required — Tax rate percentage out of 100. For tax calculations with automatic_tax[enabled]=true, this percentage includes the statutory tax rate of non-taxable jurisdictions. - `rate_type` 'flat_amount' | 'percentage', nullable — Indicates the type of tax rate applied to the taxable amount. This value can be `null` when no tax applies to the location. This field is only present for TaxRates created by Stripe Tax. - `state` string, nullable — [ISO 3166-2 subdivision code](https://en.wikipedia.org/wiki/ISO_3166-2), without country prefix. For example, "NY" for New York, United States. - `tax_type` 'amusement_tax' | 'communications_tax' | 'gst' | 'hst' | 'igst' | 'jct' | 'lease_tax' | 'mass_transit_parking_tax' | 'parking_tax' | 'pst' | 'qst' | 'retail_delivery_fee' | 'rst' | 'sales_tax' | 'service_tax' | 'vat', nullable — The high-level tax type, such as `vat` or `sales_tax`. - `description` string, nullable — The subscription's description, meant to be displayable to the customer. Use this field to optionally store an explanation of the subscription for rendering in Stripe surfaces and certain local payment methods UIs. - `discounts` union[], required — The discounts applied to the subscription. Subscription item discounts are applied before subscription discounts. Use `expand[]=discounts` to expand each discount. - union - … - `ended_at` integer, nullable — If the subscription has ended, the date the subscription ended. - `id` string, required — Unique identifier for the object. - `invoice_settings` SubscriptionsResourceSubscriptionInvoiceSettings, required - `account_tax_ids` union[], nullable — The account tax IDs associated with the subscription. Will be set on invoices generated by the subscription. - … - `custom_fields` InvoiceSettingCustomField[], nullable — A list of up to 4 custom fields to be displayed on the invoice. - … - `description` string, nullable — An arbitrary string attached to the object. Often useful for displaying to users. - `footer` string, nullable — Footer to be displayed on the invoice. - `issuer` ConnectAccountReference, required - … - `items` object, required — List of subscription items, each with an attached price. - `data` SubscriptionItem[], required — Details about each object. - … - `has_more` boolean, required — True if this list has another page of items after this one that can be fetched. - `object` 'list', required — String representing the object's type. Objects of the same type share the same value. Always has the value `list`. - `url` string, required — The URL where this list can be accessed. - `latest_invoice` union — The most recent invoice this subscription has generated over its lifecycle (for example, when it cycles or is updated). - string - Invoice — Invoices are statements of amounts owed by a customer, and are either generated one-off, or generated periodically from a subscription. They contain [invoice items](https://api.stripe.com#invoiceitems), and proration adjustments that may be caused by subscription upgrades/downgrades (if necessary). If your invoice is configured to be billed through automatic charges, Stripe automatically finalizes your invoice and attempts payment. Note that finalizing the invoice, [when automatic](https://docs.stripe.com/invoicing/integration/automatic-advancement-collection), does not happen immediately as the invoice is created. Stripe waits until one hour after the last webhook was successfully sent (or the last webhook timed out after failing). If you (and the platforms you may have connected to) have no webhooks configured, Stripe waits one hour after creation to finalize the invoice. If your invoice is configured to be billed by sending an email, then based on your [email settings](https://dashboard.stripe.com/account/billing/automatic), Stripe will email the invoice to your customer and await payment. These emails can contain a link to a hosted page to pay the invoice. Stripe applies any customer credit on the account before determining the amount due for the invoice (i.e., the amount that will be actually charged). If the amount due for the invoice is less than Stripe's [minimum allowed charge per currency](/docs/currencies#minimum-and-maximum-charge-amounts), the invoice is automatically marked paid, and we add the amount due to the customer's credit balance which is applied to the next invoice. More details on the customer's credit balance are [here](https://docs.stripe.com/billing/customer/balance). Related guide: [Send invoices to customers](https://docs.stripe.com/billing/invoices/sending) - … - `livemode` boolean, required — If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`. - `managed_payments` SmorResourceManagedPayments - `enabled` boolean, required — Set to `true` to enable [Managed Payments](https://docs.stripe.com/payments/managed-payments), Stripe's merchant of record solution, for this session. - `metadata` object, required — Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. - `next_pending_invoice_item_invoice` integer, nullable — Specifies the approximate timestamp on which any pending invoice items will be billed according to the schedule provided at `pending_invoice_item_interval`. - `object` 'subscription', required — String representing the object's type. Objects of the same type share the same value. - `on_behalf_of` union — The account (if any) the charge was made on behalf of for charges associated with this subscription. See the [Connect documentation](https://docs.stripe.com/connect/subscriptions#on-behalf-of) for details. - string - Account — For new integrations, we recommend using the [Accounts v2 API](/api/v2/core/accounts), in place of /v1/accounts and /v1/customers to represent a user. This is an object representing a Stripe account. You can retrieve it to see properties on the account like its current requirements or if the account is enabled to make live charges or receive payouts. For accounts where [controller.requirement_collection](/api/accounts/object#account_object-controller-requirement_collection) is `application`, which includes Custom accounts, the properties below are always returned. For accounts where [controller.requirement_collection](/api/accounts/object#account_object-controller-requirement_collection) is `stripe`, which includes Standard and Express accounts, some properties are only returned until you create an [Account Link](/api/account_links) or [Account Session](/api/account_sessions) to start Connect Onboarding. Learn about the [differences between accounts](/connect/accounts). - … - `pause_collection` SubscriptionsResourcePauseCollection — The Pause Collection settings determine how we will pause collection for this subscription and for how long the subscription should be paused. - `behavior` 'keep_as_draft' | 'mark_uncollectible' | 'void', required — The payment collection behavior for this subscription while paused. - `resumes_at` integer, nullable — The time after which the subscription will resume collecting payments. - `payment_settings` SubscriptionsResourcePaymentSettings - `payment_method_options` SubscriptionsResourcePaymentMethodOptions - … - `payment_method_types` string[], nullable — The list of payment method types to provide to every invoice created by the subscription. If not set, Stripe attempts to automatically determine the types to use by looking at the invoice’s default payment method, the subscription’s default payment method, the customer’s default payment method, and your [invoice template settings](https://dashboard.stripe.com/settings/billing/invoice). - `save_default_payment_method` 'off' | 'on_subscription', nullable — Configure whether Stripe updates `subscription.default_payment_method` when payment succeeds. Defaults to `off`. - `pending_invoice_item_interval` SubscriptionPendingInvoiceItemInterval - `interval` 'day' | 'month' | 'week' | 'year', required — Specifies invoicing frequency. Either `day`, `week`, `month` or `year`. - `interval_count` integer, required — The number of intervals between invoices. For example, `interval=month` and `interval_count=3` bills every 3 months. Maximum of one year interval allowed (1 year, 12 months, or 52 weeks). - `pending_setup_intent` union — You can use this [SetupIntent](https://docs.stripe.com/api/setup_intents) to collect user authentication when creating a subscription without immediate payment or updating a subscription's payment method, allowing you to optimize for off-session payments. Learn more in the [SCA Migration Guide](https://docs.stripe.com/billing/migration/strong-customer-authentication#scenario-2). - string - SetupIntent — A SetupIntent guides you through the process of setting up and saving a customer's payment credentials for future payments. For example, you can use a SetupIntent to set up and save your customer's card without immediately collecting a payment. Later, you can use [PaymentIntents](https://api.stripe.com#payment_intents) to drive the payment flow. Create a SetupIntent when you're ready to collect your customer's payment credentials. Don't maintain long-lived, unconfirmed SetupIntents because they might not be valid. The SetupIntent transitions through multiple [statuses](https://docs.stripe.com/payments/intents#intent-statuses) as it guides you through the setup process. Successful SetupIntents result in payment credentials that are optimized for future payments. For example, cardholders in [certain regions](https://stripe.com/guides/strong-customer-authentication) might need to be run through [Strong Customer Authentication](https://docs.stripe.com/strong-customer-authentication) during payment method collection to streamline later [off-session payments](https://docs.stripe.com/payments/setup-intents). If you use the SetupIntent with a [Customer](https://api.stripe.com#setup_intent_object-customer), it automatically attaches the resulting payment method to that Customer after successful setup. We recommend using SetupIntents or [setup_future_usage](https://api.stripe.com#payment_intent_object-setup_future_usage) on PaymentIntents to save payment methods to prevent saving invalid or unoptimized payment methods. By using SetupIntents, you can reduce friction for your customers, even as regulations change over time. Related guide: [Setup Intents API](https://docs.stripe.com/payments/setup-intents) - … - `pending_update` SubscriptionsResourcePendingUpdate — Pending Updates store the changes pending from a previous update that will be applied to the Subscription upon successful payment. - `billing_cycle_anchor` integer, nullable — If the update is applied, determines the date of the first full invoice, and, for plans with `month` or `year` intervals, the day of the month for subsequent invoices. The timestamp is in UTC format. - `discount` Discount — A discount represents the actual application of a [coupon](https://api.stripe.com#coupons) or [promotion code](https://api.stripe.com#promotion_codes). It contains information about when the discount began, when it will end, and what it is applied to. Related guide: [Applying discounts to subscriptions](https://docs.stripe.com/billing/subscriptions/discounts) - … - `discounts` union[], nullable — The discounts that will be applied to the subscription when the pending update is applied. Use `expand[]=discounts` to expand each discount. - … - `expires_at` integer, required — The point after which the changes reflected by this update will be discarded and no longer applied. - `metadata` object, nullable — Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. - `subscription_items` SubscriptionItem[], nullable — List of subscription items, each with an attached plan, that will be set if the update is applied. - … - `trial_end` integer, nullable — Unix timestamp representing the end of the trial period the customer will get before being charged for the first time, if the update is applied. - `trial_from_plan` boolean, nullable — Indicates if a plan's `trial_period_days` should be applied to the subscription. Setting `trial_end` per subscription is preferred, and this defaults to `false`. Setting this flag to `true` together with `trial_end` is not allowed. See [Using trial periods on subscriptions](https://docs.stripe.com/billing/subscriptions/trials) to learn more. - `presentment_details` SubscriptionsResourceSubscriptionPresentmentDetails - `presentment_currency` string, required — Currency used for customer payments. - `schedule` union — The schedule attached to the subscription - string - SubscriptionSchedule — A subscription schedule allows you to create and manage the lifecycle of a subscription by predefining expected changes. Related guide: [Subscription schedules](https://docs.stripe.com/billing/subscriptions/subscription-schedules) - … - `start_date` integer, required — Date when the subscription was first created. The date might differ from the `created` date due to backdating. - `status` 'active' | 'canceled' | 'incomplete' | 'incomplete_expired' | 'past_due' | 'paused' | 'trialing' | 'unpaid', required — Possible values are `incomplete`, `incomplete_expired`, `trialing`, `active`, `past_due`, `canceled`, `unpaid`, or `paused`. For `collection_method=charge_automatically` a subscription moves into `incomplete` if the initial payment attempt fails. A subscription in this status can only have metadata and default_source updated. Once the first invoice is paid, the subscription moves into an `active` status. If the first invoice is not paid within 23 hours, the subscription transitions to `incomplete_expired`. This is a terminal status, the open invoice will be voided and no further invoices will be generated. A subscription that is currently in a trial period is `trialing` and moves to `active` when the trial period is over. A subscription can only enter a `paused` status [when a trial ends without a payment method](https://docs.stripe.com/billing/subscriptions/trials#create-free-trials-without-payment). A `paused` subscription doesn't generate invoices and can be resumed after your customer adds their payment method. The `paused` status is different from [pausing collection](https://docs.stripe.com/billing/subscriptions/pause-payment), which still generates invoices and leaves the subscription's status unchanged. If subscription `collection_method=charge_automatically`, it becomes `past_due` when payment is required but cannot be paid (due to failed payment or awaiting additional user actions). Once Stripe has exhausted all payment retry attempts, the subscription will become `canceled` or `unpaid` (depending on your subscriptions settings). If subscription `collection_method=send_invoice` it becomes `past_due` when its invoice is not paid by the due date, and `canceled` or `unpaid` if it is still not paid by an additional deadline after that. Note that when a subscription has a status of `unpaid`, no subsequent invoices will be attempted (invoices will be created, but then immediately automatically closed). After receiving updated payment information from a customer, you may choose to reopen and pay their closed invoices. - `test_clock` union — ID of the test clock this subscription belongs to. - string - TestHelpersTestClock — A test clock enables deterministic control over objects in testmode. With a test clock, you can create objects at a frozen time in the past or future, and advance to a specific future time to observe webhooks and state changes. After the clock advances, you can either validate the current state of your scenario (and test your assumptions), change the current state of your scenario (and test more complex scenarios), or keep advancing forward in time. - … - `transfer_data` SubscriptionTransferData - `amount_percent` number, nullable — A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice total that will be transferred to the destination account. By default, the entire amount is transferred to the destination. - `destination` union, required — The account where funds from the payment will be transferred to upon payment success. - … - `trial_end` integer, nullable — If the subscription has a trial, the end of that trial. - `trial_settings` SubscriptionsResourceTrialSettingsTrialSettings — Configures how this subscription behaves during the trial period. - `end_behavior` SubscriptionsResourceTrialSettingsEndBehavior, required — Defines how a subscription behaves when a trial ends. - … - `trial_start` integer, nullable — If the subscription has a trial, the beginning of that trial. - `success_url` string, nullable — The URL the customer will be directed to after the payment or subscription creation is successful. - `tax_id_collection` PaymentPagesCheckoutSessionTaxIdCollection - `enabled` boolean, required — Indicates whether tax ID collection is enabled for the session - `required` 'if_supported' | 'never', required — Indicates whether a tax ID is required on the payment page - `total_details` PaymentPagesCheckoutSessionTotalDetails - `amount_discount` integer, required — This is the sum of all the discounts. - `amount_shipping` integer, nullable — This is the sum of all the shipping amounts. - `amount_tax` integer, required — This is the sum of all the tax amounts. - `breakdown` PaymentPagesCheckoutSessionTotalDetailsResourceBreakdown - `discounts` LineItemsDiscountAmount[], required — The aggregated discounts. - `amount` integer, required — The amount discounted. - `discount` Discount, required — A discount represents the actual application of a [coupon](https://api.stripe.com#coupons) or [promotion code](https://api.stripe.com#promotion_codes). It contains information about when the discount began, when it will end, and what it is applied to. Related guide: [Applying discounts to subscriptions](https://docs.stripe.com/billing/subscriptions/discounts) - … - `taxes` LineItemsTaxAmount[], required — The aggregated tax amounts by rate. - `amount` integer, required — Amount of tax applied for this rate. - `rate` TaxRate, required — Tax rates can be applied to [invoices](/invoicing/taxes/tax-rates), [subscriptions](/billing/taxes/tax-rates) and [Checkout Sessions](/payments/checkout/use-manual-tax-rates) to collect tax. Related guide: [Tax rates](/billing/taxes/tax-rates) - … - `taxability_reason` 'customer_exempt' | 'not_collecting' | 'not_subject_to_tax' | 'not_supported' | 'portion_product_exempt' | 'portion_reduced_rated' | 'portion_standard_rated' | 'product_exempt' | 'product_exempt_holiday' | 'proportionally_rated' | 'reduced_rated' | 'reverse_charge' | 'standard_rated' | 'taxable_basis_reduced' | 'zero_rated', nullable — The reasoning behind this tax, for example, if the product is tax exempt. The possible values for this field may be extended as new tax rules are supported. - `taxable_amount` integer, nullable — The amount on which tax is calculated, in cents (or local equivalent). - `ui_mode` 'elements' | 'embedded_page' | 'hosted_page', nullable — The UI mode of the Session. Defaults to `hosted_page`. - `url` string, nullable — The URL to the Checkout Session. Applies to Checkout Sessions with `ui_mode: hosted_page`. Redirect customers to this URL to take them to Checkout. If you’re using [Custom Domains](https://docs.stripe.com/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. - `wallet_options` CheckoutSessionWalletOptions - `link` CheckoutLinkWalletOptions - `display` 'auto' | 'never' — Describes whether Checkout should display Link. Defaults to `auto`. - `created` integer, required — Time at which the object was created. Measured in seconds since the Unix epoch. - `credit_note` union — The ID of the credit note (if any) related to the transaction. - string - CreditNote — Issue a credit note to adjust an invoice's amount after the invoice is finalized. Related guide: [Credit notes](https://docs.stripe.com/billing/invoices/credit-notes) - `amount` integer, required — The integer amount in cents (or local equivalent) representing the total amount of the credit note, including tax. - `amount_shipping` integer, required — This is the sum of all the shipping amounts. - `created` integer, required — Time at which the object was created. Measured in seconds since the Unix epoch. - `currency` string, currency, required — 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). - `customer` union, required — ID of the customer. - string - Customer — This object represents a customer of your business. Use it to [create recurring charges](https://docs.stripe.com/invoicing/customer), [save payment](https://docs.stripe.com/payments/save-during-payment) and contact information, and track payments that belong to the same customer. - `address` Address - `city` string, nullable — City, district, suburb, town, or village. - `country` string, nullable — Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)). - `line1` string, nullable — Address line 1, such as the street, PO Box, or company name. - `line2` string, nullable — Address line 2, such as the apartment, suite, unit, or building. - `postal_code` string, nullable — ZIP or postal code. - `state` string, nullable — State, county, province, or region ([ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2)). - `balance` integer — The current balance, if any, that's stored on the customer in their default currency. If negative, the customer has credit to apply to their next invoice. If positive, the customer has an amount owed that's added to their next invoice. The balance only considers amounts that Stripe hasn't successfully applied to any invoice. It doesn't reflect unpaid invoices. This balance is only taken into account after invoices finalize. For multi-currency balances, see [invoice_credit_balance](https://docs.stripe.com/api/customers/object#customer_object-invoice_credit_balance). - `business_name` string — The customer's business name. - `cash_balance` CashBalance — A customer's `Cash balance` represents real funds. Customers can add funds to their cash balance by sending a bank transfer. These funds can be used for payment and can eventually be paid out to your bank account. - `available` object, nullable — A hash of all cash balances available to this customer. You cannot delete a customer with any cash balances, even if the balance is 0. Amounts are represented in the [smallest currency unit](https://docs.stripe.com/currencies#zero-decimal). - `customer` string, required — The ID of the customer whose cash balance this object represents. - `customer_account` string, nullable — The ID of an Account representing a customer whose cash balance this object represents. - `livemode` boolean, required — If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`. - `object` 'cash_balance', required — String representing the object's type. Objects of the same type share the same value. - `settings` CustomerBalanceCustomerBalanceSettings, required - … - `created` integer, required — Time at which the object was created. Measured in seconds since the Unix epoch. - `currency` string, nullable — Three-letter [ISO code for the currency](https://stripe.com/docs/currencies) the customer can be charged in for recurring billing purposes. - `customer_account` string, nullable — The ID of an Account representing a customer. You can use this ID with any v1 API that accepts a customer_account parameter. - `default_source` union — ID of the default payment source for the customer. If you use payment methods created through the PaymentMethods API, see the [invoice_settings.default_payment_method](https://docs.stripe.com/api/customers/object#customer_object-invoice_settings-default_payment_method) field instead. - string - BankAccount — These bank accounts are payment methods on `Customer` objects. On the other hand [External Accounts](/api#external_accounts) are transfer destinations on `Account` objects for connected accounts. They can be bank accounts or debit cards as well, and are documented in the links above. Related guide: [Bank debits and transfers](/payments/bank-debits-transfers) - … - Card — You can store multiple cards on a customer in order to charge the customer later. You can also store multiple debit cards on a recipient in order to transfer to those cards later. Related guide: [Card payments with Sources](https://docs.stripe.com/sources/cards) - … - Source — `Source` objects allow you to accept a variety of payment methods. They represent a customer's payment instrument, and can be used with the Stripe API just like a `Card` object: once chargeable, they can be charged, or can be attached to customers. Stripe doesn't recommend using the deprecated [Sources API](https://docs.stripe.com/api/sources). We recommend that you adopt the [PaymentMethods API](https://docs.stripe.com/api/payment_methods). This newer API provides access to our latest features and payment method types. Related guides: [Sources API](https://docs.stripe.com/sources) and [Sources & Customers](https://docs.stripe.com/sources/customers). - … - `delinquent` boolean, nullable — Tracks the most recent state change on any invoice belonging to the customer. Paying an invoice or marking it uncollectible via the API will set this field to false. An automatic payment failure or passing the `invoice.due_date` will set this field to `true`. If an invoice becomes uncollectible by [dunning](https://docs.stripe.com/billing/automatic-collection), `delinquent` doesn't reset to `false`. If you care whether the customer has paid their most recent subscription invoice, use `subscription.status` instead. Paying or marking uncollectible any customer invoice regardless of whether it is the latest invoice for a subscription will always set this field to `false`. - `description` string, nullable — An arbitrary string attached to the object. Often useful for displaying to users. - `discount` Discount — A discount represents the actual application of a [coupon](https://api.stripe.com#coupons) or [promotion code](https://api.stripe.com#promotion_codes). It contains information about when the discount began, when it will end, and what it is applied to. Related guide: [Applying discounts to subscriptions](https://docs.stripe.com/billing/subscriptions/discounts) - `checkout_session` string, nullable — The Checkout session that this coupon is applied to, if it is applied to a particular session in payment mode. Not present for subscription mode. - `customer` union — The ID of the customer associated with this discount. - … - `customer_account` string, nullable — The ID of the account representing the customer associated with this discount. - `end` integer, nullable — If the coupon has a duration of `repeating`, the date that this discount will end. If the coupon has a duration of `once` or `forever`, this attribute will be null. - `id` string, required — The ID of the discount object. Discounts can't be fetched by ID. Use `expand[]=discounts` in API calls to expand discount IDs in an array. - `invoice` string, nullable — The invoice that the discount's coupon was applied to, if it was applied directly to a particular invoice. - `invoice_item` string, nullable — The invoice item `id` (or invoice line item `id` for invoice line items of type='subscription') that the discount's coupon was applied to, if it was applied directly to a particular invoice item or invoice line item. - `object` 'discount', required — String representing the object's type. Objects of the same type share the same value. - `promotion_code` union — The promotion code applied to create this discount. - … - `source` DiscountSource, required - … - `start` integer, required — Date that the coupon was applied. - `subscription` string, nullable — The subscription that this coupon is applied to, if it is applied to a particular subscription. - `subscription_item` string, nullable — The subscription item that this coupon is applied to, if it is applied to a particular subscription item. - `email` string, nullable — The customer's email address. - `id` string, required — Unique identifier for the object. - `individual_name` string — The customer's individual name. - `invoice_credit_balance` object — The current multi-currency balances, if any, that's stored on the customer. If positive in a currency, the customer has a credit to apply to their next invoice denominated in that currency. If negative, the customer has an amount owed that's added to their next invoice denominated in that currency. These balances don't apply to unpaid invoices. They solely track amounts that Stripe hasn't successfully applied to any invoice. Stripe only applies a balance in a specific currency to an invoice after that invoice (which is in the same currency) finalizes. - `invoice_prefix` string, nullable — The prefix for the customer used to generate unique invoice numbers. - `invoice_settings` InvoiceSettingCustomerSetting - `custom_fields` InvoiceSettingCustomField[], nullable — Default custom fields to be displayed on invoices for this customer. - … - `default_payment_method` union — ID of a payment method that's attached to the customer, to be used as the customer's default payment method for subscriptions and invoices. - … - `footer` string, nullable — Default footer to be displayed on invoices for this customer. - `rendering_options` InvoiceSettingCustomerRenderingOptions - … - `livemode` boolean, required — If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`. - `metadata` object — Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. - `name` string, nullable — The customer's full name or business name. - `next_invoice_sequence` integer — The suffix of the customer's next invoice number (for example, 0001). When the account uses account level sequencing, this parameter is ignored in API requests and the field omitted in API responses. - `object` 'customer', required — String representing the object's type. Objects of the same type share the same value. - `phone` string, nullable — The customer's phone number. - `preferred_locales` string[], nullable — The customer's preferred locales (languages), ordered by preference. - `shipping` Shipping - `address` Address - … - `carrier` string, nullable — The delivery service that shipped a physical product, such as Fedex, UPS, USPS, etc. - `name` string — Recipient name. - `phone` string, nullable — Recipient phone (including extension). - `tracking_number` string, nullable — 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. - `sources` object — The customer's payment sources, if any. - `data` union[], required — Details about each object. - … - `has_more` boolean, required — True if this list has another page of items after this one that can be fetched. - `object` 'list', required — String representing the object's type. Objects of the same type share the same value. Always has the value `list`. - `url` string, required — The URL where this list can be accessed. - `subscriptions` object — The customer's current subscriptions, if any. - `data` Subscription[], required — Details about each object. - … - `has_more` boolean, required — True if this list has another page of items after this one that can be fetched. - `object` 'list', required — String representing the object's type. Objects of the same type share the same value. Always has the value `list`. - `url` string, required — The URL where this list can be accessed. - `tax` CustomerTax - `automatic_tax` 'failed' | 'not_collecting' | 'supported' | 'unrecognized_location', required — Surfaces if automatic tax computation is possible given the current customer location information. - `ip_address` string, nullable — A recent IP address of the customer used for tax reporting and tax location inference. - `location` CustomerTaxLocation - … - `provider` 'anrok' | 'avalara' | 'sphere' | 'stripe', required — The tax calculation provider used for location resolution. Defaults to `stripe` when not using a [third-party provider](/tax/third-party-apps). - `tax_exempt` 'exempt' | 'none' | 'reverse', nullable — Describes the customer's tax exemption status, which is `none`, `exempt`, or `reverse`. When set to `reverse`, invoice and receipt PDFs include the following text: **"Reverse charge"**. - `tax_ids` object — The customer's tax IDs. - `data` TaxId[], required — Details about each object. - … - `has_more` boolean, required — True if this list has another page of items after this one that can be fetched. - `object` 'list', required — String representing the object's type. Objects of the same type share the same value. Always has the value `list`. - `url` string, required — The URL where this list can be accessed. - `test_clock` union — ID of the test clock that this customer belongs to. - string - TestHelpersTestClock — A test clock enables deterministic control over objects in testmode. With a test clock, you can create objects at a frozen time in the past or future, and advance to a specific future time to observe webhooks and state changes. After the clock advances, you can either validate the current state of your scenario (and test your assumptions), change the current state of your scenario (and test more complex scenarios), or keep advancing forward in time. - … - DeletedCustomer - `deleted` true, required — Always true for a deleted object - `id` string, required — Unique identifier for the object. - `object` 'customer', required — String representing the object's type. Objects of the same type share the same value. - `customer_account` string, nullable — ID of the account representing the customer. - `customer_balance_transaction` union — Customer balance transaction related to this credit note. - string - CustomerBalanceTransaction — recursive - `discount_amount` integer, required — The integer amount in cents (or local equivalent) representing the total amount of discount that was credited. - `discount_amounts` DiscountsResourceDiscountAmount[], required — The aggregate amounts calculated per discount for all line items. - `amount` integer, required — The amount, in cents (or local equivalent), of the discount. - `discount` union, required — The discount that was applied to get this discount amount. - string - Discount — A discount represents the actual application of a [coupon](https://api.stripe.com#coupons) or [promotion code](https://api.stripe.com#promotion_codes). It contains information about when the discount began, when it will end, and what it is applied to. Related guide: [Applying discounts to subscriptions](https://docs.stripe.com/billing/subscriptions/discounts) - `checkout_session` string, nullable — The Checkout session that this coupon is applied to, if it is applied to a particular session in payment mode. Not present for subscription mode. - `customer` union — The ID of the customer associated with this discount. - … - `customer_account` string, nullable — The ID of the account representing the customer associated with this discount. - `end` integer, nullable — If the coupon has a duration of `repeating`, the date that this discount will end. If the coupon has a duration of `once` or `forever`, this attribute will be null. - `id` string, required — The ID of the discount object. Discounts can't be fetched by ID. Use `expand[]=discounts` in API calls to expand discount IDs in an array. - `invoice` string, nullable — The invoice that the discount's coupon was applied to, if it was applied directly to a particular invoice. - `invoice_item` string, nullable — The invoice item `id` (or invoice line item `id` for invoice line items of type='subscription') that the discount's coupon was applied to, if it was applied directly to a particular invoice item or invoice line item. - `object` 'discount', required — String representing the object's type. Objects of the same type share the same value. - `promotion_code` union — The promotion code applied to create this discount. - … - `source` DiscountSource, required - … - `start` integer, required — Date that the coupon was applied. - `subscription` string, nullable — The subscription that this coupon is applied to, if it is applied to a particular subscription. - `subscription_item` string, nullable — The subscription item that this coupon is applied to, if it is applied to a particular subscription item. - DeletedDiscount - `checkout_session` string, nullable — The Checkout session that this coupon is applied to, if it is applied to a particular session in payment mode. Not present for subscription mode. - `customer` union — The ID of the customer associated with this discount. - … - `customer_account` string, nullable — The ID of the account representing the customer associated with this discount. - `deleted` true, required — Always true for a deleted object - `id` string, required — The ID of the discount object. Discounts can't be fetched by ID. Use `expand[]=discounts` in API calls to expand discount IDs in an array. - `invoice` string, nullable — The invoice that the discount's coupon was applied to, if it was applied directly to a particular invoice. - `invoice_item` string, nullable — The invoice item `id` (or invoice line item `id` for invoice line items of type='subscription') that the discount's coupon was applied to, if it was applied directly to a particular invoice item or invoice line item. - `object` 'discount', required — String representing the object's type. Objects of the same type share the same value. - `promotion_code` union — The promotion code applied to create this discount. - … - `source` DiscountSource, required - … - `start` integer, required — Date that the coupon was applied. - `subscription` string, nullable — The subscription that this coupon is applied to, if it is applied to a particular subscription. - `subscription_item` string, nullable — The subscription item that this coupon is applied to, if it is applied to a particular subscription item. - `effective_at` integer, nullable — The date when this credit note is in effect. Same as `created` unless overwritten. When defined, this value replaces the system-generated 'Date of issue' printed on the credit note PDF. - `id` string, required — Unique identifier for the object. - `invoice` union, required — ID of the invoice. - string - Invoice — Invoices are statements of amounts owed by a customer, and are either generated one-off, or generated periodically from a subscription. They contain [invoice items](https://api.stripe.com#invoiceitems), and proration adjustments that may be caused by subscription upgrades/downgrades (if necessary). If your invoice is configured to be billed through automatic charges, Stripe automatically finalizes your invoice and attempts payment. Note that finalizing the invoice, [when automatic](https://docs.stripe.com/invoicing/integration/automatic-advancement-collection), does not happen immediately as the invoice is created. Stripe waits until one hour after the last webhook was successfully sent (or the last webhook timed out after failing). If you (and the platforms you may have connected to) have no webhooks configured, Stripe waits one hour after creation to finalize the invoice. If your invoice is configured to be billed by sending an email, then based on your [email settings](https://dashboard.stripe.com/account/billing/automatic), Stripe will email the invoice to your customer and await payment. These emails can contain a link to a hosted page to pay the invoice. Stripe applies any customer credit on the account before determining the amount due for the invoice (i.e., the amount that will be actually charged). If the amount due for the invoice is less than Stripe's [minimum allowed charge per currency](/docs/currencies#minimum-and-maximum-charge-amounts), the invoice is automatically marked paid, and we add the amount due to the customer's credit balance which is applied to the next invoice. More details on the customer's credit balance are [here](https://docs.stripe.com/billing/customer/balance). Related guide: [Send invoices to customers](https://docs.stripe.com/billing/invoices/sending) - `account_country` string, nullable — The country of the business associated with this invoice, most often the business creating the invoice. - `account_name` string, nullable — The public name of the business associated with this invoice, most often the business creating the invoice. - `account_tax_ids` union[], nullable — The account tax IDs associated with the invoice. Only editable when the invoice is a draft. - union - … - `amount_due` integer, required — Final amount due at this time for this invoice. If the invoice's total is smaller than the minimum charge amount, for example, or if there is account credit that can be applied to the invoice, the `amount_due` may be 0. If there is a positive `starting_balance` for the invoice (the customer owes money), the `amount_due` will also take that into account. The charge that gets generated for the invoice will be for the amount specified in `amount_due`. - `amount_overpaid` integer, required — Amount that was overpaid on the invoice. The amount overpaid is credited to the customer's credit balance. - `amount_paid` integer, required — The amount, in cents (or local equivalent), that was paid. - `amount_paid_off_stripe` integer, required — Amount, in cents (or local equivalent), that was paid on the invoice outside of Stripe. - `amount_remaining` integer, required — The difference between amount_due and amount_paid, in cents (or local equivalent). - `amount_shipping` integer, required — This is the sum of all the shipping amounts. - `application` union — ID of the Connect Application that created the invoice. - string - Application - … - DeletedApplication - … - `attempt_count` integer, required — Number of payment attempts made for this invoice, from the perspective of the payment retry schedule. Any payment attempt counts as the first attempt, and subsequently only automatic retries increment the attempt count. In other words, manual payment attempts after the first attempt do not affect the retry schedule. If a failure is returned with a non-retryable return code, the invoice can no longer be retried unless a new payment method is obtained. Retries will continue to be scheduled, and attempt_count will continue to increment, but retries will only be executed if a new payment method is obtained. - `attempted` boolean, required — Whether an attempt has been made to pay the invoice. An invoice is not attempted until 1 hour after the `invoice.created` webhook, for example, so you might not want to display that invoice as unpaid to your users. - `auto_advance` boolean, required — Controls whether Stripe performs [automatic collection](https://docs.stripe.com/invoicing/integration/automatic-advancement-collection) of the invoice. If `false`, the invoice's state doesn't automatically advance without an explicit action. - `automatic_tax` AutomaticTax, required - `disabled_reason` 'finalization_requires_location_inputs' | 'finalization_system_error', nullable — If Stripe disabled automatic tax, this enum describes why. - `enabled` boolean, required — Whether Stripe automatically computes tax on this invoice. Note that incompatible invoice items (invoice items with manually specified [tax rates](https://docs.stripe.com/api/tax_rates), negative amounts, or `tax_behavior=unspecified`) cannot be added to automatic tax invoices. - `liability` ConnectAccountReference - … - `provider` string, nullable — The tax provider powering automatic tax. - `status` 'complete' | 'failed' | 'requires_location_inputs', nullable — The status of the most recent automated tax calculation for this invoice. - `automatically_finalizes_at` integer, nullable — The time when this invoice is currently scheduled to be automatically finalized. The field will be `null` if the invoice is not scheduled to finalize in the future. If the invoice is not in the draft state, this field will always be `null` - see `finalized_at` for the time when an already-finalized invoice was finalized. - `billing_reason` 'automatic_pending_invoice_item_invoice' | 'manual' | 'quote_accept' | 'subscription' | 'subscription_create' | 'subscription_cycle' | 'subscription_threshold' | 'subscription_update' | 'upcoming', nullable — Indicates the reason why the invoice was created. * `manual`: Unrelated to a subscription, for example, created via the invoice editor. * `subscription`: No longer in use. Applies to subscriptions from before May 2018 where no distinction was made between updates, cycles, and thresholds. * `subscription_create`: A new subscription was created. * `subscription_cycle`: A subscription advanced into a new period. * `subscription_threshold`: A subscription reached a billing threshold. * `subscription_update`: A subscription was updated. * `upcoming`: Reserved for upcoming invoices created through the Create Preview Invoice API or when an `invoice.upcoming` event is generated for an upcoming invoice on a subscription. - `collection_method` 'charge_automatically' | 'send_invoice', required — Either `charge_automatically`, or `send_invoice`. When charging automatically, Stripe will attempt to pay this invoice using the default source attached to the customer. When sending an invoice, Stripe will email this invoice to the customer with payment instructions. - `confirmation_secret` InvoicesResourceConfirmationSecret - `client_secret` string, required — The client_secret of the payment that Stripe creates for the invoice after finalization. - `type` string, required — The type of client_secret. Currently this is always payment_intent, referencing the default payment_intent that Stripe creates during invoice finalization - `created` integer, required — Time at which the object was created. Measured in seconds since the Unix epoch. - `currency` string, currency, required — 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). - `custom_fields` InvoiceSettingCustomField[], nullable — Custom fields displayed on the invoice. - `name` string, required — The name of the custom field. - `value` string, required — The value of the custom field. - `customer` union, required — The ID of the customer to bill. - string - Customer — This object represents a customer of your business. Use it to [create recurring charges](https://docs.stripe.com/invoicing/customer), [save payment](https://docs.stripe.com/payments/save-during-payment) and contact information, and track payments that belong to the same customer. - … - DeletedCustomer - … - `customer_account` string, nullable — The ID of the account representing the customer to bill. - `customer_address` Address - `city` string, nullable — City, district, suburb, town, or village. - `country` string, nullable — Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)). - `line1` string, nullable — Address line 1, such as the street, PO Box, or company name. - `line2` string, nullable — Address line 2, such as the apartment, suite, unit, or building. - `postal_code` string, nullable — ZIP or postal code. - `state` string, nullable — State, county, province, or region ([ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2)). - `customer_email` string, nullable — The customer's email. Until the invoice is finalized, this field will equal `customer.email`. Once the invoice is finalized, this field will no longer be updated. - `customer_name` string, nullable — The customer's name. Until the invoice is finalized, this field will equal `customer.name`. Once the invoice is finalized, this field will no longer be updated. - `customer_phone` string, nullable — The customer's phone number. Until the invoice is finalized, this field will equal `customer.phone`. Once the invoice is finalized, this field will no longer be updated. - `customer_shipping` Shipping - `address` Address - … - `carrier` string, nullable — The delivery service that shipped a physical product, such as Fedex, UPS, USPS, etc. - `name` string — Recipient name. - `phone` string, nullable — Recipient phone (including extension). - `tracking_number` string, nullable — 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. - `customer_tax_exempt` 'exempt' | 'none' | 'reverse', nullable — The customer's tax exempt status. Until the invoice is finalized, this field will equal `customer.tax_exempt`. Once the invoice is finalized, this field will no longer be updated. - `customer_tax_ids` InvoicesResourceInvoiceTaxId[], nullable — The customer's tax IDs. Until the invoice is finalized, this field will contain the same tax IDs as `customer.tax_ids`. Once the invoice is finalized, this field will no longer be updated. - `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' | 'fo_vat' | 'gb_vat' | 'ge_vat' | 'gi_tin' | 'gn_nif' | 'hk_br' | 'hr_oib' | 'hu_tin' | 'ic_nif' | 'id_npwp' | 'il_vat' | 'in_gst' | 'is_vat' | 'it_cf' | 'jp_cn' | 'jp_rn' | 'jp_trn' | 'ke_pin' | 'kg_tin' | 'kh_tin' | 'kr_brn' | 'kz_bin' | 'la_tin' | 'li_uid' | 'li_vat' | 'lk_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' | 'pl_nip' | 'py_ruc' | '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', required — 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`, `pl_nip`, `it_cf`, `fo_vat`, `gi_tin`, `py_ruc`, `tw_vat`, `th_vat`, `jp_cn`, `jp_rn`, `jp_trn`, `li_uid`, `li_vat`, `lk_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`, `ic_nif`, or `unknown` - `value` string, nullable — The value of the tax ID. - `default_payment_method` union — ID of the default payment method for the invoice. It must belong to the customer associated with the invoice. If not set, defaults to the subscription's default payment method, if any, or to the default payment method in the customer's invoice settings. - string - PaymentMethod — PaymentMethod objects represent your customer's payment instruments. You can use them with [PaymentIntents](https://docs.stripe.com/payments/payment-intents) to collect payments or save them to Customer objects to store instrument details for future payments. Related guides: [Payment Methods](https://docs.stripe.com/payments/payment-methods) and [More Payment Scenarios](https://docs.stripe.com/payments/more-payment-scenarios). - … - `default_source` union — ID of the default payment source for the invoice. It must belong to the customer associated with the invoice and be in a chargeable state. If not set, defaults to the subscription's default source, if any, or to the customer's default source. - string - BankAccount — These bank accounts are payment methods on `Customer` objects. On the other hand [External Accounts](/api#external_accounts) are transfer destinations on `Account` objects for connected accounts. They can be bank accounts or debit cards as well, and are documented in the links above. Related guide: [Bank debits and transfers](/payments/bank-debits-transfers) - … - Card — You can store multiple cards on a customer in order to charge the customer later. You can also store multiple debit cards on a recipient in order to transfer to those cards later. Related guide: [Card payments with Sources](https://docs.stripe.com/sources/cards) - … - Source — `Source` objects allow you to accept a variety of payment methods. They represent a customer's payment instrument, and can be used with the Stripe API just like a `Card` object: once chargeable, they can be charged, or can be attached to customers. Stripe doesn't recommend using the deprecated [Sources API](https://docs.stripe.com/api/sources). We recommend that you adopt the [PaymentMethods API](https://docs.stripe.com/api/payment_methods). This newer API provides access to our latest features and payment method types. Related guides: [Sources API](https://docs.stripe.com/sources) and [Sources & Customers](https://docs.stripe.com/sources/customers). - … - `default_tax_rates` TaxRate[], required — The tax rates applied to this invoice, if any. - `active` boolean, required — Defaults to `true`. When set to `false`, this tax rate cannot be used with new applications or Checkout Sessions, but will still work for subscriptions and invoices that already have it set. - `country` string, nullable — Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)). - `created` integer, required — Time at which the object was created. Measured in seconds since the Unix epoch. - `description` string, nullable — An arbitrary string attached to the tax rate for your internal use only. It will not be visible to your customers. - `display_name` string, required — The display name of the tax rates as it will appear to your customer on their receipt email, PDF, and the hosted invoice page. - `effective_percentage` number, nullable — Actual/effective tax rate percentage out of 100. For tax calculations with automatic_tax[enabled]=true, this percentage reflects the rate actually used to calculate tax based on the product's taxability and whether the user is registered to collect taxes in the corresponding jurisdiction. - `flat_amount` TaxRateFlatAmount — The amount of the tax rate when the `rate_type`` is `flat_amount`. Tax rates with `rate_type` `percentage` can vary based on the transaction, resulting in this field being `null`. This field exposes the amount and currency of the flat tax rate. - … - `id` string, required — Unique identifier for the object. - `inclusive` boolean, required — This specifies if the tax rate is inclusive or exclusive. - `jurisdiction` string, nullable — The jurisdiction for the tax rate. You can use this label field for tax reporting purposes. It also appears on your customer’s invoice. - `jurisdiction_level` 'city' | 'country' | 'county' | 'district' | 'multiple' | 'state', nullable — The level of the jurisdiction that imposes this tax rate. Will be `null` for manually defined tax rates. - `livemode` boolean, required — If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`. - `metadata` object, nullable — Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. - `object` 'tax_rate', required — String representing the object's type. Objects of the same type share the same value. - `percentage` number, required — Tax rate percentage out of 100. For tax calculations with automatic_tax[enabled]=true, this percentage includes the statutory tax rate of non-taxable jurisdictions. - `rate_type` 'flat_amount' | 'percentage', nullable — Indicates the type of tax rate applied to the taxable amount. This value can be `null` when no tax applies to the location. This field is only present for TaxRates created by Stripe Tax. - `state` string, nullable — [ISO 3166-2 subdivision code](https://en.wikipedia.org/wiki/ISO_3166-2), without country prefix. For example, "NY" for New York, United States. - `tax_type` 'amusement_tax' | 'communications_tax' | 'gst' | 'hst' | 'igst' | 'jct' | 'lease_tax' | 'mass_transit_parking_tax' | 'parking_tax' | 'pst' | 'qst' | 'retail_delivery_fee' | 'rst' | 'sales_tax' | 'service_tax' | 'vat', nullable — The high-level tax type, such as `vat` or `sales_tax`. - `description` string, nullable — An arbitrary string attached to the object. Often useful for displaying to users. Referenced as 'memo' in the Dashboard. - `discounts` union[], required — The discounts applied to the invoice. Line item discounts are applied before invoice discounts. Use `expand[]=discounts` to expand each discount. - union - … - `due_date` integer, nullable — The date on which payment for this invoice is due. This value will be `null` for invoices where `collection_method=charge_automatically`. - `effective_at` integer, nullable — The date when this invoice is in effect. Same as `finalized_at` unless overwritten. When defined, this value replaces the system-generated 'Date of issue' printed on the invoice PDF and receipt. - `ending_balance` integer, nullable — Ending customer balance after the invoice is finalized. Invoices are finalized approximately an hour after successful webhook delivery or when payment collection is attempted for the invoice. If the invoice has not been finalized yet, this will be null. - `footer` string, nullable — Footer displayed on the invoice. - `from_invoice` InvoicesResourceFromInvoice - `action` string, required — The relation between this invoice and the cloned invoice - `invoice` union, required — The invoice that was cloned. - … - `hosted_invoice_url` string, nullable — The URL for the hosted invoice page, which allows customers to view and pay an invoice. If the invoice has not been finalized yet, this will be null. - `id` string, required — Unique identifier for the object. For preview invoices created using the [create preview](https://stripe.com/docs/api/invoices/create_preview) endpoint, this id will be prefixed with `upcoming_in`. - `invoice_pdf` string, nullable — The link to download the PDF for the invoice. If the invoice has not been finalized yet, this will be null. - `issuer` ConnectAccountReference, required - `account` union — The connected account being referenced when `type` is `account`. - … - `type` 'account' | 'self', required — Type of the account referenced. - `last_finalization_error` ApiErrors - `advice_code` string — For card errors resulting from a card issuer decline, a short string indicating [how to proceed with an error](https://docs.stripe.com/declines#retrying-issuer-declines) if they provide one. - `charge` string — For card errors, the ID of the failed charge. - `code` string — For some errors that could be handled programmatically, a short string indicating the [error code](https://docs.stripe.com/error-codes) reported. - `decline_code` string — For card errors resulting from a card issuer decline, a short string indicating the [card issuer's reason for the decline](https://docs.stripe.com/declines#issuer-declines) if they provide one. - `doc_url` string — A URL to more information about the [error code](https://docs.stripe.com/error-codes) reported. - `message` string — A human-readable message providing more details about the error. For card errors, these messages can be shown to your users. - `network_advice_code` string — For card errors resulting from a card issuer decline, a 2 digit code which indicates the advice given to merchant by the card network on how to proceed with an error. - `network_decline_code` string — For payments declined by the network, an alphanumeric code which indicates the reason the payment failed. - `param` string — If the error is parameter-specific, the parameter related to the error. For example, you can use this to display a message near the correct form field. - `payment_intent` PaymentIntent — A PaymentIntent guides you through the process of collecting a payment from your customer. We recommend that you create exactly one PaymentIntent for each order or customer session in your system. You can reference the PaymentIntent later to see the history of payment attempts for a particular session. A PaymentIntent transitions through [multiple statuses](/payments/paymentintents/lifecycle) throughout its lifetime as it interfaces with Stripe.js to perform authentication flows and ultimately creates at most one successful charge. Related guide: [Payment Intents API](https://docs.stripe.com/payments/payment-intents) - … - `payment_method` PaymentMethod — PaymentMethod objects represent your customer's payment instruments. You can use them with [PaymentIntents](https://docs.stripe.com/payments/payment-intents) to collect payments or save them to Customer objects to store instrument details for future payments. Related guides: [Payment Methods](https://docs.stripe.com/payments/payment-methods) and [More Payment Scenarios](https://docs.stripe.com/payments/more-payment-scenarios). - … - `payment_method_type` string — If the error is specific to the type of payment method, the payment method type that had a problem. This field is only populated for invoice-related errors. - `request_log_url` string — A URL to the request log entry in your dashboard. - `setup_intent` SetupIntent — A SetupIntent guides you through the process of setting up and saving a customer's payment credentials for future payments. For example, you can use a SetupIntent to set up and save your customer's card without immediately collecting a payment. Later, you can use [PaymentIntents](https://api.stripe.com#payment_intents) to drive the payment flow. Create a SetupIntent when you're ready to collect your customer's payment credentials. Don't maintain long-lived, unconfirmed SetupIntents because they might not be valid. The SetupIntent transitions through multiple [statuses](https://docs.stripe.com/payments/intents#intent-statuses) as it guides you through the setup process. Successful SetupIntents result in payment credentials that are optimized for future payments. For example, cardholders in [certain regions](https://stripe.com/guides/strong-customer-authentication) might need to be run through [Strong Customer Authentication](https://docs.stripe.com/strong-customer-authentication) during payment method collection to streamline later [off-session payments](https://docs.stripe.com/payments/setup-intents). If you use the SetupIntent with a [Customer](https://api.stripe.com#setup_intent_object-customer), it automatically attaches the resulting payment method to that Customer after successful setup. We recommend using SetupIntents or [setup_future_usage](https://api.stripe.com#payment_intent_object-setup_future_usage) on PaymentIntents to save payment methods to prevent saving invalid or unoptimized payment methods. By using SetupIntents, you can reduce friction for your customers, even as regulations change over time. Related guide: [Setup Intents API](https://docs.stripe.com/payments/setup-intents) - … - `source` union — The [source object](https://docs.stripe.com/api/sources/object) for errors returned on a request involving a source. - … - `type` 'api_error' | 'card_error' | 'idempotency_error' | 'invalid_request_error', required — The type of error returned. One of `api_error`, `card_error`, `idempotency_error`, or `invalid_request_error` - `latest_revision` union — The ID of the most recent non-draft revision of this invoice - string - Invoice — recursive - `lines` object, required — The individual line items that make up the invoice. `lines` is sorted as follows: (1) pending invoice items (including prorations) in reverse chronological order, (2) subscription items in reverse chronological order, and (3) invoice items added after invoice creation in chronological order. - `data` LineItem[], required — Details about each object. - … - `has_more` boolean, required — True if this list has another page of items after this one that can be fetched. - `object` 'list', required — String representing the object's type. Objects of the same type share the same value. Always has the value `list`. - `url` string, required — The URL where this list can be accessed. - `livemode` boolean, required — If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`. - `metadata` object, nullable — Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. - `next_payment_attempt` integer, nullable — The time at which payment will next be attempted. This value will be `null` for invoices where `collection_method=send_invoice`. - `number` string, nullable — A unique, identifying string that appears on emails sent to the customer for this invoice. This starts with the customer's unique invoice_prefix if it is specified. - `object` 'invoice', required — String representing the object's type. Objects of the same type share the same value. - `on_behalf_of` union — The account (if any) for which the funds of the invoice payment are intended. If set, the invoice will be presented with the branding and support information of the specified account. See the [Invoices with Connect](https://docs.stripe.com/billing/invoices/connect) documentation for details. - string - Account — For new integrations, we recommend using the [Accounts v2 API](/api/v2/core/accounts), in place of /v1/accounts and /v1/customers to represent a user. This is an object representing a Stripe account. You can retrieve it to see properties on the account like its current requirements or if the account is enabled to make live charges or receive payouts. For accounts where [controller.requirement_collection](/api/accounts/object#account_object-controller-requirement_collection) is `application`, which includes Custom accounts, the properties below are always returned. For accounts where [controller.requirement_collection](/api/accounts/object#account_object-controller-requirement_collection) is `stripe`, which includes Standard and Express accounts, some properties are only returned until you create an [Account Link](/api/account_links) or [Account Session](/api/account_sessions) to start Connect Onboarding. Learn about the [differences between accounts](/connect/accounts). - … - … truncated; see the full OpenAPI document linked below ## Other responses - `default` — Error response. --- [API](https://skmtc.net/stripe/apis/spec3.md) · [All operations](https://skmtc.net/stripe/apis/spec3/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/stripe/spec3/revisions/3653ad45bbec/schema)