--- title: "List customer balance transactions" method: GET path: "/v1/customers/{customer}/balance_transactions" --- # List customer balance transactions `GET /v1/customers/{customer}/balance_transactions` Returns a list of transactions that updated the customer’s [balances](/docs/billing/customer/balance). ## Path parameters - `customer` string, required ## Query parameters - `created` union - object - `gt` integer - `gte` integer - `lt` integer - `lte` integer - integer - `ending_before` string - `expand` string[] - `invoice` string - `limit` integer - `starting_after` string ## Response `200` Successful response. - object - `data` CustomerBalanceTransaction[], required — Details about each object. - `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`. - … - `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 - … - `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. - … - `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 - … - `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. - … - `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. - … - `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) - … - `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 - … - `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 - … - `sources` object — The customer's payment sources, if any. - … - `subscriptions` object — The customer's current subscriptions, if any. - … - `tax` CustomerTax - … - `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. - … - `test_clock` union — ID of the test clock that this customer belongs to. - … - 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). - … - `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. - … - `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. - … - `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. - … - `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 - … - `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 - … - `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. - … - `customer` union, required — The ID of the customer to bill. - … - `customer_account` string, nullable — The ID of the account representing the customer to bill. - `customer_address` Address - … - `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 - … - `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. - … - `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. - … - `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. - … - `default_tax_rates` TaxRate[], required — The tax rates applied to this invoice, if any. - … - `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. - … - `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 - … - `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 - … - `last_finalization_error` ApiErrors - … - `latest_revision` union — The ID of the most recent non-draft revision of this invoice - … - `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. - … - `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. - … - `parent` BillingBillResourceInvoicingParentsInvoiceParent - … - `payment_settings` InvoicesPaymentSettings, required - … - `payments` object — Payments for this invoice. Use [invoice payment](/api/invoice-payment) to get more details. - … - `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 - … - `shipping_cost` InvoicesResourceShippingCost - … - `shipping_details` Shipping - … - `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 - … - `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. - … - `threshold_reason` InvoiceThresholdReason - … - `total` integer, required — Total after discounts and taxes. - `total_discount_amounts` DiscountsResourceDiscountAmount[], nullable — The aggregate amounts calculated per discount across all line items. - … - `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. - … - `total_taxes` BillingBillResourceInvoicingTaxesTax[], nullable — The aggregate tax information of all line items. - … - `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. - … - `custom_fields` InvoiceSettingCustomField[], nullable — Custom fields displayed on the invoice. - … - `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 - … - `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 - … - `line_items` object — The line items purchased by the customer. - `data` Item[], required — Details about each object. - `adjustable_quantity` LineItemsAdjustableQuantity - … - `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. - … - `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). - … - `quantity` integer, nullable — The quantity of products being purchased. - `taxes` LineItemsTaxAmount[] — The taxes applied to the line item. - … - `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 - … - `amount_received` integer — Amount that this PaymentIntent collects. - `application` union — ID of the Connect application that created the PaymentIntent. - … - `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 - … - `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. - … - `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 - … - `id` string, required — Unique identifier for the object. - `last_payment_error` ApiErrors - … - `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. - … - `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 - … - `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 - … - `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. - … - `payment_details` PaymentFlowsPaymentDetails - … - `payment_method` union — ID of the payment method used in this PaymentIntent. - … - `payment_method_configuration_details` PaymentMethodConfigBizPaymentMethodConfigurationDetails - … - `payment_method_options` PaymentIntentPaymentMethodOptions - … - `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 - … - `processing` PaymentIntentProcessing - … - `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. - … - `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 - … - `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 - … - `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 - … - `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. - … - `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 - … - `billing_address_collection` 'auto' | 'required', required — Configuration for collecting the customer's billing address. Defaults to `auto`. - `consent_collection` PaymentLinksResourceConsentCollection - … - `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`. - … - `custom_text` PaymentLinksResourceCustomText, required - … - `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 - … - `line_items` object — The line items representing what is being sold. - … - `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 - … - `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 - … - `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. - … - `optional_items` PaymentLinksResourceOptionalItem[], nullable — The optional items presented to the customer at checkout. - … - `payment_intent_data` PaymentLinksResourcePaymentIntentData - … - `payment_method_collection` 'always' | 'if_required', required — Configuration for collecting a payment method during checkout. Defaults to `always`. - `payment_method_options` PaymentLinksResourcePaymentMethodOptions - … - `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 - … - `restrictions` PaymentLinksResourceRestrictions - … - `shipping_address_collection` PaymentLinksResourceShippingAddressCollection - … - `shipping_options` PaymentLinksResourceShippingOption[], required — The shipping rate options applied to the session. - … - `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 - … - `tax_id_collection` PaymentLinksResourceTaxIdCollection, required - … - `transfer_data` PaymentLinksResourceTransferData - … - `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 - … - `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 - … - `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 - … - `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 - … - `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 - … - `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 - … - `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 - … - `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 - … - `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 - … - `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 - … - `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. - … - `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 - … - `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. - … - `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 - … - `latest_attempt` union — The most recent SetupAttempt for this 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 - … - `mandate` union — ID of the multi use Mandate generated by the SetupIntent. - … - `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 - … - `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. - … - `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. - … - `payment_method_configuration_details` PaymentMethodConfigBizPaymentMethodConfigurationDetails - … - `payment_method_options` SetupIntentPaymentMethodOptions - … - `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. - … - `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). - … - `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) - … - `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). - … - `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. - … - `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 - … - `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 - … - `billing_mode` SubscriptionsResourceBillingMode, required — The billing mode of the subscription. - … - `billing_schedules` SubscriptionsResourceBillingSchedules[], required — Billing schedules for this subscription. - … - `billing_thresholds` SubscriptionBillingThresholds - … - `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 - … - `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. - … - `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). - … - `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). - … - `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. - … - `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. - … - `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 - … - `items` object, required — List of subscription items, each with an attached price. - … - `latest_invoice` union — The most recent invoice this subscription has generated over its lifecycle (for example, when it cycles or is updated). - … - `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 - … - `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. - … - `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. - … - `payment_settings` SubscriptionsResourcePaymentSettings - … - `pending_invoice_item_interval` SubscriptionPendingInvoiceItemInterval - … - `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). - … - `pending_update` SubscriptionsResourcePendingUpdate — Pending Updates store the changes pending from a previous update that will be applied to the Subscription upon successful payment. - … - `presentment_details` SubscriptionsResourceSubscriptionPresentmentDetails - … - `schedule` union — The schedule attached to the subscription - … - `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. - … - `transfer_data` SubscriptionTransferData - … - `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. - … - `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. - … - `taxes` LineItemsTaxAmount[], required — The aggregated tax amounts by rate. - … - `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 - … - `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. - … - `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. - … - `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) - … - `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 - … - `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 - … - `sources` object — The customer's payment sources, if any. - … - `subscriptions` object — The customer's current subscriptions, if any. - … - `tax` CustomerTax - … - `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. - … - `test_clock` union — ID of the test clock that this customer belongs to. - … - 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) - … - DeletedDiscount - … - `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. - … - `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. - … - `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 - … - `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 - … - `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. - … - `customer` union, required — The ID of the customer to bill. - … - `customer_account` string, nullable — The ID of the account representing the customer to bill. - `customer_address` Address - … - `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 - … - `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. - … - `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. - … - `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. - … - `default_tax_rates` TaxRate[], required — The tax rates applied to this invoice, if any. - … - `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. - … - `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 - … - `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 - … - `last_finalization_error` ApiErrors - … - `latest_revision` union — The ID of the most recent non-draft revision of this invoice - … - `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. - … - `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. - … - `parent` BillingBillResourceInvoicingParentsInvoiceParent - … - `payment_settings` InvoicesPaymentSettings, required - … - `payments` object — Payments for this invoice. Use [invoice payment](/api/invoice-payment) to get more details. - … - `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 - … - `shipping_cost` InvoicesResourceShippingCost - … - `shipping_details` Shipping - … - `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 - … - `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. - … - `threshold_reason` InvoiceThresholdReason - … - `total` integer, required — Total after discounts and taxes. - `total_discount_amounts` DiscountsResourceDiscountAmount[], nullable — The aggregate amounts calculated per discount across all line items. - … - `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. - … - `total_taxes` BillingBillResourceInvoicingTaxesTax[], nullable — The aggregate tax information of all line items. - … - `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. - `lines` object, required — Line items that make up the credit note - `data` CreditNoteLineItem[], required — Details about each object. - `amount` integer, required — The integer amount in cents (or local equivalent) representing the gross amount being credited for this line item, excluding (exclusive) tax and discounts. - `description` string, nullable — Description of the item being credited. - `discount_amount` integer, required — The integer amount in cents (or local equivalent) representing the discount being credited for this line item. - `discount_amounts` DiscountsResourceDiscountAmount[], required — The amount of discount calculated per discount for this line item - … - `id` string, required — Unique identifier for the object. - `invoice_line_item` string — ID of the invoice line item being credited - `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` 'credit_note_line_item', required — String representing the object's type. Objects of the same type share the same value. - `pretax_credit_amounts` CreditNotesPretaxCreditAmount[], required — The pretax credit amounts (ex: discount, credit grants, etc) for this line item. - … - `quantity` integer, nullable — The number of units of product being credited. - `tax_rates` TaxRate[], required — The tax rates which apply to the line item. - … - `taxes` BillingBillResourceInvoicingTaxesTax[], nullable — The tax information of the line item. - … - `type` 'custom_line_item' | 'invoice_line_item', required — The type of the credit note line item, one of `invoice_line_item` or `custom_line_item`. When the type is `invoice_line_item` there is an additional `invoice_line_item` property on the resource the value of which is the id of the credited line item on the invoice. - `unit_amount` integer, nullable — The cost of each unit of product being credited. - `unit_amount_decimal` string, decimal, nullable — Same as `unit_amount`, but contains a decimal value with at most 12 decimal places. - `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`. - `memo` string, nullable — Customer-facing text that appears on the credit note PDF. - `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. - `number` string, required — A unique number that identifies this particular credit note and appears on the PDF of the credit note and its associated invoice. - `object` 'credit_note', required — String representing the object's type. Objects of the same type share the same value. - `out_of_band_amount` integer, nullable — Amount that was credited outside of Stripe. - `pdf` string, required — The link to download the PDF of the credit note. - `post_payment_amount` integer, required — The amount of the credit note that was refunded to the customer, credited to the customer's balance, credited outside of Stripe, or any combination thereof. - `pre_payment_amount` integer, required — The amount of the credit note by which the invoice's `amount_remaining` and `amount_due` were reduced. - `pretax_credit_amounts` CreditNotesPretaxCreditAmount[], required — The pretax credit amounts (ex: discount, credit grants, etc) for all 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. - string - BillingCreditBalanceTransaction — A credit balance transaction is a resource representing a transaction (either a credit or a debit) against an existing credit grant. - … - `discount` union — The discount that was applied to get this pretax credit 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) - … - DeletedDiscount - … - `type` 'credit_balance_transaction' | 'discount', required — Type of the pretax credit amount referenced. - `reason` 'duplicate' | 'fraudulent' | 'order_change' | 'product_unsatisfactory', nullable — Reason for issuing this credit note, one of `duplicate`, `fraudulent`, `order_change`, or `product_unsatisfactory` - `refunds` CreditNoteRefund[], required — Refunds related to this credit note. - `amount_refunded` integer, required — Amount of the refund that applies to this credit note, in cents (or local equivalent). - `payment_record_refund` CreditNotesPaymentRecordRefund - `payment_record` string, required — ID of the payment record. - `refund_group` string, required — ID of the refund group. - `refund` union, required — ID of the refund. - string - Refund — Refund objects allow you to refund a previously created charge that isn't refunded yet. Funds are refunded to the credit or debit card that's initially charged. Related guide: [Refunds](https://docs.stripe.com/refunds) - … - `type` 'payment_record_refund' | 'refund', nullable — Type of the refund, one of `refund` or `payment_record_refund`. - `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. - 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). - … - `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) - … - `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). - `status` 'issued' | 'void', required — Status of this credit note, one of `issued` or `void`. Learn more about [voiding credit notes](https://docs.stripe.com/billing/invoices/credit-notes#voiding). - `subtotal` integer, required — The integer amount in cents (or local equivalent) representing the amount of the credit note, excluding exclusive tax and invoice level discounts. - `subtotal_excluding_tax` integer, nullable — The integer amount in cents (or local equivalent) representing the amount of the credit note, excluding all tax and invoice level discounts. - `total` integer, required — The integer amount in cents (or local equivalent) representing the total amount of the credit note, including tax and all discount. - `total_excluding_tax` integer, nullable — The integer amount in cents (or local equivalent) representing the total amount of the credit note, excluding tax, but including discounts. - `total_taxes` BillingBillResourceInvoicingTaxesTax[], nullable — The aggregate tax information for 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 - `tax_rate` union, required — ID of the tax rate - … - `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. - `type` 'mixed' | 'post_payment' | 'pre_payment', required — Type of this credit note, one of `pre_payment` or `post_payment`. A `pre_payment` credit note means it was issued when the invoice was open. A `post_payment` credit note means it was issued when the invoice was paid. - `voided_at` integer, nullable — The time that the credit note was voided. - `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 — The ID of the customer the transaction belongs to. - 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 - `reconciliation_mode` 'automatic' | 'manual', required — The configuration for how funds that land in the customer cash balance are reconciled. - `using_merchant_default` boolean, required — A flag to indicate if reconciliation mode returned is the user's default or is specific to this customer cash balance - `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) - `account` union — The account this bank account belongs to. Only applicable on Accounts (not customers or recipients) This property is only available when returned as an [External Account](/api/external_account_bank_accounts/object) where [controller.is_controller](/api/accounts/object#account_object-controller-is_controller) is `true`. - … - `account_holder_name` string, nullable — The name of the person or business that owns the bank account. - `account_holder_type` string, nullable — The type of entity that holds the account. This can be either `individual` or `company`. - `account_type` string, nullable — The bank account type. This can only be `checking` or `savings` in most countries. In Japan, this can only be `futsu` or `toza`. - `available_payout_methods` string[], nullable — A set of available payout methods for this bank account. Only values from this set should be passed as the `method` when creating a payout. - `bank_name` string, nullable — Name of the bank associated with the routing number (e.g., `WELLS FARGO`). - `country` string, required — Two-letter ISO code representing the country the bank account is located in. - `currency` string, currency, required — Three-letter [ISO code for the currency](https://stripe.com/docs/payouts) paid out to the bank account. - `customer` union — The ID of the customer that the bank account is associated with. - … - `default_for_currency` boolean, nullable — Whether this bank account is the default external account for its currency. - `fingerprint` string, nullable — Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same. - `future_requirements` ExternalAccountRequirements - … - `id` string, required — Unique identifier for the object. - `last4` string, required — The last four digits of the bank account number. - `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` 'bank_account', required — String representing the object's type. Objects of the same type share the same value. - `requirements` ExternalAccountRequirements - … - `routing_number` string, nullable — The routing transit number for the bank account. - `status` string, required — For bank accounts, possible values are `new`, `validated`, `verified`, `verification_failed`, `tokenized_account_number_deactivated` or `errored`. A bank account that hasn't had any activity or validation performed is `new`. If Stripe can determine that the bank account exists, its status will be `validated`. Note that there often isn’t enough information to know (e.g., for smaller credit unions), and the validation is not always run. If customer bank account verification has succeeded, the bank account status will be `verified`. If the verification failed for any reason, such as microdeposit failure, the status will be `verification_failed`. If the status is `tokenized_account_number_deactivated`, the account utilizes a tokenized account number which has been deactivated due to expiration or revocation. This account will need to be reverified to continue using it for money movement. If a payout sent to this bank account fails, we'll set the status to `errored` and will not continue to send [scheduled payouts](https://stripe.com/docs/payouts#payout-schedule) until the bank details are updated. For external accounts, possible values are `new`, `errored`, `verification_failed`, and `tokenized_account_number_deactivated`. If a payout fails, the status is set to `errored` and scheduled payouts are stopped until account details are updated. In the US and India, if we can't [verify the owner of the bank account](https://support.stripe.com/questions/bank-account-ownership-verification), we'll set the status to `verification_failed`. Other validations aren't run against external accounts because they're only used for payouts. This means the other statuses don't apply. - 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) - `account` union - … - `address_city` string, nullable — City/District/Suburb/Town/Village. - `address_country` string, nullable — Billing address country, if provided when creating card. - `address_line1` string, nullable — Address line 1 (Street address/PO Box/Company name). - `address_line1_check` string, nullable — If `address_line1` was provided, results of the check: `pass`, `fail`, `unavailable`, or `unchecked`. - `address_line2` string, nullable — Address line 2 (Apartment/Suite/Unit/Building). - `address_state` string, nullable — State/County/Province/Region. - `address_zip` string, nullable — ZIP or postal code. - `address_zip_check` string, nullable — If `address_zip` was provided, results of the check: `pass`, `fail`, `unavailable`, or `unchecked`. - `allow_redisplay` 'always' | 'limited' | 'unspecified', nullable — This field indicates whether this payment method can be shown again to its customer in a checkout flow. Stripe products such as Checkout and Elements use this field to determine whether a payment method can be shown as a saved payment method in a checkout flow. The field defaults to “unspecified”. - `available_payout_methods` string[], nullable — A set of available payout methods for this card. Only values from this set should be passed as the `method` when creating a payout. - `brand` string, required — Card brand. Can be `American Express`, `Cartes Bancaires`, `Diners Club`, `Discover`, `Eftpos Australia`, `Girocard`, `JCB`, `MasterCard`, `UnionPay`, `Visa`, or `Unknown`. - `country` string, nullable — Two-letter ISO code representing the country of the card. You could use this attribute to get a sense of the international breakdown of cards you've collected. - `currency` string, currency, nullable — Three-letter [ISO code for currency](https://www.iso.org/iso-4217-currency-codes.html) in lowercase. Must be a [supported currency](https://docs.stripe.com/currencies). Only applicable on accounts (not customers or recipients). The card can be used as a transfer destination for funds in this currency. This property is only available when returned as an [External Account](/api/external_account_cards/object) where [controller.is_controller](/api/accounts/object#account_object-controller-is_controller) is `true`. - `customer` union — The customer that this card belongs to. This attribute will not be in the card object if the card belongs to an account or recipient instead. - … - `cvc_check` string, nullable — If a CVC was provided, results of the check: `pass`, `fail`, `unavailable`, or `unchecked`. A result of unchecked indicates that CVC was provided but hasn't been checked yet. Checks are typically performed when attaching a card to a Customer object, or when creating a charge. For more details, see [Check if a card is valid without a charge](https://support.stripe.com/questions/check-if-a-card-is-valid-without-a-charge). - `default_for_currency` boolean, nullable — Whether this card is the default external account for its currency. This property is only available for accounts where [controller.requirement_collection](/api/accounts/object#account_object-controller-requirement_collection) is `application`, which includes Custom accounts. - `dynamic_last4` string, nullable — (For tokenized numbers only.) The last four digits of the device account number. - `exp_month` integer, required — Two-digit number representing the card's expiration month. - `exp_year` integer, required — Four-digit number representing the card's expiration year. - `fingerprint` string, nullable — Uniquely identifies this particular card number. You can use this attribute to check whether two customers who’ve signed up with you are using the same card number, for example. For payment methods that tokenize card information (Apple Pay, Google Pay), the tokenized number might be provided instead of the underlying card number. *As of May 1, 2021, card fingerprint in India for Connect changed to allow two fingerprints for the same card---one for India and one for the rest of the world.* - `funding` string, required — Card funding type. Can be `credit`, `debit`, `prepaid`, or `unknown`. - `id` string, required — Unique identifier for the object. - `last4` string, required — The last four digits of the card. - `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 — Cardholder name. - `networks` TokenCardNetworks - … - `object` 'card', required — String representing the object's type. Objects of the same type share the same value. - `regulated_status` 'regulated' | 'unregulated', nullable — Status of a card based on the card issuer. - `status` string, nullable — For external accounts that are cards, possible values are `new` and `errored`. If a payout fails, the status is set to `errored` and [scheduled payouts](https://stripe.com/docs/payouts#payout-schedule) are stopped until account details are updated. - `tokenization_method` string, nullable — If the card number is tokenized, this is the method that was used. Can be `android_pay` (includes Google Pay), `apple_pay`, `masterpass`, `visa_checkout`, or null. - 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). - `ach_credit_transfer` SourceTypeAchCreditTransfer - … - `ach_debit` SourceTypeAchDebit - … - `acss_debit` SourceTypeAcssDebit - … - `alipay` SourceTypeAlipay - … - `allow_redisplay` 'always' | 'limited' | 'unspecified', nullable — This field indicates whether this payment method can be shown again to its customer in a checkout flow. Stripe products such as Checkout and Elements use this field to determine whether a payment method can be shown as a saved payment method in a checkout flow. The field defaults to “unspecified”. - `amount` integer, nullable — A positive integer in the smallest currency unit (that is, 100 cents for $1.00, or 1 for ¥1, Japanese Yen being a zero-decimal currency) representing the total amount associated with the source. This is the amount for which the source will be chargeable once ready. Required for `single_use` sources. - `au_becs_debit` SourceTypeAuBecsDebit - … - `bancontact` SourceTypeBancontact - … - `card` SourceTypeCard - … - `card_present` SourceTypeCardPresent - … - `client_secret` string, required — The client secret of the source. Used for client-side retrieval using a publishable key. - `code_verification` SourceCodeVerificationFlow - … - `created` integer, required — Time at which the object was created. Measured in seconds since the Unix epoch. - `currency` string, currency, nullable — Three-letter [ISO code for the currency](https://stripe.com/docs/currencies) associated with the source. This is the currency for which the source will be chargeable once ready. Required for `single_use` sources. - `customer` string — The ID of the customer to which this source is attached. This will not be present when the source has not been attached to a customer. - `eps` SourceTypeEps - … - `flow` string, required — The authentication `flow` of the source. `flow` is one of `redirect`, `receiver`, `code_verification`, `none`. - `giropay` SourceTypeGiropay - … - `id` string, required — Unique identifier for the object. - `ideal` SourceTypeIdeal - … - `klarna` SourceTypeKlarna - … - `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. - `multibanco` SourceTypeMultibanco - … - `object` 'source', required — String representing the object's type. Objects of the same type share the same value. - `owner` SourceOwner - … - `p24` SourceTypeP24 - … - `receiver` SourceReceiverFlow - … - `redirect` SourceRedirectFlow - … - `sepa_debit` SourceTypeSepaDebit - … - `sofort` SourceTypeSofort - … - `source_order` SourceOrder - … - `statement_descriptor` string, nullable — Extra information about a source. This will appear on your customer's statement every time you charge the source. - `status` string, required — The status of the source, one of `canceled`, `chargeable`, `consumed`, `failed`, or `pending`. Only `chargeable` sources can be used to create a charge. - `three_d_secure` SourceTypeThreeDSecure - … - `type` 'ach_credit_transfer' | 'ach_debit' | 'acss_debit' | 'alipay' | 'au_becs_debit' | 'bancontact' | 'card' | 'card_present' | 'eps' | 'giropay' | 'ideal' | 'klarna' | 'multibanco' | 'p24' | 'sepa_debit' | 'sofort' | 'three_d_secure' | 'wechat', required — The `type` of the source. The `type` is a payment method, one of `ach_credit_transfer`, `ach_debit`, `alipay`, `bancontact`, `card`, `card_present`, `eps`, `giropay`, `ideal`, `multibanco`, `klarna`, `p24`, `sepa_debit`, `sofort`, `three_d_secure`, or `wechat`. An additional hash is included on the source with a name matching this value. It contains additional information specific to the [payment method](https://docs.stripe.com/sources) used. - `usage` string, nullable — Either `reusable` or `single_use`. Whether this source should be reusable or not. Some source types may or may not be reusable by construction, while others may leave the option at creation. If an incompatible value is passed, an error will be returned. - `wechat` SourceTypeWechat - … - `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. - string - Customer — recursive - DeletedCustomer - … - `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. - 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. - … - `source` DiscountSource, required - `coupon` union — The coupon that was redeemed to create this discount. - … - `type` 'coupon', required — The source type of the discount. - `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. - `name` string, required — The name of the custom field. - `value` string, required — The value of the custom field. - `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. - 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). - … - `footer` string, nullable — Default footer to be displayed on invoices for this customer. - `rendering_options` InvoiceSettingCustomerRenderingOptions - `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 this customer's invoices. If set, the template will be used on all invoices for this customer unless a template is set directly on the invoice. - `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 - `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)). - `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. - union - … - `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. - `application` union — ID of the Connect Application that created the subscription. - … - `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 - … - `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 - … - `billing_mode` SubscriptionsResourceBillingMode, required — The billing mode of the subscription. - … - `billing_schedules` SubscriptionsResourceBillingSchedules[], required — Billing schedules for this subscription. - … - `billing_thresholds` SubscriptionBillingThresholds - … - `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 - … - `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. - … - `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). - … - `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). - … - `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. - … - `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. - … - `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 - … - `items` object, required — List of subscription items, each with an attached price. - … - `latest_invoice` union — The most recent invoice this subscription has generated over its lifecycle (for example, when it cycles or is updated). - … - `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 - … - `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. - … - `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. - … - `payment_settings` SubscriptionsResourcePaymentSettings - … - `pending_invoice_item_interval` SubscriptionPendingInvoiceItemInterval - … - `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). - … - `pending_update` SubscriptionsResourcePendingUpdate — Pending Updates store the changes pending from a previous update that will be applied to the Subscription upon successful payment. - … - `presentment_details` SubscriptionsResourceSubscriptionPresentmentDetails - … - `schedule` union — The schedule attached to the subscription - … - `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. - … - `transfer_data` SubscriptionTransferData - … - `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. - … - `trial_start` integer, nullable — If the subscription has a trial, the beginning of that trial. - `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 - `country` string, required — The identified tax country of the customer. - `source` 'billing_address' | 'ip_address' | 'payment_method' | 'shipping_destination', required — The data source used to infer the customer's location. - `state` string, nullable — The identified tax state, county, province, or region of the customer. - `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. - `country` string, nullable — Two-letter ISO code representing the country of the tax ID. - `created` integer, required — Time at which the object was created. Measured in seconds since the Unix epoch. - `customer` union — ID of the customer. - … - `customer_account` string, nullable — ID of the Account representing the customer. - `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`. - `object` 'tax_id', required — String representing the object's type. Objects of the same type share the same value. - `owner` TaxIDsOwner - … - `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 — Type of the tax ID, one of `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`, `us_ein`, `uy_ruc`, `uz_tin`, `uz_vat`, `ve_rif`, `vn_tin`, `za_vat`, `zm_tin`, or `zw_tin`. Note that some legacy tax IDs have type `unknown` - `value` string, required — Value of the tax ID. - `verification` TaxIdVerification - … - `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. - `created` integer, required — Time at which the object was created. Measured in seconds since the Unix epoch. - `deletes_after` integer, required — Time at which this clock is scheduled to auto delete. - `frozen_time` integer, required — Time at which all objects belonging to this clock are frozen. - `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`. - `name` string, nullable — The custom name supplied at creation. - `object` 'test_helpers.test_clock', required — String representing the object's type. Objects of the same type share the same value. - `status` 'advancing' | 'internal_failure' | 'ready', required — The status of the Test Clock. - `status_details` BillingClocksResourceStatusDetailsStatusDetails, required - … - `customer_account` string, nullable — The ID of an Account representing a customer that the transaction belongs to. - `description` string, nullable — An arbitrary string attached to the object. Often useful for displaying to users. - `ending_balance` integer, required — The customer's `balance` after the transaction was applied. A negative value decreases the amount due on the customer's next invoice. A positive value increases the amount due on the customer's next invoice. - `id` string, required — Unique identifier for the object. - `invoice` union — The ID of the invoice (if any) related to the transaction. - 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 - string - TaxId — You can add one or multiple tax IDs to a [customer](https://docs.stripe.com/api/customers) or account. Customer and account tax IDs get displayed on related invoices and credit notes. Related guides: [Customer tax identification numbers](https://docs.stripe.com/billing/taxes/tax-ids), [Account tax IDs](https://docs.stripe.com/invoicing/connect#account-tax-ids) - … - DeletedTaxId - … - `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 - `id` string, required — Unique identifier for the object. - `name` string, nullable — The name of the application. - `object` 'application', required — String representing the object's type. Objects of the same type share the same value. - DeletedApplication - `deleted` true, required — Always true for a deleted object - `id` string, required — Unique identifier for the object. - `name` string, nullable — The name of the application. - `object` 'application', required — String representing the object's type. Objects of the same type share the same value. - `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 - `account` union — The connected account being referenced when `type` is `account`. - … - `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 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. - `address` Address - … - `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. - … - `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. - … - `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) - … - `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 - … - `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 - … - `sources` object — The customer's payment sources, if any. - … - `subscriptions` object — The customer's current subscriptions, if any. - … - `tax` CustomerTax - … - `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. - … - `test_clock` union — ID of the test clock that this customer belongs to. - … - 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 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 - `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)). - `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). - `acss_debit` PaymentMethodAcssDebit - … - `affirm` PaymentMethodAffirm - `afterpay_clearpay` PaymentMethodAfterpayClearpay - `alipay` PaymentFlowsPrivatePaymentMethodsAlipay - `allow_redisplay` 'always' | 'limited' | 'unspecified' — This field indicates whether this payment method can be shown again to its customer in a checkout flow. Stripe products such as Checkout and Elements use this field to determine whether a payment method can be shown as a saved payment method in a checkout flow. The field defaults to “unspecified”. - `alma` PaymentMethodAlma - `amazon_pay` PaymentMethodAmazonPay - `au_becs_debit` PaymentMethodAuBecsDebit - … - `bacs_debit` PaymentMethodBacsDebit - … - `bancontact` PaymentMethodBancontact - `billie` PaymentMethodBillie - `billing_details` BillingDetails, required - … - `bizum` PaymentMethodBizum - … - `blik` PaymentMethodBlik - … - `boleto` PaymentMethodBoleto - … - `card` PaymentMethodCard - … - `card_present` PaymentMethodCardPresent - … - `cashapp` PaymentMethodCashapp - … - `created` integer, required — Time at which the object was created. Measured in seconds since the Unix epoch. - `crypto` PaymentMethodCrypto - `custom` PaymentMethodCustom - … - `customer` union — The ID of the Customer to which this PaymentMethod is saved. This will not be set when the PaymentMethod has not been saved to a Customer. - … - `customer_account` string, nullable - `customer_balance` PaymentMethodCustomerBalance - `eps` PaymentMethodEps - … - `fpx` PaymentMethodFpx - … - `giropay` PaymentMethodGiropay - `grabpay` PaymentMethodGrabpay - `id` string, required — Unique identifier for the object. - `ideal` PaymentMethodIdeal - … - `interac_present` PaymentMethodInteracPresent - … - `kakao_pay` PaymentMethodKakaoPay - `klarna` PaymentMethodKlarna - … - `konbini` PaymentMethodKonbini - `kr_card` PaymentMethodKrCard - … - `link` PaymentMethodLink - … - `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`. - `mb_way` PaymentMethodMbWay - `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. - `mobilepay` PaymentMethodMobilepay - `multibanco` PaymentMethodMultibanco - `naver_pay` PaymentMethodNaverPay - … - `nz_bank_account` PaymentMethodNzBankAccount - … - `object` 'payment_method', required — String representing the object's type. Objects of the same type share the same value. - `oxxo` PaymentMethodOxxo - `p24` PaymentMethodP24 - … - `pay_by_bank` PaymentMethodPayByBank - `payco` PaymentMethodPayco - `paynow` PaymentMethodPaynow - `paypal` PaymentMethodPaypal - … - `payto` PaymentMethodPayto - … - `pix` PaymentMethodPix - … - `promptpay` PaymentMethodPromptpay - `radar_options` RadarRadarOptions — Options to configure Radar. See [Radar Session](https://docs.stripe.com/radar/radar-session) for more information. - … - `revolut_pay` PaymentMethodRevolutPay - `samsung_pay` PaymentMethodSamsungPay - `satispay` PaymentMethodSatispay - `scalapay` PaymentMethodScalapay - `sepa_debit` PaymentMethodSepaDebit - … - `sofort` PaymentMethodSofort - … - `sunbit` PaymentMethodSunbit - `swish` PaymentMethodSwish - `twint` PaymentMethodTwint - `type` 'acss_debit' | 'affirm' | 'afterpay_clearpay' | 'alipay' | 'alma' | 'amazon_pay' | 'au_becs_debit' | 'bacs_debit' | 'bancontact' | 'billie' | 'bizum' | 'blik' | 'boleto' | 'card' | 'card_present' | 'cashapp' | 'crypto' | 'custom' | 'customer_balance' | 'eps' | 'fpx' | 'giropay' | 'grabpay' | 'ideal' | 'interac_present' | 'kakao_pay' | 'klarna' | 'konbini' | 'kr_card' | 'link' | 'mb_way' | 'mobilepay' | 'multibanco' | 'naver_pay' | 'nz_bank_account' | 'oxxo' | 'p24' | 'pay_by_bank' | 'payco' | 'paynow' | 'paypal' | 'payto' | 'pix' | 'promptpay' | 'revolut_pay' | 'samsung_pay' | 'satispay' | 'scalapay' | 'sepa_debit' | 'sofort' | 'sunbit' | 'swish' | 'twint' | 'upi' | 'us_bank_account' | 'wechat_pay' | 'zip', required — The type of the PaymentMethod. An additional hash is included on the PaymentMethod with a name matching this value. It contains additional information specific to the PaymentMethod type. - `upi` PaymentMethodUpi - … - `us_bank_account` PaymentMethodUsBankAccount - … - `wechat_pay` PaymentMethodWechatPay - `zip` PaymentMethodZip - `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) - `account` union — The account this bank account belongs to. Only applicable on Accounts (not customers or recipients) This property is only available when returned as an [External Account](/api/external_account_bank_accounts/object) where [controller.is_controller](/api/accounts/object#account_object-controller-is_controller) is `true`. - … - `account_holder_name` string, nullable — The name of the person or business that owns the bank account. - `account_holder_type` string, nullable — The type of entity that holds the account. This can be either `individual` or `company`. - `account_type` string, nullable — The bank account type. This can only be `checking` or `savings` in most countries. In Japan, this can only be `futsu` or `toza`. - `available_payout_methods` string[], nullable — A set of available payout methods for this bank account. Only values from this set should be passed as the `method` when creating a payout. - `bank_name` string, nullable — Name of the bank associated with the routing number (e.g., `WELLS FARGO`). - `country` string, required — Two-letter ISO code representing the country the bank account is located in. - `currency` string, currency, required — Three-letter [ISO code for the currency](https://stripe.com/docs/payouts) paid out to the bank account. - `customer` union — The ID of the customer that the bank account is associated with. - … - `default_for_currency` boolean, nullable — Whether this bank account is the default external account for its currency. - `fingerprint` string, nullable — Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same. - `future_requirements` ExternalAccountRequirements - … - `id` string, required — Unique identifier for the object. - `last4` string, required — The last four digits of the bank account number. - `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` 'bank_account', required — String representing the object's type. Objects of the same type share the same value. - `requirements` ExternalAccountRequirements - … - `routing_number` string, nullable — The routing transit number for the bank account. - `status` string, required — For bank accounts, possible values are `new`, `validated`, `verified`, `verification_failed`, `tokenized_account_number_deactivated` or `errored`. A bank account that hasn't had any activity or validation performed is `new`. If Stripe can determine that the bank account exists, its status will be `validated`. Note that there often isn’t enough information to know (e.g., for smaller credit unions), and the validation is not always run. If customer bank account verification has succeeded, the bank account status will be `verified`. If the verification failed for any reason, such as microdeposit failure, the status will be `verification_failed`. If the status is `tokenized_account_number_deactivated`, the account utilizes a tokenized account number which has been deactivated due to expiration or revocation. This account will need to be reverified to continue using it for money movement. If a payout sent to this bank account fails, we'll set the status to `errored` and will not continue to send [scheduled payouts](https://stripe.com/docs/payouts#payout-schedule) until the bank details are updated. For external accounts, possible values are `new`, `errored`, `verification_failed`, and `tokenized_account_number_deactivated`. If a payout fails, the status is set to `errored` and scheduled payouts are stopped until account details are updated. In the US and India, if we can't [verify the owner of the bank account](https://support.stripe.com/questions/bank-account-ownership-verification), we'll set the status to `verification_failed`. Other validations aren't run against external accounts because they're only used for payouts. This means the other statuses don't apply. - 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) - `account` union - … - `address_city` string, nullable — City/District/Suburb/Town/Village. - `address_country` string, nullable — Billing address country, if provided when creating card. - `address_line1` string, nullable — Address line 1 (Street address/PO Box/Company name). - `address_line1_check` string, nullable — If `address_line1` was provided, results of the check: `pass`, `fail`, `unavailable`, or `unchecked`. - `address_line2` string, nullable — Address line 2 (Apartment/Suite/Unit/Building). - `address_state` string, nullable — State/County/Province/Region. - `address_zip` string, nullable — ZIP or postal code. - `address_zip_check` string, nullable — If `address_zip` was provided, results of the check: `pass`, `fail`, `unavailable`, or `unchecked`. - `allow_redisplay` 'always' | 'limited' | 'unspecified', nullable — This field indicates whether this payment method can be shown again to its customer in a checkout flow. Stripe products such as Checkout and Elements use this field to determine whether a payment method can be shown as a saved payment method in a checkout flow. The field defaults to “unspecified”. - `available_payout_methods` string[], nullable — A set of available payout methods for this card. Only values from this set should be passed as the `method` when creating a payout. - `brand` string, required — Card brand. Can be `American Express`, `Cartes Bancaires`, `Diners Club`, `Discover`, `Eftpos Australia`, `Girocard`, `JCB`, `MasterCard`, `UnionPay`, `Visa`, or `Unknown`. - `country` string, nullable — Two-letter ISO code representing the country of the card. You could use this attribute to get a sense of the international breakdown of cards you've collected. - `currency` string, currency, nullable — Three-letter [ISO code for currency](https://www.iso.org/iso-4217-currency-codes.html) in lowercase. Must be a [supported currency](https://docs.stripe.com/currencies). Only applicable on accounts (not customers or recipients). The card can be used as a transfer destination for funds in this currency. This property is only available when returned as an [External Account](/api/external_account_cards/object) where [controller.is_controller](/api/accounts/object#account_object-controller-is_controller) is `true`. - `customer` union — The customer that this card belongs to. This attribute will not be in the card object if the card belongs to an account or recipient instead. - … - `cvc_check` string, nullable — If a CVC was provided, results of the check: `pass`, `fail`, `unavailable`, or `unchecked`. A result of unchecked indicates that CVC was provided but hasn't been checked yet. Checks are typically performed when attaching a card to a Customer object, or when creating a charge. For more details, see [Check if a card is valid without a charge](https://support.stripe.com/questions/check-if-a-card-is-valid-without-a-charge). - `default_for_currency` boolean, nullable — Whether this card is the default external account for its currency. This property is only available for accounts where [controller.requirement_collection](/api/accounts/object#account_object-controller-requirement_collection) is `application`, which includes Custom accounts. - `dynamic_last4` string, nullable — (For tokenized numbers only.) The last four digits of the device account number. - `exp_month` integer, required — Two-digit number representing the card's expiration month. - `exp_year` integer, required — Four-digit number representing the card's expiration year. - `fingerprint` string, nullable — Uniquely identifies this particular card number. You can use this attribute to check whether two customers who’ve signed up with you are using the same card number, for example. For payment methods that tokenize card information (Apple Pay, Google Pay), the tokenized number might be provided instead of the underlying card number. *As of May 1, 2021, card fingerprint in India for Connect changed to allow two fingerprints for the same card---one for India and one for the rest of the world.* - `funding` string, required — Card funding type. Can be `credit`, `debit`, `prepaid`, or `unknown`. - `id` string, required — Unique identifier for the object. - `last4` string, required — The last four digits of the card. - `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 — Cardholder name. - `networks` TokenCardNetworks - … - `object` 'card', required — String representing the object's type. Objects of the same type share the same value. - `regulated_status` 'regulated' | 'unregulated', nullable — Status of a card based on the card issuer. - `status` string, nullable — For external accounts that are cards, possible values are `new` and `errored`. If a payout fails, the status is set to `errored` and [scheduled payouts](https://stripe.com/docs/payouts#payout-schedule) are stopped until account details are updated. - `tokenization_method` string, nullable — If the card number is tokenized, this is the method that was used. Can be `android_pay` (includes Google Pay), `apple_pay`, `masterpass`, `visa_checkout`, or null. - 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). - `ach_credit_transfer` SourceTypeAchCreditTransfer - … - `ach_debit` SourceTypeAchDebit - … - `acss_debit` SourceTypeAcssDebit - … - `alipay` SourceTypeAlipay - … - `allow_redisplay` 'always' | 'limited' | 'unspecified', nullable — This field indicates whether this payment method can be shown again to its customer in a checkout flow. Stripe products such as Checkout and Elements use this field to determine whether a payment method can be shown as a saved payment method in a checkout flow. The field defaults to “unspecified”. - `amount` integer, nullable — A positive integer in the smallest currency unit (that is, 100 cents for $1.00, or 1 for ¥1, Japanese Yen being a zero-decimal currency) representing the total amount associated with the source. This is the amount for which the source will be chargeable once ready. Required for `single_use` sources. - `au_becs_debit` SourceTypeAuBecsDebit - … - `bancontact` SourceTypeBancontact - … - `card` SourceTypeCard - … - `card_present` SourceTypeCardPresent - … - `client_secret` string, required — The client secret of the source. Used for client-side retrieval using a publishable key. - `code_verification` SourceCodeVerificationFlow - … - `created` integer, required — Time at which the object was created. Measured in seconds since the Unix epoch. - `currency` string, currency, nullable — Three-letter [ISO code for the currency](https://stripe.com/docs/currencies) associated with the source. This is the currency for which the source will be chargeable once ready. Required for `single_use` sources. - `customer` string — The ID of the customer to which this source is attached. This will not be present when the source has not been attached to a customer. - `eps` SourceTypeEps - … - `flow` string, required — The authentication `flow` of the source. `flow` is one of `redirect`, `receiver`, `code_verification`, `none`. - `giropay` SourceTypeGiropay - … - `id` string, required — Unique identifier for the object. - `ideal` SourceTypeIdeal - … - `klarna` SourceTypeKlarna - … - `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. - `multibanco` SourceTypeMultibanco - … - `object` 'source', required — String representing the object's type. Objects of the same type share the same value. - `owner` SourceOwner - … - `p24` SourceTypeP24 - … - `receiver` SourceReceiverFlow - … - `redirect` SourceRedirectFlow - … - `sepa_debit` SourceTypeSepaDebit - … - `sofort` SourceTypeSofort - … - `source_order` SourceOrder - … - `statement_descriptor` string, nullable — Extra information about a source. This will appear on your customer's statement every time you charge the source. - `status` string, required — The status of the source, one of `canceled`, `chargeable`, `consumed`, `failed`, or `pending`. Only `chargeable` sources can be used to create a charge. - `three_d_secure` SourceTypeThreeDSecure - … - `type` 'ach_credit_transfer' | 'ach_debit' | 'acss_debit' | 'alipay' | 'au_becs_debit' | 'bancontact' | 'card' | 'card_present' | 'eps' | 'giropay' | 'ideal' | 'klarna' | 'multibanco' | 'p24' | 'sepa_debit' | 'sofort' | 'three_d_secure' | 'wechat', required — The `type` of the source. The `type` is a payment method, one of `ach_credit_transfer`, `ach_debit`, `alipay`, `bancontact`, `card`, `card_present`, `eps`, `giropay`, `ideal`, `multibanco`, `klarna`, `p24`, `sepa_debit`, `sofort`, `three_d_secure`, or `wechat`. An additional hash is included on the source with a name matching this value. It contains additional information specific to the [payment method](https://docs.stripe.com/sources) used. - `usage` string, nullable — Either `reusable` or `single_use`. Whether this source should be reusable or not. Some source types may or may not be reusable by construction, while others may leave the option at creation. If an incompatible value is passed, an error will be returned. - `wechat` SourceTypeWechat - … - `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. - `amount` integer, required — Amount of the tax when the `rate_type` is `flat_amount`. This positive integer represents how much to charge in the smallest currency unit (e.g., 100 cents to charge $1.00 or 100 to charge ¥100, a zero-decimal currency). The amount value supports up to eight digits (e.g., a value of 99999999 for a USD charge of $999,999.99). - `currency` string, required — Three-letter ISO currency code, in lowercase. - `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 - 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) - … - DeletedDiscount - … - `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. - string - Invoice — recursive - `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`. - 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. - `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) - `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 - … - `amount_received` integer — Amount that this PaymentIntent collects. - `application` union — ID of the Connect application that created the PaymentIntent. - … - `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 - … - `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. - … - `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 - … - `id` string, required — Unique identifier for the object. - `last_payment_error` ApiErrors — recursive - `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. - … - `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 - … - `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 - … - `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. - … - `payment_details` PaymentFlowsPaymentDetails - … - `payment_method` union — ID of the payment method used in this PaymentIntent. - … - `payment_method_configuration_details` PaymentMethodConfigBizPaymentMethodConfigurationDetails - … - `payment_method_options` PaymentIntentPaymentMethodOptions - … - `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 - … - `processing` PaymentIntentProcessing - … - `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. - … - `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 - … - `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 - … - `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_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). - `acss_debit` PaymentMethodAcssDebit - … - `affirm` PaymentMethodAffirm - `afterpay_clearpay` PaymentMethodAfterpayClearpay - `alipay` PaymentFlowsPrivatePaymentMethodsAlipay - `allow_redisplay` 'always' | 'limited' | 'unspecified' — This field indicates whether this payment method can be shown again to its customer in a checkout flow. Stripe products such as Checkout and Elements use this field to determine whether a payment method can be shown as a saved payment method in a checkout flow. The field defaults to “unspecified”. - `alma` PaymentMethodAlma - `amazon_pay` PaymentMethodAmazonPay - `au_becs_debit` PaymentMethodAuBecsDebit - … - `bacs_debit` PaymentMethodBacsDebit - … - `bancontact` PaymentMethodBancontact - `billie` PaymentMethodBillie - `billing_details` BillingDetails, required - … - `bizum` PaymentMethodBizum - … - `blik` PaymentMethodBlik - … - `boleto` PaymentMethodBoleto - … - `card` PaymentMethodCard - … - `card_present` PaymentMethodCardPresent - … - `cashapp` PaymentMethodCashapp - … - `created` integer, required — Time at which the object was created. Measured in seconds since the Unix epoch. - `crypto` PaymentMethodCrypto - `custom` PaymentMethodCustom - … - `customer` union — The ID of the Customer to which this PaymentMethod is saved. This will not be set when the PaymentMethod has not been saved to a Customer. - … - `customer_account` string, nullable - `customer_balance` PaymentMethodCustomerBalance - `eps` PaymentMethodEps - … - `fpx` PaymentMethodFpx - … - `giropay` PaymentMethodGiropay - … truncated; see the full OpenAPI document linked below ## Other responses - `default` — Error response. --- [API](https://skmtc.net/stripe/apis/stripe-api-2.md) · [All operations](https://skmtc.net/stripe/apis/stripe-api-2/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/stripe/stripe-api-2/versions/3653ad45bbec/schema)