--- title: "Create an invoice item" method: POST path: "/v1/invoiceitems" --- # Create an invoice item `POST /v1/invoiceitems` Creates an item to be added to a draft invoice (up to 250 items per invoice). If no invoice is specified, the item will be on the next invoice created for the customer specified. ## Response `200` Successful response. - Invoiceitem — Invoice Items represent the component lines of an [invoice](https://docs.stripe.com/api/invoices). When you create an invoice item with an `invoice` field, it is attached to the specified invoice and included as [an invoice line item](https://docs.stripe.com/api/invoices/line_item) within [invoice.lines](https://docs.stripe.com/api/invoices/object#invoice_object-lines). Invoice Items can be created before you are ready to actually send the invoice. This can be particularly useful when combined with a [subscription](https://docs.stripe.com/api/subscriptions). Sometimes you want to add a charge or credit to a customer, but actually charge or credit the customer's card only at the end of a regular billing cycle. This is useful for combining several charges (to minimize per-transaction fees), or for having Stripe tabulate your usage-based billing totals. Related guides: [Integrate with the Invoicing API](https://docs.stripe.com/invoicing/integration), [Subscription Invoices](https://docs.stripe.com/billing/invoices/subscription#adding-upcoming-invoice-items). - `amount` integer, required — Amount (in the `currency` specified) of the invoice item. This should always be equal to `unit_amount * quantity`. - `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 to bill for this invoice item. - 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`. - 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). - … - `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. - string - Customer — recursive - DeletedCustomer - … - `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 - `currently_due` string[], nullable — Fields that need to be resolved to keep the external account enabled. If not resolved by `current_deadline`, these fields will appear in `past_due` as well, and the account is disabled. - `errors` AccountRequirementsError[], nullable — Fields that are `currently_due` and need to be collected again because validation or verification failed. - … - `past_due` string[], nullable — Fields that haven't been resolved by `current_deadline`. These fields need to be resolved to enable the external account. - `pending_verification` string[], nullable — Fields that are being reviewed, or might become required depending on the results of a review. If the review fails, these fields can move to `eventually_due`, `currently_due`, `past_due` or `alternatives`. Fields might appear in `eventually_due`, `currently_due`, `past_due` or `alternatives` and in `pending_verification` if one verification fails but another is still pending. - `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 - `currently_due` string[], nullable — Fields that need to be resolved to keep the external account enabled. If not resolved by `current_deadline`, these fields will appear in `past_due` as well, and the account is disabled. - `errors` AccountRequirementsError[], nullable — Fields that are `currently_due` and need to be collected again because validation or verification failed. - … - `past_due` string[], nullable — Fields that haven't been resolved by `current_deadline`. These fields need to be resolved to enable the external account. - `pending_verification` string[], nullable — Fields that are being reviewed, or might become required depending on the results of a review. If the review fails, these fields can move to `eventually_due`, `currently_due`, `past_due` or `alternatives`. Fields might appear in `eventually_due`, `currently_due`, `past_due` or `alternatives` and in `pending_verification` if one verification fails but another is still pending. - `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 - 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). - … - `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. - string - Customer — recursive - DeletedCustomer - … - `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 - `preferred` string, nullable — The preferred network for co-branded cards. Can be `cartes_bancaires`, `mastercard`, `visa` or `invalid_preference` if requested network is not valid for the card. - `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 - `account_number` string, nullable - `bank_name` string, nullable - `fingerprint` string, nullable - `refund_account_holder_name` string, nullable - `refund_account_holder_type` string, nullable - `refund_routing_number` string, nullable - `routing_number` string, nullable - `swift_code` string, nullable - `ach_debit` SourceTypeAchDebit - `bank_name` string, nullable - `country` string, nullable - `fingerprint` string, nullable - `last4` string, nullable - `routing_number` string, nullable - `type` string, nullable - `acss_debit` SourceTypeAcssDebit - `bank_address_city` string, nullable - `bank_address_line_1` string, nullable - `bank_address_line_2` string, nullable - `bank_address_postal_code` string, nullable - `bank_name` string, nullable - `category` string, nullable - `country` string, nullable - `fingerprint` string, nullable - `last4` string, nullable - `routing_number` string, nullable - `alipay` SourceTypeAlipay - `data_string` string, nullable - `native_url` string, nullable - `statement_descriptor` string, nullable - `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 - `bsb_number` string, nullable - `fingerprint` string, nullable - `last4` string, nullable - `bancontact` SourceTypeBancontact - `bank_code` string, nullable - `bank_name` string, nullable - `bic` string, nullable - `iban_last4` string, nullable - `preferred_language` string, nullable - `statement_descriptor` string, nullable - `card` SourceTypeCard - `address_line1_check` string, nullable - `address_zip_check` string, nullable - `brand` string, nullable - `country` string, nullable - `cvc_check` string, nullable - `dynamic_last4` string, nullable - `exp_month` integer, nullable - `exp_year` integer, nullable - `fingerprint` string - `funding` string, nullable - `last4` string, nullable - `name` string, nullable - `three_d_secure` string - `tokenization_method` string, nullable - `card_present` SourceTypeCardPresent - `application_cryptogram` string - `application_preferred_name` string - `authorization_code` string, nullable - `authorization_response_code` string - `brand` string, nullable - `country` string, nullable - `cvm_type` string - `data_type` string, nullable - `dedicated_file_name` string - `emv_auth_data` string - `evidence_customer_signature` string, nullable - `evidence_transaction_certificate` string, nullable - `exp_month` integer, nullable - `exp_year` integer, nullable - `fingerprint` string - `funding` string, nullable - `last4` string, nullable - `pos_device_id` string, nullable - `pos_entry_mode` string - `read_method` string, nullable - `reader` string, nullable - `terminal_verification_results` string - `transaction_status_information` string - `client_secret` string, required — The client secret of the source. Used for client-side retrieval using a publishable key. - `code_verification` SourceCodeVerificationFlow - `attempts_remaining` integer, required — The number of attempts remaining to authenticate the source object with a verification code. - `status` string, required — The status of the code verification, either `pending` (awaiting verification, `attempts_remaining` should be greater than 0), `succeeded` (successful verification) or `failed` (failed verification, cannot be verified anymore as `attempts_remaining` should be 0). - `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 - `reference` string, nullable - `statement_descriptor` string, nullable - `flow` string, required — The authentication `flow` of the source. `flow` is one of `redirect`, `receiver`, `code_verification`, `none`. - `giropay` SourceTypeGiropay - `bank_code` string, nullable - `bank_name` string, nullable - `bic` string, nullable - `statement_descriptor` string, nullable - `id` string, required — Unique identifier for the object. - `ideal` SourceTypeIdeal - `bank` string, nullable - `bic` string, nullable - `iban_last4` string, nullable - `statement_descriptor` string, nullable - `klarna` SourceTypeKlarna - `background_image_url` string - `client_token` string, nullable - `first_name` string - `last_name` string - `locale` string - `logo_url` string - `page_title` string - `pay_later_asset_urls_descriptive` string - `pay_later_asset_urls_standard` string - `pay_later_name` string - `pay_later_redirect_url` string - `pay_now_asset_urls_descriptive` string - `pay_now_asset_urls_standard` string - `pay_now_name` string - `pay_now_redirect_url` string - `pay_over_time_asset_urls_descriptive` string - `pay_over_time_asset_urls_standard` string - `pay_over_time_name` string - `pay_over_time_redirect_url` string - `payment_method_categories` string - `purchase_country` string - `purchase_type` string - `redirect_url` string - `shipping_delay` integer - `shipping_first_name` string - `shipping_last_name` string - `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 - `entity` string, nullable - `reference` string, nullable - `refund_account_holder_address_city` string, nullable - `refund_account_holder_address_country` string, nullable - `refund_account_holder_address_line1` string, nullable - `refund_account_holder_address_line2` string, nullable - `refund_account_holder_address_postal_code` string, nullable - `refund_account_holder_address_state` string, nullable - `refund_account_holder_name` string, nullable - `refund_iban` string, nullable - `object` 'source', required — String representing the object's type. Objects of the same type share the same value. - `owner` SourceOwner - `address` Address - … - `email` string, nullable — Owner's email address. - `name` string, nullable — Owner's full name. - `phone` string, nullable — Owner's phone number (including extension). - `verified_address` Address - … - `verified_email` string, nullable — Verified owner's email address. Verified values are verified or provided by the payment method directly (and if supported) at the time of authorization or settlement. They cannot be set or mutated. - `verified_name` string, nullable — Verified owner's full name. Verified values are verified or provided by the payment method directly (and if supported) at the time of authorization or settlement. They cannot be set or mutated. - `verified_phone` string, nullable — Verified owner's phone number (including extension). Verified values are verified or provided by the payment method directly (and if supported) at the time of authorization or settlement. They cannot be set or mutated. - `p24` SourceTypeP24 - `reference` string, nullable - `receiver` SourceReceiverFlow - `address` string, nullable — The address of the receiver source. This is the value that should be communicated to the customer to send their funds to. - `amount_charged` integer, required — The total amount that was moved to your balance. This is almost always equal to the amount charged. In rare cases when customers deposit excess funds and we are unable to refund those, those funds get moved to your balance and show up in amount_charged as well. The amount charged is expressed in the source's currency. - `amount_received` integer, required — The total amount received by the receiver source. `amount_received = amount_returned + amount_charged` should be true for consumed sources unless customers deposit excess funds. The amount received is expressed in the source's currency. - `amount_returned` integer, required — The total amount that was returned to the customer. The amount returned is expressed in the source's currency. - `refund_attributes_method` string, required — Type of refund attribute method, one of `email`, `manual`, or `none`. - `refund_attributes_status` string, required — Type of refund attribute status, one of `missing`, `requested`, or `available`. - `redirect` SourceRedirectFlow - `failure_reason` string, nullable — The failure reason for the redirect, either `user_abort` (the customer aborted or dropped out of the redirect flow), `declined` (the authentication failed or the transaction was declined), or `processing_error` (the redirect failed due to a technical error). Present only if the redirect status is `failed`. - `return_url` string, required — The URL you provide to redirect the customer to after they authenticated their payment. - `status` string, required — The status of the redirect, either `pending` (ready to be used by your customer to authenticate the transaction), `succeeded` (successful authentication, cannot be reused) or `not_required` (redirect should not be used) or `failed` (failed authentication, cannot be reused). - `url` string, required — The URL provided to you to redirect a customer to as part of a `redirect` authentication flow. - `sepa_debit` SourceTypeSepaDebit - `bank_code` string, nullable - `branch_code` string, nullable - `country` string, nullable - `fingerprint` string, nullable - `last4` string, nullable - `mandate_reference` string, nullable - `mandate_url` string, nullable - `sofort` SourceTypeSofort - `bank_code` string, nullable - `bank_name` string, nullable - `bic` string, nullable - `country` string, nullable - `iban_last4` string, nullable - `preferred_language` string, nullable - `statement_descriptor` string, nullable - `source_order` SourceOrder - `amount` integer, required — 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 for the order. - `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). - `email` string — The email address of the customer placing the order. - `items` SourceOrderItem[], nullable — List of items constituting the order. - … - `shipping` Shipping - … - `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 - `address_line1_check` string, nullable - `address_zip_check` string, nullable - `authenticated` boolean, nullable - `brand` string, nullable - `card` string, nullable - `country` string, nullable - `customer` string, nullable - `cvc_check` string, nullable - `dynamic_last4` string, nullable - `exp_month` integer, nullable - `exp_year` integer, nullable - `fingerprint` string - `funding` string, nullable - `last4` string, nullable - `name` string, nullable - `three_d_secure` string - `tokenization_method` string, nullable - `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 - `prepay_id` string - `qr_code_url` string, nullable - `statement_descriptor` string - `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 - `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 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. - `active` boolean, required — Whether the promotion code is currently active. A promotion code is only active if the coupon is also valid. - `code` string, required — The customer-facing code. Regardless of case, this code must be unique across all active promotion codes for each customer. Valid characters are lower case letters (a-z), upper case letters (A-Z), digits (0-9), and dashes (-). - `created` integer, required — Time at which the object was created. Measured in seconds since the Unix epoch. - `customer` union — The customer who can use this promotion code. - … - `customer_account` string, nullable — The account representing the customer who can use this promotion code. - `expires_at` integer, nullable — Date at which the promotion code can no longer be redeemed. - `id` string, required — Unique identifier for the object. - `livemode` boolean, required — If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`. - `max_redemptions` integer, nullable — Maximum number of times this promotion code can be redeemed. - `metadata` object, nullable — Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. - `object` 'promotion_code', required — String representing the object's type. Objects of the same type share the same value. - `promotion` PromotionCodesResourcePromotion, required - … - `restrictions` PromotionCodesResourceRestrictions, required - … - `times_redeemed` integer, required — Number of times this promotion code has been used. - `source` DiscountSource, required - `coupon` union — The coupon that was redeemed to create this discount. - 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). - … - `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). - `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 - `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 - object — 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) - … - object — 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) - … - object — `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). - … - `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. - string - Application - … - DeletedApplication - … - `application_fee_percent` number, nullable — A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice total that will be transferred to the application owner's Stripe account. - `automatic_tax` SubscriptionAutomaticTax, required - `disabled_reason` 'requires_location_inputs', nullable — If Stripe disabled automatic tax, this enum describes why. - `enabled` boolean, required — Whether Stripe automatically computes tax on this subscription. - `liability` ConnectAccountReference - … - `billing_cycle_anchor` integer, required — The reference point that aligns future [billing cycle](https://docs.stripe.com/subscriptions/billing-cycle) dates. It sets the day of week for `week` intervals, the day of month for `month` and `year` intervals, and the month of year for `year` intervals. The timestamp is in UTC format. - `billing_cycle_anchor_config` SubscriptionsResourceBillingCycleAnchorConfig - `day_of_month` integer, required — The day of the month of the billing_cycle_anchor. - `hour` integer, nullable — The hour of the day of the billing_cycle_anchor. - `minute` integer, nullable — The minute of the hour of the billing_cycle_anchor. - `month` integer, nullable — The month to start full cycle billing periods. - `second` integer, nullable — The second of the minute of the billing_cycle_anchor. - `billing_mode` SubscriptionsResourceBillingMode, required — The billing mode of the subscription. - `flexible` SubscriptionsResourceBillingModeFlexible - … - `type` 'classic' | 'flexible', required — Controls how prorations and invoices for subscriptions are calculated and orchestrated. - `updated_at` integer — Details on when the current billing_mode was adopted. - `billing_schedules` SubscriptionsResourceBillingSchedules[], required — Billing schedules for this subscription. - `applies_to` SubscriptionsResourceBillingSchedulesAppliesTo[], nullable — Specifies which subscription items the billing schedule applies to. - … - `bill_until` SubscriptionsResourceBillingSchedulesBillUntil, required — Specifies the end of billing period. - … - `key` string, required — Unique identifier for the billing schedule. - `billing_thresholds` SubscriptionBillingThresholds - `amount_gte` integer, nullable — Monetary threshold that triggers the subscription to create an invoice - `reset_billing_cycle_anchor` boolean, nullable — Indicates if the `billing_cycle_anchor` should be reset when a threshold is reached. If true, `billing_cycle_anchor` will be updated to the date/time the threshold was last reached; otherwise, the value will remain unchanged. This value may not be `true` if the subscription contains items with plans that have `aggregate_usage=last_ever`. - `cancel_at` integer, nullable — A date in the future at which the subscription will automatically get canceled - `cancel_at_period_end` boolean, required — Whether this subscription will (if `status=active`) or did (if `status=canceled`) cancel at the end of the current billing period. - `canceled_at` integer, nullable — If the subscription has been canceled, the date of that cancellation. If the subscription was canceled with `cancel_at_period_end`, `canceled_at` will reflect the time of the most recent update request, not the end of the subscription period when the subscription is automatically moved to a canceled state. - `cancellation_details` CancellationDetails - `comment` string, nullable — Additional comments about why the user canceled the subscription, if the subscription was canceled explicitly by the user. - `feedback` 'customer_service' | 'low_quality' | 'missing_features' | 'other' | 'switched_service' | 'too_complex' | 'too_expensive' | 'unused', nullable — The customer submitted reason for why they canceled, if the subscription was canceled explicitly by the user. - `reason` 'canceled_by_retention_policy' | 'cancellation_requested' | 'payment_disputed' | 'payment_failed', nullable — Why this subscription was canceled. - `collection_method` 'charge_automatically' | 'send_invoice', required — Either `charge_automatically`, or `send_invoice`. When charging automatically, Stripe will attempt to pay this subscription at the end of the cycle using the default source attached to the customer. When sending an invoice, Stripe will email your customer an invoice with payment instructions and mark the subscription as `active`. - `created` integer, required — Time at which the object was created. Measured in seconds since the Unix epoch. - `currency` string, currency, required — Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). - `customer` union, required — ID of the customer who owns the subscription. - string - Customer — recursive - DeletedCustomer - … - `customer_account` string, nullable — ID of the account representing the customer who owns the subscription. - `days_until_due` integer, nullable — Number of days a customer has to pay invoices generated by this subscription. This value will be `null` for subscriptions where `collection_method=charge_automatically`. - `default_payment_method` union — ID of the default payment method for the subscription. It must belong to the customer associated with the subscription. This takes precedence over `default_source`. If neither are set, invoices will use the customer's [invoice_settings.default_payment_method](https://docs.stripe.com/api/customers/object#customer_object-invoice_settings-default_payment_method) or [default_source](https://docs.stripe.com/api/customers/object#customer_object-default_source). - string - PaymentMethod — PaymentMethod objects represent your customer's payment instruments. You can use them with [PaymentIntents](https://docs.stripe.com/payments/payment-intents) to collect payments or save them to Customer objects to store instrument details for future payments. Related guides: [Payment Methods](https://docs.stripe.com/payments/payment-methods) and [More Payment Scenarios](https://docs.stripe.com/payments/more-payment-scenarios). - … - `default_source` union — ID of the default payment source for the subscription. It must belong to the customer associated with the subscription and be in a chargeable state. If `default_payment_method` is also set, `default_payment_method` will take precedence. If neither are set, invoices will use the customer's [invoice_settings.default_payment_method](https://docs.stripe.com/api/customers/object#customer_object-invoice_settings-default_payment_method) or [default_source](https://docs.stripe.com/api/customers/object#customer_object-default_source). - string - BankAccount — These bank accounts are payment methods on `Customer` objects. On the other hand [External Accounts](/api#external_accounts) are transfer destinations on `Account` objects for connected accounts. They can be bank accounts or debit cards as well, and are documented in the links above. Related guide: [Bank debits and transfers](/payments/bank-debits-transfers) - … - Card — You can store multiple cards on a customer in order to charge the customer later. You can also store multiple debit cards on a recipient in order to transfer to those cards later. Related guide: [Card payments with Sources](https://docs.stripe.com/sources/cards) - … - Source — `Source` objects allow you to accept a variety of payment methods. They represent a customer's payment instrument, and can be used with the Stripe API just like a `Card` object: once chargeable, they can be charged, or can be attached to customers. Stripe doesn't recommend using the deprecated [Sources API](https://docs.stripe.com/api/sources). We recommend that you adopt the [PaymentMethods API](https://docs.stripe.com/api/payment_methods). This newer API provides access to our latest features and payment method types. Related guides: [Sources API](https://docs.stripe.com/sources) and [Sources & Customers](https://docs.stripe.com/sources/customers). - … - `default_tax_rates` TaxRate[], nullable — The tax rates that will apply to any subscription item that does not have `tax_rates` set. Invoices created will have their `default_tax_rates` populated from the subscription. - `active` boolean, required — Defaults to `true`. When set to `false`, this tax rate cannot be used with new applications or Checkout Sessions, but will still work for subscriptions and invoices that already have it set. - `country` string, nullable — Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)). - `created` integer, required — Time at which the object was created. Measured in seconds since the Unix epoch. - `description` string, nullable — An arbitrary string attached to the tax rate for your internal use only. It will not be visible to your customers. - `display_name` string, required — The display name of the tax rates as it will appear to your customer on their receipt email, PDF, and the hosted invoice page. - `effective_percentage` number, nullable — Actual/effective tax rate percentage out of 100. For tax calculations with automatic_tax[enabled]=true, this percentage reflects the rate actually used to calculate tax based on the product's taxability and whether the user is registered to collect taxes in the corresponding jurisdiction. - `flat_amount` TaxRateFlatAmount — The amount of the tax rate when the `rate_type`` is `flat_amount`. Tax rates with `rate_type` `percentage` can vary based on the transaction, resulting in this field being `null`. This field exposes the amount and currency of the flat tax rate. - … - `id` string, required — Unique identifier for the object. - `inclusive` boolean, required — This specifies if the tax rate is inclusive or exclusive. - `jurisdiction` string, nullable — The jurisdiction for the tax rate. You can use this label field for tax reporting purposes. It also appears on your customer’s invoice. - `jurisdiction_level` 'city' | 'country' | 'county' | 'district' | 'multiple' | 'state', nullable — The level of the jurisdiction that imposes this tax rate. Will be `null` for manually defined tax rates. - `livemode` boolean, required — If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`. - `metadata` object, nullable — Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. - `object` 'tax_rate', required — String representing the object's type. Objects of the same type share the same value. - `percentage` number, required — Tax rate percentage out of 100. For tax calculations with automatic_tax[enabled]=true, this percentage includes the statutory tax rate of non-taxable jurisdictions. - `rate_type` 'flat_amount' | 'percentage', nullable — Indicates the type of tax rate applied to the taxable amount. This value can be `null` when no tax applies to the location. This field is only present for TaxRates created by Stripe Tax. - `state` string, nullable — [ISO 3166-2 subdivision code](https://en.wikipedia.org/wiki/ISO_3166-2), without country prefix. For example, "NY" for New York, United States. - `tax_type` 'amusement_tax' | 'communications_tax' | 'gst' | 'hst' | 'igst' | 'jct' | 'lease_tax' | 'mass_transit_parking_tax' | 'parking_tax' | 'pst' | 'qst' | 'retail_delivery_fee' | 'rst' | 'sales_tax' | 'service_tax' | 'vat', nullable — The high-level tax type, such as `vat` or `sales_tax`. - `description` string, nullable — The subscription's description, meant to be displayable to the customer. Use this field to optionally store an explanation of the subscription for rendering in Stripe surfaces and certain local payment methods UIs. - `discounts` union[], required — The discounts applied to the subscription. Subscription item discounts are applied before subscription discounts. Use `expand[]=discounts` to expand each discount. - union - … - `ended_at` integer, nullable — If the subscription has ended, the date the subscription ended. - `id` string, required — Unique identifier for the object. - `invoice_settings` SubscriptionsResourceSubscriptionInvoiceSettings, required - `account_tax_ids` union[], nullable — The account tax IDs associated with the subscription. Will be set on invoices generated by the subscription. - … - `custom_fields` InvoiceSettingCustomField[], nullable — A list of up to 4 custom fields to be displayed on the invoice. - … - `description` string, nullable — An arbitrary string attached to the object. Often useful for displaying to users. - `footer` string, nullable — Footer to be displayed on the invoice. - `issuer` ConnectAccountReference, required - … - `items` object, required — List of subscription items, each with an attached price. - `data` SubscriptionItem[], required — Details about each object. - … - `has_more` boolean, required — True if this list has another page of items after this one that can be fetched. - `object` 'list', required — String representing the object's type. Objects of the same type share the same value. Always has the value `list`. - `url` string, required — The URL where this list can be accessed. - `latest_invoice` union — The most recent invoice this subscription has generated over its lifecycle (for example, when it cycles or is updated). - string - Invoice — Invoices are statements of amounts owed by a customer, and are either generated one-off, or generated periodically from a subscription. They contain [invoice items](https://api.stripe.com#invoiceitems), and proration adjustments that may be caused by subscription upgrades/downgrades (if necessary). If your invoice is configured to be billed through automatic charges, Stripe automatically finalizes your invoice and attempts payment. Note that finalizing the invoice, [when automatic](https://docs.stripe.com/invoicing/integration/automatic-advancement-collection), does not happen immediately as the invoice is created. Stripe waits until one hour after the last webhook was successfully sent (or the last webhook timed out after failing). If you (and the platforms you may have connected to) have no webhooks configured, Stripe waits one hour after creation to finalize the invoice. If your invoice is configured to be billed by sending an email, then based on your [email settings](https://dashboard.stripe.com/account/billing/automatic), Stripe will email the invoice to your customer and await payment. These emails can contain a link to a hosted page to pay the invoice. Stripe applies any customer credit on the account before determining the amount due for the invoice (i.e., the amount that will be actually charged). If the amount due for the invoice is less than Stripe's [minimum allowed charge per currency](/docs/currencies#minimum-and-maximum-charge-amounts), the invoice is automatically marked paid, and we add the amount due to the customer's credit balance which is applied to the next invoice. More details on the customer's credit balance are [here](https://docs.stripe.com/billing/customer/balance). Related guide: [Send invoices to customers](https://docs.stripe.com/billing/invoices/sending) - … - `livemode` boolean, required — If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`. - `managed_payments` SmorResourceManagedPayments - `enabled` boolean, required — Set to `true` to enable [Managed Payments](https://docs.stripe.com/payments/managed-payments), Stripe's merchant of record solution, for this session. - `metadata` object, required — Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. - `next_pending_invoice_item_invoice` integer, nullable — Specifies the approximate timestamp on which any pending invoice items will be billed according to the schedule provided at `pending_invoice_item_interval`. - `object` 'subscription', required — String representing the object's type. Objects of the same type share the same value. - `on_behalf_of` union — The account (if any) the charge was made on behalf of for charges associated with this subscription. See the [Connect documentation](https://docs.stripe.com/connect/subscriptions#on-behalf-of) for details. - string - Account — For new integrations, we recommend using the [Accounts v2 API](/api/v2/core/accounts), in place of /v1/accounts and /v1/customers to represent a user. This is an object representing a Stripe account. You can retrieve it to see properties on the account like its current requirements or if the account is enabled to make live charges or receive payouts. For accounts where [controller.requirement_collection](/api/accounts/object#account_object-controller-requirement_collection) is `application`, which includes Custom accounts, the properties below are always returned. For accounts where [controller.requirement_collection](/api/accounts/object#account_object-controller-requirement_collection) is `stripe`, which includes Standard and Express accounts, some properties are only returned until you create an [Account Link](/api/account_links) or [Account Session](/api/account_sessions) to start Connect Onboarding. Learn about the [differences between accounts](/connect/accounts). - … - `pause_collection` SubscriptionsResourcePauseCollection — The Pause Collection settings determine how we will pause collection for this subscription and for how long the subscription should be paused. - `behavior` 'keep_as_draft' | 'mark_uncollectible' | 'void', required — The payment collection behavior for this subscription while paused. - `resumes_at` integer, nullable — The time after which the subscription will resume collecting payments. - `payment_settings` SubscriptionsResourcePaymentSettings - `payment_method_options` SubscriptionsResourcePaymentMethodOptions - … - `payment_method_types` string[], nullable — The list of payment method types to provide to every invoice created by the subscription. If not set, Stripe attempts to automatically determine the types to use by looking at the invoice’s default payment method, the subscription’s default payment method, the customer’s default payment method, and your [invoice template settings](https://dashboard.stripe.com/settings/billing/invoice). - `save_default_payment_method` 'off' | 'on_subscription', nullable — Configure whether Stripe updates `subscription.default_payment_method` when payment succeeds. Defaults to `off`. - `pending_invoice_item_interval` SubscriptionPendingInvoiceItemInterval - `interval` 'day' | 'month' | 'week' | 'year', required — Specifies invoicing frequency. Either `day`, `week`, `month` or `year`. - `interval_count` integer, required — The number of intervals between invoices. For example, `interval=month` and `interval_count=3` bills every 3 months. Maximum of one year interval allowed (1 year, 12 months, or 52 weeks). - `pending_setup_intent` union — You can use this [SetupIntent](https://docs.stripe.com/api/setup_intents) to collect user authentication when creating a subscription without immediate payment or updating a subscription's payment method, allowing you to optimize for off-session payments. Learn more in the [SCA Migration Guide](https://docs.stripe.com/billing/migration/strong-customer-authentication#scenario-2). - string - SetupIntent — A SetupIntent guides you through the process of setting up and saving a customer's payment credentials for future payments. For example, you can use a SetupIntent to set up and save your customer's card without immediately collecting a payment. Later, you can use [PaymentIntents](https://api.stripe.com#payment_intents) to drive the payment flow. Create a SetupIntent when you're ready to collect your customer's payment credentials. Don't maintain long-lived, unconfirmed SetupIntents because they might not be valid. The SetupIntent transitions through multiple [statuses](https://docs.stripe.com/payments/intents#intent-statuses) as it guides you through the setup process. Successful SetupIntents result in payment credentials that are optimized for future payments. For example, cardholders in [certain regions](https://stripe.com/guides/strong-customer-authentication) might need to be run through [Strong Customer Authentication](https://docs.stripe.com/strong-customer-authentication) during payment method collection to streamline later [off-session payments](https://docs.stripe.com/payments/setup-intents). If you use the SetupIntent with a [Customer](https://api.stripe.com#setup_intent_object-customer), it automatically attaches the resulting payment method to that Customer after successful setup. We recommend using SetupIntents or [setup_future_usage](https://api.stripe.com#payment_intent_object-setup_future_usage) on PaymentIntents to save payment methods to prevent saving invalid or unoptimized payment methods. By using SetupIntents, you can reduce friction for your customers, even as regulations change over time. Related guide: [Setup Intents API](https://docs.stripe.com/payments/setup-intents) - … - `pending_update` SubscriptionsResourcePendingUpdate — Pending Updates store the changes pending from a previous update that will be applied to the Subscription upon successful payment. - `billing_cycle_anchor` integer, nullable — If the update is applied, determines the date of the first full invoice, and, for plans with `month` or `year` intervals, the day of the month for subsequent invoices. The timestamp is in UTC format. - `discount` Discount — A discount represents the actual application of a [coupon](https://api.stripe.com#coupons) or [promotion code](https://api.stripe.com#promotion_codes). It contains information about when the discount began, when it will end, and what it is applied to. Related guide: [Applying discounts to subscriptions](https://docs.stripe.com/billing/subscriptions/discounts) - … - `discounts` union[], nullable — The discounts that will be applied to the subscription when the pending update is applied. Use `expand[]=discounts` to expand each discount. - … - `expires_at` integer, required — The point after which the changes reflected by this update will be discarded and no longer applied. - `metadata` object, nullable — Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. - `subscription_items` SubscriptionItem[], nullable — List of subscription items, each with an attached plan, that will be set if the update is applied. - … - `trial_end` integer, nullable — Unix timestamp representing the end of the trial period the customer will get before being charged for the first time, if the update is applied. - `trial_from_plan` boolean, nullable — Indicates if a plan's `trial_period_days` should be applied to the subscription. Setting `trial_end` per subscription is preferred, and this defaults to `false`. Setting this flag to `true` together with `trial_end` is not allowed. See [Using trial periods on subscriptions](https://docs.stripe.com/billing/subscriptions/trials) to learn more. - `presentment_details` SubscriptionsResourceSubscriptionPresentmentDetails - `presentment_currency` string, required — Currency used for customer payments. - `schedule` union — The schedule attached to the subscription - string - SubscriptionSchedule — A subscription schedule allows you to create and manage the lifecycle of a subscription by predefining expected changes. Related guide: [Subscription schedules](https://docs.stripe.com/billing/subscriptions/subscription-schedules) - … - `start_date` integer, required — Date when the subscription was first created. The date might differ from the `created` date due to backdating. - `status` 'active' | 'canceled' | 'incomplete' | 'incomplete_expired' | 'past_due' | 'paused' | 'trialing' | 'unpaid', required — Possible values are `incomplete`, `incomplete_expired`, `trialing`, `active`, `past_due`, `canceled`, `unpaid`, or `paused`. For `collection_method=charge_automatically` a subscription moves into `incomplete` if the initial payment attempt fails. A subscription in this status can only have metadata and default_source updated. Once the first invoice is paid, the subscription moves into an `active` status. If the first invoice is not paid within 23 hours, the subscription transitions to `incomplete_expired`. This is a terminal status, the open invoice will be voided and no further invoices will be generated. A subscription that is currently in a trial period is `trialing` and moves to `active` when the trial period is over. A subscription can only enter a `paused` status [when a trial ends without a payment method](https://docs.stripe.com/billing/subscriptions/trials#create-free-trials-without-payment). A `paused` subscription doesn't generate invoices and can be resumed after your customer adds their payment method. The `paused` status is different from [pausing collection](https://docs.stripe.com/billing/subscriptions/pause-payment), which still generates invoices and leaves the subscription's status unchanged. If subscription `collection_method=charge_automatically`, it becomes `past_due` when payment is required but cannot be paid (due to failed payment or awaiting additional user actions). Once Stripe has exhausted all payment retry attempts, the subscription will become `canceled` or `unpaid` (depending on your subscriptions settings). If subscription `collection_method=send_invoice` it becomes `past_due` when its invoice is not paid by the due date, and `canceled` or `unpaid` if it is still not paid by an additional deadline after that. Note that when a subscription has a status of `unpaid`, no subsequent invoices will be attempted (invoices will be created, but then immediately automatically closed). After receiving updated payment information from a customer, you may choose to reopen and pay their closed invoices. - `test_clock` union — ID of the test clock this subscription belongs to. - string - TestHelpersTestClock — A test clock enables deterministic control over objects in testmode. With a test clock, you can create objects at a frozen time in the past or future, and advance to a specific future time to observe webhooks and state changes. After the clock advances, you can either validate the current state of your scenario (and test your assumptions), change the current state of your scenario (and test more complex scenarios), or keep advancing forward in time. - … - `transfer_data` SubscriptionTransferData - `amount_percent` number, nullable — A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice total that will be transferred to the destination account. By default, the entire amount is transferred to the destination. - `destination` union, required — The account where funds from the payment will be transferred to upon payment success. - … - `trial_end` integer, nullable — If the subscription has a trial, the end of that trial. - `trial_settings` SubscriptionsResourceTrialSettingsTrialSettings — Configures how this subscription behaves during the trial period. - `end_behavior` SubscriptionsResourceTrialSettingsEndBehavior, required — Defines how a subscription behaves when a trial ends. - … - `trial_start` integer, nullable — If the subscription has a trial, the beginning of that trial. - `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. - string - Customer — recursive - `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 - `account` union — The account being referenced when `type` is `account`. - … - `application` union — The Connect Application being referenced when `type` is `application`. - … - `customer` union — The customer being referenced when `type` is `customer`. - … - `customer_account` string, nullable — The Account representing the customer being referenced when `type` is `customer`. - `type` 'account' | 'application' | 'customer' | 'self', required — Type of owner referenced. - `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 - `status` 'pending' | 'unavailable' | 'unverified' | 'verified', required — Verification status, one of `pending`, `verified`, `unverified`, or `unavailable`. - `verified_address` string, nullable — Verified address. - `verified_name` string, nullable — Verified name. - `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 - `advancing` BillingClocksResourceStatusDetailsAdvancingStatusDetails - … - 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 to bill for this invoice item. - `date` 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 object. Often useful for displaying to users. - `discountable` boolean, required — If true, discounts will apply to this invoice item. Always false for prorations. - `discounts` union[], nullable — The discounts which apply to the invoice item. 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) - `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 — 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 — recursive - `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 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. - `active` boolean, required — Whether the promotion code is currently active. A promotion code is only active if the coupon is also valid. - `code` string, required — The customer-facing code. Regardless of case, this code must be unique across all active promotion codes for each customer. Valid characters are lower case letters (a-z), upper case letters (A-Z), digits (0-9), and dashes (-). - `created` integer, required — Time at which the object was created. Measured in seconds since the Unix epoch. - `customer` union — The customer who can use this promotion code. - … - `customer_account` string, nullable — The account representing the customer who can use this promotion code. - `expires_at` integer, nullable — Date at which the promotion code can no longer be redeemed. - `id` string, required — Unique identifier for the object. - `livemode` boolean, required — If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`. - `max_redemptions` integer, nullable — Maximum number of times this promotion code can be redeemed. - `metadata` object, nullable — Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. - `object` 'promotion_code', required — String representing the object's type. Objects of the same type share the same value. - `promotion` PromotionCodesResourcePromotion, required - … - `restrictions` PromotionCodesResourceRestrictions, required - … - `times_redeemed` integer, required — Number of times this promotion code has been used. - `source` DiscountSource, required - `coupon` union — The coupon that was redeemed to create this discount. - 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). - … - `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. - `id` string, required — Unique identifier for the object. - `invoice` union — The ID of the invoice this invoice item belongs to. - 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) - `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 - … - DeletedTaxId - `deleted` true, required — Always true for a deleted object - `id` string, required — Unique identifier for the object. - `object` 'tax_id', required — String representing the object's type. Objects of the same type share the same value. - `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`. - string - Account — For new integrations, we recommend using the [Accounts v2 API](/api/v2/core/accounts), in place of /v1/accounts and /v1/customers to represent a user. This is an object representing a Stripe account. You can retrieve it to see properties on the account like its current requirements or if the account is enabled to make live charges or receive payouts. For accounts where [controller.requirement_collection](/api/accounts/object#account_object-controller-requirement_collection) is `application`, which includes Custom accounts, the properties below are always returned. For accounts where [controller.requirement_collection](/api/accounts/object#account_object-controller-requirement_collection) is `stripe`, which includes Standard and Express accounts, some properties are only returned until you create an [Account Link](/api/account_links) or [Account Session](/api/account_sessions) to start Connect Onboarding. Learn about the [differences between accounts](/connect/accounts). - … - `type` 'account' | 'self', required — Type of the account referenced. - `provider` string, nullable — The tax provider powering automatic tax. - `status` 'complete' | 'failed' | 'requires_location_inputs', nullable — The status of the most recent automated tax calculation for this 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 - `city` string, nullable — City, district, suburb, town, or village. - `country` string, nullable — Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)). - `line1` string, nullable — Address line 1, such as the street, PO Box, or company name. - `line2` string, nullable — Address line 2, such as the apartment, suite, unit, or building. - `postal_code` string, nullable — ZIP or postal code. - `state` string, nullable — State, county, province, or region ([ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2)). - `balance` integer — The current balance, if any, that's stored on the customer in their default currency. If negative, the customer has credit to apply to their next invoice. If positive, the customer has an amount owed that's added to their next invoice. The balance only considers amounts that Stripe hasn't successfully applied to any invoice. It doesn't reflect unpaid invoices. This balance is only taken into account after invoices finalize. For multi-currency balances, see [invoice_credit_balance](https://docs.stripe.com/api/customers/object#customer_object-invoice_credit_balance). - `business_name` string — The customer's business name. - `cash_balance` CashBalance — A customer's `Cash balance` represents real funds. Customers can add funds to their cash balance by sending a bank transfer. These funds can be used for payment and can eventually be paid out to your bank account. - `available` object, nullable — A hash of all cash balances available to this customer. You cannot delete a customer with any cash balances, even if the balance is 0. Amounts are represented in the [smallest currency unit](https://docs.stripe.com/currencies#zero-decimal). - `customer` string, required — The ID of the customer whose cash balance this object represents. - `customer_account` string, nullable — The ID of an Account representing a customer whose cash balance this object represents. - `livemode` boolean, required — If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`. - `object` 'cash_balance', required — String representing the object's type. Objects of the same type share the same value. - `settings` CustomerBalanceCustomerBalanceSettings, required - … - `created` integer, required — Time at which the object was created. Measured in seconds since the Unix epoch. - `currency` string, nullable — Three-letter [ISO code for the currency](https://stripe.com/docs/currencies) the customer can be charged in for recurring billing purposes. - `customer_account` string, nullable — The ID of an Account representing a customer. You can use this ID with any v1 API that accepts a customer_account parameter. - `default_source` union — ID of the default payment source for the customer. If you use payment methods created through the PaymentMethods API, see the [invoice_settings.default_payment_method](https://docs.stripe.com/api/customers/object#customer_object-invoice_settings-default_payment_method) field instead. - string - BankAccount — These bank accounts are payment methods on `Customer` objects. On the other hand [External Accounts](/api#external_accounts) are transfer destinations on `Account` objects for connected accounts. They can be bank accounts or debit cards as well, and are documented in the links above. Related guide: [Bank debits and transfers](/payments/bank-debits-transfers) - … - Card — You can store multiple cards on a customer in order to charge the customer later. You can also store multiple debit cards on a recipient in order to transfer to those cards later. Related guide: [Card payments with Sources](https://docs.stripe.com/sources/cards) - … - Source — `Source` objects allow you to accept a variety of payment methods. They represent a customer's payment instrument, and can be used with the Stripe API just like a `Card` object: once chargeable, they can be charged, or can be attached to customers. Stripe doesn't recommend using the deprecated [Sources API](https://docs.stripe.com/api/sources). We recommend that you adopt the [PaymentMethods API](https://docs.stripe.com/api/payment_methods). This newer API provides access to our latest features and payment method types. Related guides: [Sources API](https://docs.stripe.com/sources) and [Sources & Customers](https://docs.stripe.com/sources/customers). - … - `delinquent` boolean, nullable — Tracks the most recent state change on any invoice belonging to the customer. Paying an invoice or marking it uncollectible via the API will set this field to false. An automatic payment failure or passing the `invoice.due_date` will set this field to `true`. If an invoice becomes uncollectible by [dunning](https://docs.stripe.com/billing/automatic-collection), `delinquent` doesn't reset to `false`. If you care whether the customer has paid their most recent subscription invoice, use `subscription.status` instead. Paying or marking uncollectible any customer invoice regardless of whether it is the latest invoice for a subscription will always set this field to `false`. - `description` string, nullable — An arbitrary string attached to the object. Often useful for displaying to users. - `discount` Discount — A discount represents the actual application of a [coupon](https://api.stripe.com#coupons) or [promotion code](https://api.stripe.com#promotion_codes). It contains information about when the discount began, when it will end, and what it is applied to. Related guide: [Applying discounts to subscriptions](https://docs.stripe.com/billing/subscriptions/discounts) - `checkout_session` string, nullable — The Checkout session that this coupon is applied to, if it is applied to a particular session in payment mode. Not present for subscription mode. - `customer` union — The ID of the customer associated with this discount. - … - `customer_account` string, nullable — The ID of the account representing the customer associated with this discount. - `end` integer, nullable — If the coupon has a duration of `repeating`, the date that this discount will end. If the coupon has a duration of `once` or `forever`, this attribute will be null. - `id` string, required — The ID of the discount object. Discounts can't be fetched by ID. Use `expand[]=discounts` in API calls to expand discount IDs in an array. - `invoice` string, nullable — The invoice that the discount's coupon was applied to, if it was applied directly to a particular invoice. - `invoice_item` string, nullable — The invoice item `id` (or invoice line item `id` for invoice line items of type='subscription') that the discount's coupon was applied to, if it was applied directly to a particular invoice item or invoice line item. - `object` 'discount', required — String representing the object's type. Objects of the same type share the same value. - `promotion_code` union — The promotion code applied to create this discount. - … - `source` DiscountSource, required - … - `start` integer, required — Date that the coupon was applied. - `subscription` string, nullable — The subscription that this coupon is applied to, if it is applied to a particular subscription. - `subscription_item` string, nullable — The subscription item that this coupon is applied to, if it is applied to a particular subscription item. - `email` string, nullable — The customer's email address. - `id` string, required — Unique identifier for the object. - `individual_name` string — The customer's individual name. - `invoice_credit_balance` object — The current multi-currency balances, if any, that's stored on the customer. If positive in a currency, the customer has a credit to apply to their next invoice denominated in that currency. If negative, the customer has an amount owed that's added to their next invoice denominated in that currency. These balances don't apply to unpaid invoices. They solely track amounts that Stripe hasn't successfully applied to any invoice. Stripe only applies a balance in a specific currency to an invoice after that invoice (which is in the same currency) finalizes. - `invoice_prefix` string, nullable — The prefix for the customer used to generate unique invoice numbers. - `invoice_settings` InvoiceSettingCustomerSetting - `custom_fields` InvoiceSettingCustomField[], nullable — Default custom fields to be displayed on invoices for this customer. - … - `default_payment_method` union — ID of a payment method that's attached to the customer, to be used as the customer's default payment method for subscriptions and invoices. - … - `footer` string, nullable — Default footer to be displayed on invoices for this customer. - `rendering_options` InvoiceSettingCustomerRenderingOptions - … - `livemode` boolean, required — If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`. - `metadata` object — Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. - `name` string, nullable — The customer's full name or business name. - `next_invoice_sequence` integer — The suffix of the customer's next invoice number (for example, 0001). When the account uses account level sequencing, this parameter is ignored in API requests and the field omitted in API responses. - `object` 'customer', required — String representing the object's type. Objects of the same type share the same value. - `phone` string, nullable — The customer's phone number. - `preferred_locales` string[], nullable — The customer's preferred locales (languages), ordered by preference. - `shipping` Shipping - `address` Address - … - `carrier` string, nullable — The delivery service that shipped a physical product, such as Fedex, UPS, USPS, etc. - `name` string — Recipient name. - `phone` string, nullable — Recipient phone (including extension). - `tracking_number` string, nullable — The tracking number for a physical product, obtained from the delivery service. If multiple tracking numbers were generated for this purchase, please separate them with commas. - `sources` object — The customer's payment sources, if any. - `data` union[], required — Details about each object. - … - `has_more` boolean, required — True if this list has another page of items after this one that can be fetched. - `object` 'list', required — String representing the object's type. Objects of the same type share the same value. Always has the value `list`. - `url` string, required — The URL where this list can be accessed. - `subscriptions` object — The customer's current subscriptions, if any. - `data` Subscription[], required — Details about each object. - … - `has_more` boolean, required — True if this list has another page of items after this one that can be fetched. - `object` 'list', required — String representing the object's type. Objects of the same type share the same value. Always has the value `list`. - `url` string, required — The URL where this list can be accessed. - `tax` CustomerTax - `automatic_tax` 'failed' | 'not_collecting' | 'supported' | 'unrecognized_location', required — Surfaces if automatic tax computation is possible given the current customer location information. - `ip_address` string, nullable — A recent IP address of the customer used for tax reporting and tax location inference. - `location` CustomerTaxLocation - … - `provider` 'anrok' | 'avalara' | 'sphere' | 'stripe', required — The tax calculation provider used for location resolution. Defaults to `stripe` when not using a [third-party provider](/tax/third-party-apps). - `tax_exempt` 'exempt' | 'none' | 'reverse', nullable — Describes the customer's tax exemption status, which is `none`, `exempt`, or `reverse`. When set to `reverse`, invoice and receipt PDFs include the following text: **"Reverse charge"**. - `tax_ids` object — The customer's tax IDs. - `data` TaxId[], required — Details about each object. - … - `has_more` boolean, required — True if this list has another page of items after this one that can be fetched. - `object` 'list', required — String representing the object's type. Objects of the same type share the same value. Always has the value `list`. - `url` string, required — The URL where this list can be accessed. - `test_clock` union — ID of the test clock that this customer belongs to. - string - TestHelpersTestClock — A test clock enables deterministic control over objects in testmode. With a test clock, you can create objects at a frozen time in the past or future, and advance to a specific future time to observe webhooks and state changes. After the clock advances, you can either validate the current state of your scenario (and test your assumptions), change the current state of your scenario (and test more complex scenarios), or keep advancing forward in time. - … - DeletedCustomer - `deleted` true, required — Always true for a deleted object - `id` string, required — Unique identifier for the object. - `object` 'customer', required — String representing the object's type. Objects of the same type share the same value. - `customer_account` string, nullable — The ID of the account 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 - `bank_name` string, nullable — Name of the bank associated with the bank account. - `fingerprint` string, nullable — Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same. - `institution_number` string, nullable — Institution number of the bank account. - `last4` string, nullable — Last four digits of the bank account number. - `transit_number` string, nullable — Transit number of the bank account. - `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 - `bsb_number` string, nullable — Six-digit number identifying bank and branch associated with this bank account. - `fingerprint` string, nullable — Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same. - `last4` string, nullable — Last four digits of the bank account number. - `bacs_debit` PaymentMethodBacsDebit - `fingerprint` string, nullable — Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same. - `last4` string, nullable — Last four digits of the bank account number. - `sort_code` string, nullable — Sort code of the bank account. (e.g., `10-20-30`) - `bancontact` PaymentMethodBancontact - `billie` PaymentMethodBillie - `billing_details` BillingDetails, required - `address` Address - … - `email` string, nullable — Email address. - `name` string, nullable — Full name. - `phone` string, nullable — Billing phone number (including extension). - `tax_id` string, nullable — Taxpayer identification number. Used only for transactions between LATAM buyers and non-LATAM sellers. - `bizum` PaymentMethodBizum - `buyer_id` string, nullable — A unique identifier for the buyer as determined by the local payment processor. - `blik` PaymentMethodBlik - `buyer_id` string, nullable — A unique and immutable identifier assigned by BLIK to every buyer. - `boleto` PaymentMethodBoleto - `tax_id` string, required — Uniquely identifies the customer tax id (CNPJ or CPF) - `card` PaymentMethodCard - `brand` string, required — Card brand. Can be `amex`, `cartes_bancaires`, `diners`, `discover`, `eftpos_au`, `jcb`, `link`, `mastercard`, `unionpay`, `visa` or `unknown`. - `checks` PaymentMethodCardChecks - … - `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. - `display_brand` string, nullable — The brand to use when displaying the card, this accounts for customer's brand choice on dual-branded cards. Can be `american_express`, `cartes_bancaires`, `diners_club`, `discover`, `eftpos_australia`, `interac`, `jcb`, `mastercard`, `union_pay`, `visa`, or `other` and may contain more values in the future. - `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`. - `generated_from` PaymentMethodCardGeneratedCard - … - `last4` string, required — The last four digits of the card. - `networks` Networks - … - `regulated_status` 'regulated' | 'unregulated', nullable — Status of a card based on the card issuer. - `three_d_secure_usage` ThreeDSecureUsage - … - `wallet` PaymentMethodCardWallet - … - `card_present` PaymentMethodCardPresent - `brand` string, nullable — Card brand. Can be `amex`, `cartes_bancaires`, `diners`, `discover`, `eftpos_au`, `jcb`, `link`, `mastercard`, `unionpay`, `visa` or `unknown`. - `brand_product` string, nullable — The [product code](https://stripe.com/docs/card-product-codes) that identifies the specific program or product associated with a card. - `cardholder_name` string, nullable — The cardholder name as read from the card, in [ISO 7813](https://en.wikipedia.org/wiki/ISO/IEC_7813) format. May include alphanumeric characters, special characters and first/last name separator (`/`). In some cases, the cardholder name may not be available depending on how the issuer has configured the card. Cardholder name is typically not available on swipe or contactless payments, such as those made with Apple Pay and Google Pay. - `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. - `description` string, nullable — A high-level description of the type of cards issued in this range. - `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, nullable — Card funding type. Can be `credit`, `debit`, `prepaid`, or `unknown`. - `issuer` string, nullable — The name of the card's issuing bank. - `last4` string, nullable — The last four digits of the card. - `networks` PaymentMethodCardPresentNetworks - … - `offline` PaymentMethodDetailsCardPresentOffline - … - `preferred_locales` string[], nullable — The languages that the issuing bank recommends using for localizing any customer-facing text, as read from the card. Referenced from EMV tag 5F2D, data encoded on the card's chip. - `read_method` 'contact_emv' | 'contactless_emv' | 'contactless_magstripe_mode' | 'magnetic_stripe_fallback' | 'magnetic_stripe_track2', nullable — How card details were read in this transaction. - `wallet` PaymentFlowsPrivatePaymentMethodsCardPresentCommonWallet - … - `cashapp` PaymentMethodCashapp - `buyer_id` string, nullable — A unique and immutable identifier assigned by Cash App to every buyer. - `cashtag` string, nullable — A public identifier for buyers using Cash App. - `created` integer, required — Time at which the object was created. Measured in seconds since the Unix epoch. - `crypto` PaymentMethodCrypto - `custom` PaymentMethodCustom - `display_name` string, nullable — Display name of the Dashboard-only CustomPaymentMethodType. - `logo` CustomLogo - … - `type` string, required — ID of the Dashboard-only CustomPaymentMethodType. Not expandable. - `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. - 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. - … - `customer_account` string, nullable - `customer_balance` PaymentMethodCustomerBalance - `eps` PaymentMethodEps - `bank` 'arzte_und_apotheker_bank' | 'austrian_anadi_bank_ag' | 'bank_austria' | 'bankhaus_carl_spangler' | 'bankhaus_schelhammer_und_schattera_ag' | 'bawag_psk_ag' | 'bks_bank_ag' | 'brull_kallmus_bank_ag' | 'btv_vier_lander_bank' | 'capital_bank_grawe_gruppe_ag' | 'deutsche_bank_ag' | 'dolomitenbank' | 'easybank_ag' | 'erste_bank_und_sparkassen' | 'hypo_alpeadriabank_international_ag' | 'hypo_bank_burgenland_aktiengesellschaft' | 'hypo_noe_lb_fur_niederosterreich_u_wien' | 'hypo_oberosterreich_salzburg_steiermark' | 'hypo_tirol_bank_ag' | 'hypo_vorarlberg_bank_ag' | 'marchfelder_bank' | 'oberbank_ag' | 'raiffeisen_bankengruppe_osterreich' | 'schoellerbank_ag' | 'sparda_bank_wien' | 'volksbank_gruppe' | 'volkskreditbank_ag' | 'vr_bank_braunau', nullable — The customer's bank. Should be one of `arzte_und_apotheker_bank`, `austrian_anadi_bank_ag`, `bank_austria`, `bankhaus_carl_spangler`, `bankhaus_schelhammer_und_schattera_ag`, `bawag_psk_ag`, `bks_bank_ag`, `brull_kallmus_bank_ag`, `btv_vier_lander_bank`, `capital_bank_grawe_gruppe_ag`, `deutsche_bank_ag`, `dolomitenbank`, `easybank_ag`, `erste_bank_und_sparkassen`, `hypo_alpeadriabank_international_ag`, `hypo_noe_lb_fur_niederosterreich_u_wien`, `hypo_oberosterreich_salzburg_steiermark`, `hypo_tirol_bank_ag`, `hypo_vorarlberg_bank_ag`, `hypo_bank_burgenland_aktiengesellschaft`, `marchfelder_bank`, `oberbank_ag`, `raiffeisen_bankengruppe_osterreich`, `schoellerbank_ag`, `sparda_bank_wien`, `volksbank_gruppe`, `volkskreditbank_ag`, or `vr_bank_braunau`. - `fpx` PaymentMethodFpx - `bank` 'affin_bank' | 'agrobank' | 'alliance_bank' | 'ambank' | 'bank_islam' | 'bank_muamalat' | 'bank_of_china' | 'bank_rakyat' | 'bnp_paribas' | 'bsn' | 'cimb' | 'citibank' | 'deutsche_bank' | 'hong_leong_bank' | 'hsbc' | 'kfh' | 'maybank2e' | 'maybank2u' | 'mbsb_bank' | 'ocbc' | 'pb_enterprise' | 'public_bank' | 'rhb' | 'standard_chartered' | 'uob', required — The customer's bank, if provided. Can be one of `affin_bank`, `agrobank`, `alliance_bank`, `ambank`, `bank_islam`, `bank_muamalat`, `bnp_paribas`, `bank_rakyat`, `bsn`, `cimb`, `citibank`, `hong_leong_bank`, `hsbc`, `kfh`, `maybank2u`, `ocbc`, `public_bank`, `rhb`, `standard_chartered`, `uob`, `deutsche_bank`, `maybank2e`, `mbsb_bank`, `pb_enterprise`, or `bank_of_china`. - `giropay` PaymentMethodGiropay - `grabpay` PaymentMethodGrabpay - `id` string, required — Unique identifier for the object. - `ideal` PaymentMethodIdeal - `bank` 'abn_amro' | 'adyen' | 'asn_bank' | 'bunq' | 'buut' | 'finom' | 'handelsbanken' | 'ing' | 'knab' | 'mollie' | 'moneyou' | 'n26' | 'nn' | 'rabobank' | 'regiobank' | 'revolut' | 'sns_bank' | 'triodos_bank' | 'van_lanschot' | 'yoursafe', nullable — The customer's bank, if provided. Can be one of `abn_amro`, `adyen`, `asn_bank`, `bunq`, `buut`, `finom`, `handelsbanken`, `ing`, `knab`, `mollie`, `moneyou`, `n26`, `nn`, `rabobank`, `regiobank`, `revolut`, `sns_bank`, `triodos_bank`, `van_lanschot`, or `yoursafe`. - `bic` 'ABNANL2A' | 'ADYBNL2A' | 'ASNBNL21' | 'BITSNL2A' | 'BUNQNL2A' | 'BUUTNL2A' | 'FNOMNL22' | 'FVLBNL22' | 'HANDNL2A' | 'INGBNL2A' | 'KNABNL2H' | 'MLLENL2A' | 'MOYONL21' | 'NNBANL2G' | 'NTSBDEB1' | 'RABONL2U' | 'RBRBNL21' | 'REVOIE23' | 'REVOLT21' | 'SNSBNL2A' | 'TRIONL2U', nullable — The Bank Identifier Code of the customer's bank, if the bank was provided. - `interac_present` PaymentMethodInteracPresent - `brand` string, nullable — Card brand. Can be `interac`, `mastercard` or `visa`. - `cardholder_name` string, nullable — The cardholder name as read from the card, in [ISO 7813](https://en.wikipedia.org/wiki/ISO/IEC_7813) format. May include alphanumeric characters, special characters and first/last name separator (`/`). In some cases, the cardholder name may not be available depending on how the issuer has configured the card. Cardholder name is typically not available on swipe or contactless payments, such as those made with Apple Pay and Google Pay. - `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. - `description` string, nullable — A high-level description of the type of cards issued in this range. - `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, nullable — Card funding type. Can be `credit`, `debit`, `prepaid`, or `unknown`. - `issuer` string, nullable — The name of the card's issuing bank. - `last4` string, nullable — The last four digits of the card. - `networks` PaymentMethodCardPresentNetworks - … - `preferred_locales` string[], nullable — The languages that the issuing bank recommends using for localizing any customer-facing text, as read from the card. Referenced from EMV tag 5F2D, data encoded on the card's chip. - `read_method` 'contact_emv' | 'contactless_emv' | 'contactless_magstripe_mode' | 'magnetic_stripe_fallback' | 'magnetic_stripe_track2', nullable — How card details were read in this transaction. - `kakao_pay` PaymentMethodKakaoPay - `klarna` PaymentMethodKlarna - `dob` PaymentFlowsPrivatePaymentMethodsKlarnaDob - … - `konbini` PaymentMethodKonbini - `kr_card` PaymentMethodKrCard - `brand` 'bc' | 'citi' | 'hana' | 'hyundai' | 'jeju' | 'jeonbuk' | 'kakaobank' | 'kbank' | 'kdbbank' | 'kookmin' | 'kwangju' | 'lotte' | 'mg' | 'nh' | 'post' | 'samsung' | 'savingsbank' | 'shinhan' | 'shinhyup' | 'suhyup' | 'tossbank' | 'woori', nullable — The local credit or debit card brand. - `last4` string, nullable — The last four digits of the card. This may not be present for American Express cards. - `link` PaymentMethodLink - `email` string, nullable — Account owner's email address. - `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 - `buyer_id` string, nullable — Uniquely identifies this particular Naver Pay account. You can use this attribute to check whether two Naver Pay accounts are the same. - `funding` 'card' | 'points', required — Whether to fund this transaction with Naver Pay points or a card. - `nz_bank_account` PaymentMethodNzBankAccount - `account_holder_name` string, nullable — The name on the bank account. Only present if the account holder name is different from the name of the authorized signatory collected in the PaymentMethod’s billing details. - `bank_code` string, required — The numeric code for the bank account's bank. - `bank_name` string, required — The name of the bank. - `branch_code` string, required — The numeric code for the bank account's bank branch. - `last4` string, required — Last four digits of the bank account number. - `suffix` string, nullable — The suffix of the bank account number. - `object` 'payment_method', required — String representing the object's type. Objects of the same type share the same value. - `oxxo` PaymentMethodOxxo - `p24` PaymentMethodP24 - `bank` 'alior_bank' | 'bank_millennium' | 'bank_nowy_bfg_sa' | 'bank_pekao_sa' | 'banki_spbdzielcze' | 'blik' | 'bnp_paribas' | 'boz' | 'citi_handlowy' | 'credit_agricole' | 'envelobank' | 'etransfer_pocztowy24' | 'getin_bank' | 'ideabank' | 'ing' | 'inteligo' | 'mbank_mtransfer' | 'nest_przelew' | 'noble_pay' | 'pbac_z_ipko' | 'plus_bank' | 'santander_przelew24' | 'tmobile_usbugi_bankowe' | 'toyota_bank' | 'velobank' | 'volkswagen_bank', nullable — The customer's bank, if provided. - `pay_by_bank` PaymentMethodPayByBank - `payco` PaymentMethodPayco - `paynow` PaymentMethodPaynow - `paypal` PaymentMethodPaypal - `country` string, nullable — Two-letter ISO code representing the buyer's country. Values are provided by PayPal directly (if supported) at the time of authorization or settlement. They cannot be set or mutated. - `payer_email` string, nullable — Owner's email. Values are provided by PayPal directly (if supported) at the time of authorization or settlement. They cannot be set or mutated. - `payer_id` string, nullable — PayPal account PayerID. This identifier uniquely identifies the PayPal customer. - `payto` PaymentMethodPayto - `bsb_number` string, nullable — Bank-State-Branch number of the bank account. - `last4` string, nullable — Last four digits of the bank account number. - `pay_id` string, nullable — The PayID alias for the bank account. - `pix` PaymentMethodPix - `fingerprint` string, nullable — Uniquely identifies this particular Pix account. You can use this attribute to check whether two Pix accounts are the same. - `promptpay` PaymentMethodPromptpay - `radar_options` RadarRadarOptions — Options to configure Radar. See [Radar Session](https://docs.stripe.com/radar/radar-session) for more information. - `session` string — A [Radar Session](https://docs.stripe.com/radar/radar-session) is a snapshot of the browser metadata and device details that help Radar make more accurate predictions on your payments. - `revolut_pay` PaymentMethodRevolutPay - `samsung_pay` PaymentMethodSamsungPay - `satispay` PaymentMethodSatispay - `scalapay` PaymentMethodScalapay - `sepa_debit` PaymentMethodSepaDebit - `bank_code` string, nullable — Bank code of bank associated with the bank account. - `branch_code` string, nullable — Branch code of bank associated with the bank account. - `country` string, nullable — Two-letter ISO code representing the country the bank account is located in. - `fingerprint` string, nullable — Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same. - `generated_from` SepaDebitGeneratedFrom - … - `last4` string, nullable — Last four characters of the IBAN. - `sofort` PaymentMethodSofort - `country` string, nullable — Two-letter ISO code representing the country the bank account is located in. - `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 - `vpa` string, nullable — Customer's unique Virtual Payment Address - `us_bank_account` PaymentMethodUsBankAccount - `account_holder_type` 'company' | 'individual', nullable — Account holder type: individual or company. - `account_type` 'checking' | 'savings', nullable — Account type: checkings or savings. Defaults to checking if omitted. - `bank_name` string, nullable — The name of the bank. - `financial_connections_account` string, nullable — The ID of the Financial Connections Account used to create the payment method. - `fingerprint` string, nullable — Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same. - `last4` string, nullable — Last four digits of the bank account number. - `networks` UsBankAccountNetworks - … - `routing_number` string, nullable — Routing number of the bank account. - `status_details` PaymentMethodUsBankAccountStatusDetails - … - `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`. - 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). - … - `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. - string - Customer — This object represents a customer of your business. Use it to [create recurring charges](https://docs.stripe.com/invoicing/customer), [save payment](https://docs.stripe.com/payments/save-during-payment) and contact information, and track payments that belong to the same customer. - … - DeletedCustomer - … - `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 - `currently_due` string[], nullable — Fields that need to be resolved to keep the external account enabled. If not resolved by `current_deadline`, these fields will appear in `past_due` as well, and the account is disabled. - `errors` AccountRequirementsError[], nullable — Fields that are `currently_due` and need to be collected again because validation or verification failed. - … - `past_due` string[], nullable — Fields that haven't been resolved by `current_deadline`. These fields need to be resolved to enable the external account. - `pending_verification` string[], nullable — Fields that are being reviewed, or might become required depending on the results of a review. If the review fails, these fields can move to `eventually_due`, `currently_due`, `past_due` or `alternatives`. Fields might appear in `eventually_due`, `currently_due`, `past_due` or `alternatives` and in `pending_verification` if one verification fails but another is still pending. - `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 - `currently_due` string[], nullable — Fields that need to be resolved to keep the external account enabled. If not resolved by `current_deadline`, these fields will appear in `past_due` as well, and the account is disabled. - `errors` AccountRequirementsError[], nullable — Fields that are `currently_due` and need to be collected again because validation or verification failed. - … - `past_due` string[], nullable — Fields that haven't been resolved by `current_deadline`. These fields need to be resolved to enable the external account. - `pending_verification` string[], nullable — Fields that are being reviewed, or might become required depending on the results of a review. If the review fails, these fields can move to `eventually_due`, `currently_due`, `past_due` or `alternatives`. Fields might appear in `eventually_due`, `currently_due`, `past_due` or `alternatives` and in `pending_verification` if one verification fails but another is still pending. - `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 - 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). - … - `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. - string - Customer — This object represents a customer of your business. Use it to [create recurring charges](https://docs.stripe.com/invoicing/customer), [save payment](https://docs.stripe.com/payments/save-during-payment) and contact information, and track payments that belong to the same customer. - … - DeletedCustomer - … - `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 - `preferred` string, nullable — The preferred network for co-branded cards. Can be `cartes_bancaires`, `mastercard`, `visa` or `invalid_preference` if requested network is not valid for the card. - `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 - `account_number` string, nullable - `bank_name` string, nullable - `fingerprint` string, nullable - `refund_account_holder_name` string, nullable - `refund_account_holder_type` string, nullable - `refund_routing_number` string, nullable - `routing_number` string, nullable - `swift_code` string, nullable - `ach_debit` SourceTypeAchDebit - `bank_name` string, nullable - `country` string, nullable - `fingerprint` string, nullable - `last4` string, nullable - `routing_number` string, nullable - `type` string, nullable - `acss_debit` SourceTypeAcssDebit - `bank_address_city` string, nullable - `bank_address_line_1` string, nullable - `bank_address_line_2` string, nullable - `bank_address_postal_code` string, nullable - `bank_name` string, nullable - `category` string, nullable - `country` string, nullable - `fingerprint` string, nullable - `last4` string, nullable - `routing_number` string, nullable - `alipay` SourceTypeAlipay - `data_string` string, nullable - `native_url` string, nullable - `statement_descriptor` string, nullable - `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 - `bsb_number` string, nullable - `fingerprint` string, nullable - `last4` string, nullable - `bancontact` SourceTypeBancontact - `bank_code` string, nullable - `bank_name` string, nullable - `bic` string, nullable - `iban_last4` string, nullable - `preferred_language` string, nullable - `statement_descriptor` string, nullable - `card` SourceTypeCard - `address_line1_check` string, nullable - `address_zip_check` string, nullable - `brand` string, nullable - `country` string, nullable - `cvc_check` string, nullable - `dynamic_last4` string, nullable - `exp_month` integer, nullable - `exp_year` integer, nullable - `fingerprint` string - `funding` string, nullable - `last4` string, nullable - `name` string, nullable - `three_d_secure` string - `tokenization_method` string, nullable - `card_present` SourceTypeCardPresent - `application_cryptogram` string - `application_preferred_name` string - `authorization_code` string, nullable - `authorization_response_code` string - `brand` string, nullable - `country` string, nullable - `cvm_type` string - `data_type` string, nullable - `dedicated_file_name` string - `emv_auth_data` string - `evidence_customer_signature` string, nullable - `evidence_transaction_certificate` string, nullable - `exp_month` integer, nullable - `exp_year` integer, nullable - `fingerprint` string - `funding` string, nullable - `last4` string, nullable - `pos_device_id` string, nullable - `pos_entry_mode` string - `read_method` string, nullable - `reader` string, nullable - `terminal_verification_results` string - `transaction_status_information` string - `client_secret` string, required — The client secret of the source. Used for client-side retrieval using a publishable key. - `code_verification` SourceCodeVerificationFlow - `attempts_remaining` integer, required — The number of attempts remaining to authenticate the source object with a verification code. - `status` string, required — The status of the code verification, either `pending` (awaiting verification, `attempts_remaining` should be greater than 0), `succeeded` (successful verification) or `failed` (failed verification, cannot be verified anymore as `attempts_remaining` should be 0). - `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 - `reference` string, nullable - `statement_descriptor` string, nullable - `flow` string, required — The authentication `flow` of the source. `flow` is one of `redirect`, `receiver`, `code_verification`, `none`. - `giropay` SourceTypeGiropay - `bank_code` string, nullable - `bank_name` string, nullable - `bic` string, nullable - `statement_descriptor` string, nullable - `id` string, required — Unique identifier for the object. - `ideal` SourceTypeIdeal - `bank` string, nullable - `bic` string, nullable - `iban_last4` string, nullable - `statement_descriptor` string, nullable - `klarna` SourceTypeKlarna - `background_image_url` string - `client_token` string, nullable - `first_name` string - `last_name` string - `locale` string - `logo_url` string - `page_title` string - `pay_later_asset_urls_descriptive` string - `pay_later_asset_urls_standard` string - `pay_later_name` string - `pay_later_redirect_url` string - `pay_now_asset_urls_descriptive` string - `pay_now_asset_urls_standard` string - `pay_now_name` string - `pay_now_redirect_url` string - `pay_over_time_asset_urls_descriptive` string - `pay_over_time_asset_urls_standard` string - `pay_over_time_name` string - `pay_over_time_redirect_url` string - `payment_method_categories` string - `purchase_country` string - `purchase_type` string - `redirect_url` string - `shipping_delay` integer - `shipping_first_name` string - `shipping_last_name` string - `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 - `entity` string, nullable - `reference` string, nullable - `refund_account_holder_address_city` string, nullable - `refund_account_holder_address_country` string, nullable - `refund_account_holder_address_line1` string, nullable - `refund_account_holder_address_line2` string, nullable - `refund_account_holder_address_postal_code` string, nullable - `refund_account_holder_address_state` string, nullable - `refund_account_holder_name` string, nullable - `refund_iban` string, nullable - `object` 'source', required — String representing the object's type. Objects of the same type share the same value. - `owner` SourceOwner - `address` Address - … - `email` string, nullable — Owner's email address. - `name` string, nullable — Owner's full name. - `phone` string, nullable — Owner's phone number (including extension). - `verified_address` Address - … - `verified_email` string, nullable — Verified owner's email address. Verified values are verified or provided by the payment method directly (and if supported) at the time of authorization or settlement. They cannot be set or mutated. - `verified_name` string, nullable — Verified owner's full name. Verified values are verified or provided by the payment method directly (and if supported) at the time of authorization or settlement. They cannot be set or mutated. - `verified_phone` string, nullable — Verified owner's phone number (including extension). Verified values are verified or provided by the payment method directly (and if supported) at the time of authorization or settlement. They cannot be set or mutated. - `p24` SourceTypeP24 - `reference` string, nullable - `receiver` SourceReceiverFlow - `address` string, nullable — The address of the receiver source. This is the value that should be communicated to the customer to send their funds to. - `amount_charged` integer, required — The total amount that was moved to your balance. This is almost always equal to the amount charged. In rare cases when customers deposit excess funds and we are unable to refund those, those funds get moved to your balance and show up in amount_charged as well. The amount charged is expressed in the source's currency. - `amount_received` integer, required — The total amount received by the receiver source. `amount_received = amount_returned + amount_charged` should be true for consumed sources unless customers deposit excess funds. The amount received is expressed in the source's currency. - `amount_returned` integer, required — The total amount that was returned to the customer. The amount returned is expressed in the source's currency. - `refund_attributes_method` string, required — Type of refund attribute method, one of `email`, `manual`, or `none`. - `refund_attributes_status` string, required — Type of refund attribute status, one of `missing`, `requested`, or `available`. - `redirect` SourceRedirectFlow - `failure_reason` string, nullable — The failure reason for the redirect, either `user_abort` (the customer aborted or dropped out of the redirect flow), `declined` (the authentication failed or the transaction was declined), or `processing_error` (the redirect failed due to a technical error). Present only if the redirect status is `failed`. - `return_url` string, required — The URL you provide to redirect the customer to after they authenticated their payment. - `status` string, required — The status of the redirect, either `pending` (ready to be used by your customer to authenticate the transaction), `succeeded` (successful authentication, cannot be reused) or `not_required` (redirect should not be used) or `failed` (failed authentication, cannot be reused). - `url` string, required — The URL provided to you to redirect a customer to as part of a `redirect` authentication flow. - `sepa_debit` SourceTypeSepaDebit - `bank_code` string, nullable - `branch_code` string, nullable - `country` string, nullable - `fingerprint` string, nullable - `last4` string, nullable - `mandate_reference` string, nullable - `mandate_url` string, nullable - `sofort` SourceTypeSofort - `bank_code` string, nullable - `bank_name` string, nullable - `bic` string, nullable - `country` string, nullable - `iban_last4` string, nullable - `preferred_language` string, nullable - `statement_descriptor` string, nullable - `source_order` SourceOrder - `amount` integer, required — 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 for the order. - `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). - `email` string — The email address of the customer placing the order. - `items` SourceOrderItem[], nullable — List of items constituting the order. - … - `shipping` Shipping - … - `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 - `address_line1_check` string, nullable - `address_zip_check` string, nullable - `authenticated` boolean, nullable - `brand` string, nullable - `card` string, nullable - `country` string, nullable - `customer` string, nullable - `cvc_check` string, nullable - `dynamic_last4` string, nullable - `exp_month` integer, nullable - `exp_year` integer, nullable - `fingerprint` string - `funding` string, nullable - `last4` string, nullable - `name` string, nullable - `three_d_secure` string - `tokenization_method` string, nullable - `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 - `prepay_id` string - `qr_code_url` string, nullable - `statement_descriptor` string - `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) - `checkout_session` string, nullable — The Checkout session that this coupon is applied to, if it is applied to a particular session in payment mode. Not present for subscription mode. - `customer` union — The ID of the customer associated with this discount. - … - `customer_account` string, nullable — The ID of the account representing the customer associated with this discount. - `end` integer, nullable — If the coupon has a duration of `repeating`, the date that this discount will end. If the coupon has a duration of `once` or `forever`, this attribute will be null. - `id` string, required — The ID of the discount object. Discounts can't be fetched by ID. Use `expand[]=discounts` in API calls to expand discount IDs in an array. - `invoice` string, nullable — The invoice that the discount's coupon was applied to, if it was applied directly to a particular invoice. - `invoice_item` string, nullable — The invoice item `id` (or invoice line item `id` for invoice line items of type='subscription') that the discount's coupon was applied to, if it was applied directly to a particular invoice item or invoice line item. - `object` 'discount', required — String representing the object's type. Objects of the same type share the same value. - `promotion_code` union — The promotion code applied to create this discount. - … - `source` DiscountSource, required - … - `start` integer, required — Date that the coupon was applied. - `subscription` string, nullable — The subscription that this coupon is applied to, if it is applied to a particular subscription. - `subscription_item` string, nullable — The subscription item that this coupon is applied to, if it is applied to a particular subscription item. - DeletedDiscount - `checkout_session` string, nullable — The Checkout session that this coupon is applied to, if it is applied to a particular session in payment mode. Not present for subscription mode. - `customer` union — The ID of the customer associated with this discount. - … - `customer_account` string, nullable — The ID of the account representing the customer associated with this discount. - `deleted` true, required — Always true for a deleted object - `id` string, required — The ID of the discount object. Discounts can't be fetched by ID. Use `expand[]=discounts` in API calls to expand discount IDs in an array. - `invoice` string, nullable — The invoice that the discount's coupon was applied to, if it was applied directly to a particular invoice. - `invoice_item` string, nullable — The invoice item `id` (or invoice line item `id` for invoice line items of type='subscription') that the discount's coupon was applied to, if it was applied directly to a particular invoice item or invoice line item. - `object` 'discount', required — String representing the object's type. Objects of the same type share the same value. - `promotion_code` union — The promotion code applied to create this discount. - … - `source` DiscountSource, required - … - `start` integer, required — Date that the coupon was applied. - `subscription` string, nullable — The subscription that this coupon is applied to, if it is applied to a particular subscription. - `subscription_item` string, nullable — The subscription item that this coupon is applied to, if it is applied to a particular subscription item. - `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). - `business_profile` AccountBusinessProfile - … - `business_type` 'company' | 'government_entity' | 'individual' | 'non_profit', nullable — The business type. - `capabilities` AccountCapabilities - … - `charges_enabled` boolean — Whether the account can process charges. - `company` LegalEntityCompany - … - `controller` AccountUnificationAccountController - … - `country` string — The account's country. - `created` integer — Time at which the account was connected. Measured in seconds since the Unix epoch. - `default_currency` string — Three-letter ISO currency code representing the default currency for the account. This must be a currency that [Stripe supports in the account's country](https://stripe.com/docs/payouts). - `details_submitted` boolean — Whether account details have been submitted. Accounts with Stripe Dashboard access, which includes Standard accounts, cannot receive payouts before this is true. Accounts where this is false should be directed to [an onboarding flow](/connect/onboarding) to finish submitting account details. - `email` string, nullable — An email address associated with the account. It's not used for authentication and Stripe doesn't market to this field without explicit approval from the platform. - `external_accounts` object — External accounts (bank accounts and debit cards) currently attached to this account. External accounts are only returned for requests where `controller[is_controller]` is true. - … - `future_requirements` AccountFutureRequirements - … - `groups` AccountGroupMembership - … - `id` string, required — Unique identifier for the object. - `individual` Person — This is an object representing a person associated with a Stripe account. A platform can only access a subset of data in a person for an account where [account.controller.requirement_collection](/api/accounts/object#account_object-controller-requirement_collection) is `stripe`, which includes Standard and Express accounts, after creating an Account Link or Account Session to start Connect onboarding. See the [Standard onboarding](/connect/standard-accounts) or [Express onboarding](/connect/express-accounts) documentation for information about prefilling information and account onboarding steps. Learn more about [handling identity verification with the API](/connect/handling-api-verification#person-information). - … - `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. - `object` 'account', required — String representing the object's type. Objects of the same type share the same value. - `payouts_enabled` boolean — Whether the funds in this account can be paid out. - `requirements` AccountRequirements - … - `settings` AccountSettings - … - `tos_acceptance` AccountTosAcceptance - … - `type` 'custom' | 'express' | 'none' | 'standard' — The Stripe account type. Can be `standard`, `express`, `custom`, or `none`. - `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 - PaymentFlowsAmountDetails - … - PaymentFlowsAmountDetailsClient - … - `amount_received` integer — Amount that this PaymentIntent collects. - `application` union — ID of the Connect application that created the PaymentIntent. - string - Application - … - `application_fee_amount` integer, nullable — The amount of the application fee (if any) that will be requested to be applied to the payment and transferred to the application owner's Stripe account. The amount of the application fee collected will be capped at the total amount captured. For more information, see the PaymentIntents [use case for connected accounts](https://docs.stripe.com/payments/connected-accounts). - `automatic_payment_methods` PaymentFlowsAutomaticPaymentMethodsPaymentIntent - `allow_redirects` 'always' | 'never' — Controls whether this PaymentIntent will accept redirect-based payment methods. Redirect-based payment methods may require your customer to be redirected to a payment method's app or site for authentication or additional steps. To [confirm](https://docs.stripe.com/api/payment_intents/confirm) this PaymentIntent, you may be required to provide a `return_url` to redirect customers back to your site after they authenticate or complete the payment. - `enabled` boolean, required — Automatically calculates compatible payment methods - `canceled_at` integer, nullable — Populated when `status` is `canceled`, this is the time at which the PaymentIntent was canceled. Measured in seconds since the Unix epoch. - `cancellation_reason` 'abandoned' | 'automatic' | 'duplicate' | 'expired' | 'failed_invoice' | 'fraudulent' | 'requested_by_customer' | 'void_invoice', nullable — Reason for cancellation of this PaymentIntent, either user-provided (`duplicate`, `fraudulent`, `requested_by_customer`, or `abandoned`) or generated by Stripe internally (`failed_invoice`, `void_invoice`, `automatic`, or `expired`). - `capture_method` 'automatic' | 'automatic_async' | 'manual' — Controls when the funds will be captured from the customer's account. - `client_secret` string, nullable — The client secret of this PaymentIntent. Used for client-side retrieval using a publishable key. The client secret can be used to complete a payment from your frontend. It should not be stored, logged, or exposed to anyone other than the customer. Make sure that you have TLS enabled on any page that includes the client secret. Refer to our docs to [accept a payment](https://docs.stripe.com/payments/accept-a-payment?ui=elements) and learn about how `client_secret` should be handled. - `confirmation_method` 'automatic' | 'manual' — Describes whether we can confirm this PaymentIntent automatically, or if it requires customer action to confirm the payment. - `created` integer, required — Time at which the object was created. Measured in seconds since the Unix epoch. - `currency` string, currency — Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). - `customer` union — ID of the Customer this PaymentIntent belongs to, if one exists. Payment methods attached to other Customers cannot be used with this PaymentIntent. If [setup_future_usage](https://api.stripe.com#payment_intent_object-setup_future_usage) is set and this PaymentIntent's payment method is not `card_present`, then the payment method attaches to the Customer after the PaymentIntent has been confirmed and any required actions from the user are complete. If the payment method is `card_present` and isn't a digital wallet, then a [generated_card](https://docs.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card is created and attached to the Customer instead. - string - Customer — This object represents a customer of your business. Use it to [create recurring charges](https://docs.stripe.com/invoicing/customer), [save payment](https://docs.stripe.com/payments/save-during-payment) and contact information, and track payments that belong to the same customer. - … - DeletedCustomer - … - `customer_account` string, nullable — ID of the Account representing the customer that this PaymentIntent belongs to, if one exists. Payment methods attached to other Accounts cannot be used with this PaymentIntent. If [setup_future_usage](https://api.stripe.com#payment_intent_object-setup_future_usage) is set and this PaymentIntent's payment method is not `card_present`, then the payment method attaches to the Account after the PaymentIntent has been confirmed and any required actions from the user are complete. If the payment method is `card_present` and isn't a digital wallet, then a [generated_card](https://docs.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card is created and attached to the Account instead. - `description` string, nullable — An arbitrary string attached to the object. Often useful for displaying to users. - `excluded_payment_method_types` string[], nullable — The list of payment method types to exclude from use with this payment. - `hooks` PaymentFlowsPaymentIntentAsyncWorkflows - `inputs` PaymentFlowsPaymentIntentAsyncWorkflowsResourceInputs - … - `id` string, required — Unique identifier for the object. - `last_payment_error` ApiErrors — 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. - string - Charge — The `Charge` object represents a single attempt to move money into your Stripe account. PaymentIntent confirmation is the most common way to create Charges, but [Account Debits](https://docs.stripe.com/connect/account-debits) may also create Charges. Some legacy payment flows create Charges directly, which is not recommended for new integrations. - … - `livemode` boolean, required — If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`. - `managed_payments` SmorResourceManagedPayments - `enabled` boolean, required — Set to `true` to enable [Managed Payments](https://docs.stripe.com/payments/managed-payments), Stripe's merchant of record solution, for this session. - `metadata` object — Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Learn more about [storing information in metadata](https://docs.stripe.com/payments/payment-intents/creating-payment-intents#storing-information-in-metadata). - `next_action` PaymentIntentNextAction - `alipay_handle_redirect` PaymentIntentNextActionAlipayHandleRedirect - … - `blik_authorize` PaymentIntentNextActionBlikAuthorize - `boleto_display_details` PaymentIntentNextActionBoleto - … - `card_await_notification` PaymentIntentNextActionCardAwaitNotification - … - `cashapp_handle_redirect_or_display_qr_code` PaymentIntentNextActionCashappHandleRedirectOrDisplayQrCode - … - `display_bank_transfer_instructions` PaymentIntentNextActionDisplayBankTransferInstructions - … - `klarna_display_qr_code` PaymentIntentNextActionKlarnaDisplayQrCode - … - `konbini_display_details` PaymentIntentNextActionKonbini - … - `multibanco_display_details` PaymentIntentNextActionDisplayMultibancoDetails - … - `oxxo_display_details` PaymentIntentNextActionDisplayOxxoDetails - … - `paynow_display_qr_code` PaymentIntentNextActionPaynowDisplayQrCode - … - `pix_display_qr_code` PaymentIntentNextActionPixDisplayQrCode - … - `promptpay_display_qr_code` PaymentIntentNextActionPromptpayDisplayQrCode - … - `redirect_to_url` PaymentIntentNextActionRedirectToUrl - … - `swish_handle_redirect_or_display_qr_code` PaymentIntentNextActionSwishHandleRedirectOrDisplayQrCode - … - `type` string, required — Type of the next action to perform. Refer to the other child attributes under `next_action` for available values. Examples include: `redirect_to_url`, `use_stripe_sdk`, `alipay_handle_redirect`, `oxxo_display_details`, or `verify_with_microdeposits`. - `upi_handle_redirect_or_display_qr_code` PaymentIntentNextActionUpiHandleRedirectOrDisplayQrCode - … - `use_stripe_sdk` object — When confirming a PaymentIntent with Stripe.js, Stripe.js depends on the contents of this dictionary to invoke authentication flows. The shape of the contents is subject to change and is only intended to be used by Stripe.js. - `verify_with_microdeposits` PaymentIntentNextActionVerifyWithMicrodeposits - … - `wechat_pay_display_qr_code` PaymentIntentNextActionWechatPayDisplayQrCode - … - `wechat_pay_redirect_to_android_app` PaymentIntentNextActionWechatPayRedirectToAndroidApp - … - `wechat_pay_redirect_to_ios_app` PaymentIntentNextActionWechatPayRedirectToIosApp - … - `object` 'payment_intent', required — String representing the object's type. Objects of the same type share the same value. - `on_behalf_of` union — You can specify the settlement merchant as the connected account using the `on_behalf_of` attribute on the charge. See the PaymentIntents [use case for connected accounts](/payments/connected-accounts) for details. - string - Account — For new integrations, we recommend using the [Accounts v2 API](/api/v2/core/accounts), in place of /v1/accounts and /v1/customers to represent a user. This is an object representing a Stripe account. You can retrieve it to see properties on the account like its current requirements or if the account is enabled to make live charges or receive payouts. For accounts where [controller.requirement_collection](/api/accounts/object#account_object-controller-requirement_collection) is `application`, which includes Custom accounts, the properties below are always returned. For accounts where [controller.requirement_collection](/api/accounts/object#account_object-controller-requirement_collection) is `stripe`, which includes Standard and Express accounts, some properties are only returned until you create an [Account Link](/api/account_links) or [Account Session](/api/account_sessions) to start Connect Onboarding. Learn about the [differences between accounts](/connect/accounts). - … - `payment_details` PaymentFlowsPaymentDetails - `customer_reference` string, nullable — A unique value to identify the customer. This field is available only for card payments. This field is truncated to 25 alphanumeric characters, excluding spaces, before being sent to card networks. - `order_reference` string, nullable — A unique value assigned by the business to identify the transaction. Required for L2 and L3 rates. For Cards, this field is truncated to 25 alphanumeric characters, excluding spaces, before being sent to card networks. For Klarna, this field is truncated to 255 characters and is visible to customers when they view the order in the Klarna app. - `payment_method` union — ID of the payment method used in this PaymentIntent. - string - PaymentMethod — PaymentMethod objects represent your customer's payment instruments. You can use them with [PaymentIntents](https://docs.stripe.com/payments/payment-intents) to collect payments or save them to Customer objects to store instrument details for future payments. Related guides: [Payment Methods](https://docs.stripe.com/payments/payment-methods) and [More Payment Scenarios](https://docs.stripe.com/payments/more-payment-scenarios). - … - `payment_method_configuration_details` PaymentMethodConfigBizPaymentMethodConfigurationDetails - `id` string, required — ID of the payment method configuration used. - `parent` string, nullable — ID of the parent payment method configuration used. - `payment_method_options` PaymentIntentPaymentMethodOptions - `acss_debit` union - … - `affirm` union - … - `afterpay_clearpay` union - … - `alipay` union - … - `alma` union - … - `amazon_pay` union - … - `au_becs_debit` union - … - `bacs_debit` union - … - `bancontact` union - … - `billie` union - … - `bizum` union - … - `blik` union - … - `boleto` union - … - `card` union - … - `card_present` union - … - `cashapp` union - … - `crypto` union - … - `customer_balance` union - … - `eps` union - … - `fpx` union - … - `giropay` union - … - `grabpay` union - … - `ideal` union - … - `interac_present` union - … - `kakao_pay` union - … - `klarna` union - … - `konbini` union - … - `kr_card` union - … - `link` union - … - `mb_way` union - … - `mobilepay` union - … - `multibanco` union - … - `naver_pay` union - … - `nz_bank_account` union - … - `oxxo` union - … - `p24` union - … - `pay_by_bank` union - … - `payco` union - … - `paynow` union - … - `paypal` union - … - `payto` union - … - `pix` union - … - `promptpay` union - … - `revolut_pay` union - … - `samsung_pay` union - … - `satispay` union - … - `scalapay` union - … - `sepa_debit` union - … - … 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)