--- title: "List all SetupAttempts" method: GET path: "/v1/setup_attempts" --- # List all SetupAttempts `GET /v1/setup_attempts` Returns a list of SetupAttempts that associate with a provided SetupIntent. ## Query parameters - `created` union - object - `gt` integer - `gte` integer - `lt` integer - `lte` integer - integer - `ending_before` string - `expand` string[] - `limit` integer - `setup_intent` string, required - `starting_after` string ## Response `200` Successful response. - object - `data` SetupAttempt[], required - `application` union — The value of [application](https://stripe.com/docs/api/setup_intents/object#setup_intent_object-application) on the SetupIntent at the time of this confirmation. - 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. - `attach_to_self` boolean — If present, the SetupIntent's payment method will be attached to the in-context Stripe Account. It can only be used for this Stripe Account’s own money movement flows like InboundTransfer and OutboundTransfers. It cannot be set to true when setting up a PaymentMethod for a Customer, and defaults to false when attaching a PaymentMethod to a Customer. - `created` integer, required — Time at which the object was created. Measured in seconds since the Unix epoch. - `customer` union — The value of [customer](https://stripe.com/docs/api/setup_intents/object#setup_intent_object-customer) on the SetupIntent at the time of this confirmation. - string - Customer — This object represents a customer of your business. Use it to [create recurring charges](https://stripe.com/docs/invoicing/customer), [save payment](https://stripe.com/docs/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 (e.g., street, PO Box, or company name). - `line2` string, nullable — Address line 2 (e.g., apartment, suite, unit, or building). - `postal_code` string, nullable — ZIP or postal code. - `state` string, nullable — State, county, province, or region. - `balance` integer — The current balance, if any, that's stored on the customer. 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. - `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://stripe.com/docs/currencies#zero-decimal). - `customer` string, required — The ID of the customer whose cash balance this object represents. - `livemode` boolean, required — Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. - `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. - `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://stripe.com/docs/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 ID of the account that the bank account is associated with. - … - `account_holder_name` string, nullable — The name of the person or business that owns the bank account. - `account_holder_type` string, nullable — The type of entity that holds the account. This can be either `individual` or `company`. - `account_type` string, nullable — The bank account type. This can only be `checking` or `savings` in most countries. In Japan, this can only be `futsu` or `toza`. - `available_payout_methods` string[], nullable — A set of available payout methods for this bank account. Only values from this set should be passed as the `method` when creating a payout. - `bank_name` string, nullable — Name of the bank associated with the routing number (e.g., `WELLS FARGO`). - `country` string, required — Two-letter ISO code representing the country the bank account is located in. - `currency` string, currency, required — Three-letter [ISO code for the currency](https://stripe.com/docs/payouts) paid out to the bank account. - `customer` union — The ID of the customer that the bank account is associated with. - … - `default_for_currency` boolean, nullable — Whether this bank account is the default external account for its currency. - `fingerprint` string, nullable — Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same. - `future_requirements` ExternalAccountRequirements - … - `id` string, required — Unique identifier for the object. - `last4` string, required — The last four digits of the bank account number. - `metadata` object, nullable — Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. - `object` 'bank_account', required — String representing the object's type. Objects of the same type share the same value. - `requirements` ExternalAccountRequirements - … - `routing_number` string, nullable — The routing transit number for the bank account. - `status` string, required — For bank accounts, possible values are `new`, `validated`, `verified`, `verification_failed`, 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 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` and `verification_failed`. 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://stripe.com/docs/sources/cards) - `account` union — The account this card belongs to. This attribute will not be in the card object if the card belongs to a customer or recipient instead. 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. - … - `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`, `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 for accounts where [controller.requirement_collection](/api/accounts/object#account_object-controller-requirement_collection) is `application`, which includes Custom accounts. - `customer` union — The customer that this card belongs to. This attribute will not be in the card object if the card belongs to an account or recipient instead. - … - `cvc_check` string, nullable — If a CVC was provided, results of the check: `pass`, `fail`, `unavailable`, or `unchecked`. A result of unchecked indicates that CVC was provided but hasn't been checked yet. Checks are typically performed when attaching a card to a Customer object, or when creating a charge. For more details, see [Check if a card is valid without a charge](https://support.stripe.com/questions/check-if-a-card-is-valid-without-a-charge). - `default_for_currency` boolean, nullable — Whether this card is the default external account for its currency. This property is only available for accounts where [controller.requirement_collection](/api/accounts/object#account_object-controller-requirement_collection) is `application`, which includes Custom accounts. - `dynamic_last4` string, nullable — (For tokenized numbers only.) The last four digits of the device account number. - `exp_month` integer, required — Two-digit number representing the card's expiration month. - `exp_year` integer, required — Four-digit number representing the card's expiration year. - `fingerprint` string, nullable — Uniquely identifies this particular card number. You can use this attribute to check whether two customers who’ve signed up with you are using the same card number, for example. For payment methods that tokenize card information (Apple Pay, Google Pay), the tokenized number might be provided instead of the underlying card number. *As of May 1, 2021, card fingerprint in India for Connect changed to allow two fingerprints for the same card---one for India and one for the rest of the world.* - `funding` string, required — Card funding type. Can be `credit`, `debit`, `prepaid`, or `unknown`. - `id` string, required — Unique identifier for the object. - `iin` string — Issuer identification number of the card. - `last4` string, required — The last four digits of the card. - `metadata` object, nullable — Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. - `name` string, nullable — Cardholder name. - `networks` TokenCardNetworks - … - `object` 'card', required — String representing the object's type. Objects of the same type share the same value. - `regulated_status` 'regulated' | 'unregulated', nullable — Status of a card based on the card issuer. - `status` string, nullable — For external accounts that are cards, possible values are `new` and `errored`. If a payout fails, the status is set to `errored` and [scheduled payouts](https://stripe.com/docs/payouts#payout-schedule) are stopped until account details are updated. - `tokenization_method` string, nullable — If the card number is tokenized, this is the method that was used. Can be `android_pay` (includes Google Pay), `apple_pay`, `masterpass`, `visa_checkout`, or null. - Source — `Source` objects allow you to accept a variety of payment methods. They represent a customer's payment instrument, and can be used with the Stripe API just like a `Card` object: once chargeable, they can be charged, or can be attached to customers. Stripe doesn't recommend using the deprecated [Sources API](https://stripe.com/docs/api/sources). We recommend that you adopt the [PaymentMethods API](https://stripe.com/docs/api/payment_methods). This newer API provides access to our latest features and payment method types. Related guides: [Sources API](https://stripe.com/docs/sources) and [Sources & Customers](https://stripe.com/docs/sources/customers). - `ach_credit_transfer` SourceTypeAchCreditTransfer - … - `ach_debit` SourceTypeAchDebit - … - `acss_debit` SourceTypeAcssDebit - … - `alipay` SourceTypeAlipay - … - `allow_redisplay` 'always' | 'limited' | 'unspecified', nullable — This field indicates whether this payment method can be shown again to its customer in a checkout flow. Stripe products such as Checkout and Elements use this field to determine whether a payment method can be shown as a saved payment method in a checkout flow. The field defaults to “unspecified”. - `amount` integer, nullable — A positive integer in the smallest currency unit (that is, 100 cents for $1.00, or 1 for ¥1, Japanese Yen being a zero-decimal currency) representing the total amount associated with the source. This is the amount for which the source will be chargeable once ready. Required for `single_use` sources. - `au_becs_debit` SourceTypeAuBecsDebit - … - `bancontact` SourceTypeBancontact - … - `card` SourceTypeCard - … - `card_present` SourceTypeCardPresent - … - `client_secret` string, required — The client secret of the source. Used for client-side retrieval using a publishable key. - `code_verification` SourceCodeVerificationFlow - … - `created` integer, required — Time at which the object was created. Measured in seconds since the Unix epoch. - `currency` string, currency, nullable — Three-letter [ISO code for the currency](https://stripe.com/docs/currencies) associated with the source. This is the currency for which the source will be chargeable once ready. Required for `single_use` sources. - `customer` string — The ID of the customer to which this source is attached. This will not be present when the source has not been attached to a customer. - `eps` SourceTypeEps - … - `flow` string, required — The authentication `flow` of the source. `flow` is one of `redirect`, `receiver`, `code_verification`, `none`. - `giropay` SourceTypeGiropay - … - `id` string, required — Unique identifier for the object. - `ideal` SourceTypeIdeal - … - `klarna` SourceTypeKlarna - … - `livemode` boolean, required — Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. - `metadata` object, nullable — Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. - `multibanco` SourceTypeMultibanco - … - `object` 'source', required — String representing the object's type. Objects of the same type share the same value. - `owner` SourceOwner - … - `p24` SourceTypeP24 - … - `receiver` SourceReceiverFlow - … - `redirect` SourceRedirectFlow - … - `sepa_debit` SourceTypeSepaDebit - … - `sofort` SourceTypeSofort - … - `source_order` SourceOrder - … - `statement_descriptor` string, nullable — Extra information about a source. This will appear on your customer's statement every time you charge the source. - `status` string, required — The status of the source, one of `canceled`, `chargeable`, `consumed`, `failed`, or `pending`. Only `chargeable` sources can be used to create a charge. - `three_d_secure` SourceTypeThreeDSecure - … - `type` 'ach_credit_transfer' | 'ach_debit' | 'acss_debit' | 'alipay' | 'au_becs_debit' | 'bancontact' | 'card' | 'card_present' | 'eps' | 'giropay' | 'ideal' | 'klarna' | 'multibanco' | 'p24' | 'sepa_debit' | 'sofort' | 'three_d_secure' | 'wechat', required — The `type` of the source. The `type` is a payment method, one of `ach_credit_transfer`, `ach_debit`, `alipay`, `bancontact`, `card`, `card_present`, `eps`, `giropay`, `ideal`, `multibanco`, `klarna`, `p24`, `sepa_debit`, `sofort`, `three_d_secure`, or `wechat`. An additional hash is included on the source with a name matching this value. It contains additional information specific to the [payment method](https://stripe.com/docs/sources) used. - `usage` string, nullable — Either `reusable` or `single_use`. Whether this source should be reusable or not. Some source types may or may not be reusable by construction, while others may leave the option at creation. If an incompatible value is passed, an error will be returned. - `wechat` SourceTypeWechat - … - `delinquent` boolean, nullable — Tracks the most recent state change on any invoice belonging to the customer. Paying an invoice or marking it uncollectible via the API will set this field to false. An automatic payment failure or passing the `invoice.due_date` will set this field to `true`. If an invoice becomes uncollectible by [dunning](https://stripe.com/docs/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://stripe.com/docs/api#coupons) or [promotion code](https://stripe.com/docs/api#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://stripe.com/docs/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. Will not be present for subscription mode. - `coupon` Coupon, required — 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://stripe.com/docs/api#subscriptions), [invoices](https://stripe.com/docs/api#invoices), [checkout sessions](https://stripe.com/docs/api/checkout/sessions), [quotes](https://stripe.com/docs/api#quotes), and more. Coupons do not work with conventional one-off [charges](https://stripe.com/docs/api#create_charge) or [payment intents](https://stripe.com/docs/api/payment_intents). - `amount_off` integer, nullable — Amount (in the `currency` specified) that will be taken off the subtotal of any invoices for this customer. - `applies_to` CouponAppliesTo - … - `created` integer, required — Time at which the object was created. Measured in seconds since the Unix epoch. - `currency` string, currency, nullable — If `amount_off` has been set, the three-letter [ISO code for the currency](https://stripe.com/docs/currencies) of the amount to take off. - `currency_options` object — Coupons defined in each available currency option. Each key must be a three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html) and a [supported currency](https://stripe.com/docs/currencies). - `duration` 'forever' | 'once' | 'repeating', required — One of `forever`, `once`, and `repeating`. Describes how long a customer who applies this coupon will get the discount. - `duration_in_months` integer, nullable — If `duration` is `repeating`, the number of months the coupon applies. Null if coupon `duration` is `forever` or `once`. - `id` string, required — Unique identifier for the object. - `livemode` boolean, required — Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. - `max_redemptions` integer, nullable — Maximum number of times this coupon can be redeemed, in total, across all customers, before it is no longer valid. - `metadata` object, nullable — Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. - `name` string, nullable — Name of the coupon displayed to customers on for instance invoices or receipts. - `object` 'coupon', required — String representing the object's type. Objects of the same type share the same value. - `percent_off` number, nullable — Percent that will be taken off the subtotal of any invoices for this customer for the duration of the coupon. For example, a coupon with percent_off of 50 will make a $ (or local equivalent)100 invoice $ (or local equivalent)50 instead. - `redeem_by` integer, nullable — Date after which the coupon can no longer be redeemed. - `times_redeemed` integer, required — Number of times this coupon has been applied to a customer. - `valid` boolean, required — Taking account of the above properties, whether this coupon can still be applied to a customer. - `customer` union — The ID of the customer associated with this discount. - string - Customer — recursive - DeletedCustomer - … - `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 cannot 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 a [coupon](https://stripe.com/docs/api#coupons). It can be used to create multiple codes for a single coupon. - … - `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. - `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://stripe.com/docs/payments/payment-intents) to collect payments or save them to Customer objects to store instrument details for future payments. Related guides: [Payment Methods](https://stripe.com/docs/payments/payment-methods) and [More Payment Scenarios](https://stripe.com/docs/payments/more-payment-scenarios). - … - `footer` string, nullable — Default footer to be displayed on invoices for this customer. - `rendering_options` InvoiceSettingCustomerRenderingOptions - `amount_tax_display` string, nullable — How line-item prices and amounts will be displayed with respect to tax on invoice PDFs. - `template` string, nullable — ID of the invoice rendering template to be used for this customer's invoices. If set, the template will be used on all invoices for this customer unless a template is set directly on the invoice. - `livemode` boolean, required — Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. - `metadata` object — Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. - `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 (e.g., street, PO Box, or company name). - `line2` string, nullable — Address line 2 (e.g., apartment, suite, unit, or building). - `postal_code` string, nullable — ZIP or postal code. - `state` string, nullable — State, county, province, or region. - `carrier` string, nullable — The delivery service that shipped a physical product, such as Fedex, UPS, USPS, etc. - `name` string — Recipient name. - `phone` string, nullable — Recipient phone (including extension). - `tracking_number` string, nullable — The tracking number for a physical product, obtained from the delivery service. If multiple tracking numbers were generated for this purchase, please separate them with commas. - `sources` object — The customer's payment sources, if any. - `data` union[], required — Details about each object. - union - … - `has_more` boolean, required — True if this list has another page of items after this one that can be fetched. - `object` 'list', required — String representing the object's type. Objects of the same type share the same value. Always has the value `list`. - `url` string, required — The URL where this list can be accessed. - `subscriptions` object — The customer's current subscriptions, if any. - `data` Subscription[], required — Details about each object. - `application` union — ID of the Connect Application that created the subscription. - … - `application_fee_percent` number, nullable — A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice total that will be transferred to the application owner's Stripe account. - `automatic_tax` SubscriptionAutomaticTax, required - … - `billing_cycle_anchor` integer, required — The reference point that aligns future [billing cycle](https://stripe.com/docs/subscriptions/billing-cycle) dates. It sets the day of week for `week` intervals, the day of month for `month` and `year` intervals, and the month of year for `year` intervals. The timestamp is in UTC format. - `billing_cycle_anchor_config` SubscriptionsResourceBillingCycleAnchorConfig - … - `billing_thresholds` SubscriptionBillingThresholds - … - `cancel_at` integer, nullable — A date in the future at which the subscription will automatically get canceled - `cancel_at_period_end` boolean, required — Whether this subscription will (if `status=active`) or did (if `status=canceled`) cancel at the end of the current billing period. - `canceled_at` integer, nullable — If the subscription has been canceled, the date of that cancellation. If the subscription was canceled with `cancel_at_period_end`, `canceled_at` will reflect the time of the most recent update request, not the end of the subscription period when the subscription is automatically moved to a canceled state. - `cancellation_details` CancellationDetails - … - `collection_method` 'charge_automatically' | 'send_invoice', required — Either `charge_automatically`, or `send_invoice`. When charging automatically, Stripe will attempt to pay this subscription at the end of the cycle using the default source attached to the customer. When sending an invoice, Stripe will email your customer an invoice with payment instructions and mark the subscription as `active`. - `created` integer, required — Time at which the object was created. Measured in seconds since the Unix epoch. - `currency` string, currency, required — Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). - `current_period_end` integer, required — End of the current period that the subscription has been invoiced for. At the end of this period, a new invoice will be created. - `current_period_start` integer, required — Start of the current period that the subscription has been invoiced for. - `customer` union, required — ID of 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://stripe.com/docs/api/customers/object#customer_object-invoice_settings-default_payment_method) or [default_source](https://stripe.com/docs/api/customers/object#customer_object-default_source). - … - `default_source` union — ID of the default payment source for the subscription. It must belong to the customer associated with the subscription and be in a chargeable state. If `default_payment_method` is also set, `default_payment_method` will take precedence. If neither are set, invoices will use the customer's [invoice_settings.default_payment_method](https://stripe.com/docs/api/customers/object#customer_object-invoice_settings-default_payment_method) or [default_source](https://stripe.com/docs/api/customers/object#customer_object-default_source). - … - `default_tax_rates` TaxRate[], nullable — The tax rates that will apply to any subscription item that does not have `tax_rates` set. Invoices created will have their `default_tax_rates` populated from the subscription. - … - `description` string, nullable — The subscription's description, meant to be displayable to the customer. Use this field to optionally store an explanation of the subscription for rendering in Stripe surfaces and certain local payment methods UIs. - `discount` Discount — A discount represents the actual application of a [coupon](https://stripe.com/docs/api#coupons) or [promotion code](https://stripe.com/docs/api#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://stripe.com/docs/billing/subscriptions/discounts) - … - `discounts` union[], required — The discounts applied to the subscription. Subscription item discounts are applied before subscription discounts. Use `expand[]=discounts` to expand each discount. - … - `ended_at` integer, nullable — If the subscription has ended, the date the subscription ended. - `id` string, required — Unique identifier for the object. - `invoice_settings` SubscriptionsResourceSubscriptionInvoiceSettings, required - … - `items` object, required — List of subscription items, each with an attached price. - … - `latest_invoice` union — The most recent invoice this subscription has generated. - … - `livemode` boolean, required — Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. - `metadata` object, required — Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. - `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 for details. - … - `pause_collection` SubscriptionsResourcePauseCollection — The Pause Collection settings determine how we will pause collection for this subscription and for how long the subscription should be paused. - … - `payment_settings` SubscriptionsResourcePaymentSettings - … - `pending_invoice_item_interval` SubscriptionPendingInvoiceItemInterval - … - `pending_setup_intent` union — You can use this [SetupIntent](https://stripe.com/docs/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://stripe.com/docs/billing/migration/strong-customer-authentication#scenario-2). - … - `pending_update` SubscriptionsResourcePendingUpdate — Pending Updates store the changes pending from a previous update that will be applied to the Subscription upon successful payment. - … - `schedule` union — The schedule attached to the subscription - … - `start_date` integer, required — Date when the subscription was first created. The date might differ from the `created` date due to backdating. - `status` 'active' | 'canceled' | 'incomplete' | 'incomplete_expired' | 'past_due' | 'paused' | 'trialing' | 'unpaid', required — Possible values are `incomplete`, `incomplete_expired`, `trialing`, `active`, `past_due`, `canceled`, `unpaid`, or `paused`. For `collection_method=charge_automatically` a subscription moves into `incomplete` if the initial payment attempt fails. A subscription in this status can only have metadata and default_source updated. Once the first invoice is paid, the subscription moves into an `active` status. If the first invoice is not paid within 23 hours, the subscription transitions to `incomplete_expired`. This is a terminal status, the open invoice will be voided and no further invoices will be generated. A subscription that is currently in a trial period is `trialing` and moves to `active` when the trial period is over. A subscription can only enter a `paused` status [when a trial ends without a payment method](https://stripe.com/docs/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://stripe.com/docs/billing/subscriptions/pause-payment), which still generates invoices and leaves the subscription's status unchanged. If subscription `collection_method=charge_automatically`, it becomes `past_due` when payment is required but cannot be paid (due to failed payment or awaiting additional user actions). Once Stripe has exhausted all payment retry attempts, the subscription will become `canceled` or `unpaid` (depending on your subscriptions settings). If subscription `collection_method=send_invoice` it becomes `past_due` when its invoice is not paid by the due date, and `canceled` or `unpaid` if it is still not paid by an additional deadline after that. Note that when a subscription has a status of `unpaid`, no subsequent invoices will be attempted (invoices will be created, but then immediately automatically closed). After receiving updated payment information from a customer, you may choose to reopen and pay their closed invoices. - `test_clock` union — ID of the test clock this subscription belongs to. - … - `transfer_data` SubscriptionTransferData - … - `trial_end` integer, nullable — If the subscription has a trial, the end of that trial. - `trial_settings` SubscriptionsTrialsResourceTrialSettings — Configures how this subscription behaves during the trial period. - … - `trial_start` integer, nullable — If the subscription has a trial, the beginning of that trial. - `has_more` boolean, required — True if this list has another page of items after this one that can be fetched. - `object` 'list', required — String representing the object's type. Objects of the same type share the same value. Always has the value `list`. - `url` string, required — The URL where this list can be accessed. - `tax` CustomerTax - `automatic_tax` 'failed' | 'not_collecting' | 'supported' | 'unrecognized_location', required — Surfaces if automatic tax computation is possible given the current customer location information. - `ip_address` string, nullable — A recent IP address of the customer used for tax reporting and tax location inference. - `location` CustomerTaxLocation - `country` string, required — The customer's country as identified by Stripe Tax. - `source` 'billing_address' | 'ip_address' | 'payment_method' | 'shipping_destination', required — The data source used to infer the customer's location. - `state` string, nullable — The customer's state, county, province, or region as identified by Stripe Tax. - `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. - … - `id` string, required — Unique identifier for the object. - `livemode` boolean, required — Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. - `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' | 'ba_tin' | 'bb_tin' | 'bg_uic' | 'bh_vat' | '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' | 'cn_tin' | 'co_nit' | 'cr_tin' | 'de_stn' | 'do_rcn' | 'ec_ruc' | 'eg_tin' | 'es_cif' | 'eu_oss_vat' | 'eu_vat' | 'gb_vat' | 'ge_vat' | 'gn_nif' | 'hk_br' | 'hr_oib' | 'hu_tin' | 'id_npwp' | 'il_vat' | 'in_gst' | 'is_vat' | 'jp_cn' | 'jp_rn' | 'jp_trn' | 'ke_pin' | 'kh_tin' | 'kr_brn' | 'kz_bin' | 'li_uid' | 'li_vat' | 'ma_vat' | 'md_vat' | 'me_pib' | 'mk_vat' | 'mr_nif' | 'mx_rfc' | 'my_frp' | 'my_itn' | 'my_sst' | 'ng_tin' | 'no_vat' | 'no_voec' | 'np_pan' | 'nz_gst' | 'om_vat' | 'pe_ruc' | 'ph_tin' | 'ro_tin' | 'rs_pib' | 'ru_inn' | 'ru_kpp' | 'sa_vat' | 'sg_gst' | 'sg_uen' | 'si_tin' | 'sn_ninea' | 'sr_fin' | 'sv_nit' | 'th_vat' | 'tj_tin' | 'tr_tin' | 'tw_vat' | 'tz_vat' | 'ua_vat' | 'ug_tin' | 'unknown' | 'us_ein' | 'uy_ruc' | 'uz_tin' | 'uz_vat' | 've_rif' | 'vn_tin' | 'za_vat' | 'zm_tin' | 'zw_tin', required — Type of the tax ID, one of `ad_nrt`, `ae_trn`, `al_tin`, `am_tin`, `ao_tin`, `ar_cuit`, `au_abn`, `au_arn`, `ba_tin`, `bb_tin`, `bg_uic`, `bh_vat`, `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`, `cn_tin`, `co_nit`, `cr_tin`, `de_stn`, `do_rcn`, `ec_ruc`, `eg_tin`, `es_cif`, `eu_oss_vat`, `eu_vat`, `gb_vat`, `ge_vat`, `gn_nif`, `hk_br`, `hr_oib`, `hu_tin`, `id_npwp`, `il_vat`, `in_gst`, `is_vat`, `jp_cn`, `jp_rn`, `jp_trn`, `ke_pin`, `kh_tin`, `kr_brn`, `kz_bin`, `li_uid`, `li_vat`, `ma_vat`, `md_vat`, `me_pib`, `mk_vat`, `mr_nif`, `mx_rfc`, `my_frp`, `my_itn`, `my_sst`, `ng_tin`, `no_vat`, `no_voec`, `np_pan`, `nz_gst`, `om_vat`, `pe_ruc`, `ph_tin`, `ro_tin`, `rs_pib`, `ru_inn`, `ru_kpp`, `sa_vat`, `sg_gst`, `sg_uen`, `si_tin`, `sn_ninea`, `sr_fin`, `sv_nit`, `th_vat`, `tj_tin`, `tr_tin`, `tw_vat`, `tz_vat`, `ua_vat`, `ug_tin`, `us_ein`, `uy_ruc`, `uz_tin`, `uz_vat`, `ve_rif`, `vn_tin`, `za_vat`, `zm_tin`, or `zw_tin`. Note that some legacy tax IDs have type `unknown` - `value` string, required — Value of the tax ID. - `verification` TaxIdVerification - … - `has_more` boolean, required — True if this list has another page of items after this one that can be fetched. - `object` 'list', required — String representing the object's type. Objects of the same type share the same value. Always has the value `list`. - `url` string, required — The URL where this list can be accessed. - `test_clock` union — ID of the test clock that this customer belongs to. - string - TestHelpersTestClock — A test clock enables deterministic control over objects in testmode. With a test clock, you can create objects at a frozen time in the past or future, and advance to a specific future time to observe webhooks and state changes. After the clock advances, you can either validate the current state of your scenario (and test your assumptions), change the current state of your scenario (and test more complex scenarios), or keep advancing forward in time. - `created` integer, required — Time at which the object was created. Measured in seconds since the Unix epoch. - `deletes_after` integer, required — Time at which this clock is scheduled to auto delete. - `frozen_time` integer, required — Time at which all objects belonging to this clock are frozen. - `id` string, required — Unique identifier for the object. - `livemode` boolean, required — Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. - `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 - … - 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. - `flow_directions` string[], nullable — Indicates the directions of money movement for which this payment method is intended to be used. Include `inbound` if you intend to use the payment method as the origin to pull funds from. Include `outbound` if you intend to use the payment method as the destination to send funds to. You can include both if you intend to use the payment method for both purposes. - `id` string, required — Unique identifier for the object. - `livemode` boolean, required — Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. - `object` 'setup_attempt', required — String representing the object's type. Objects of the same type share the same value. - `on_behalf_of` union — The value of [on_behalf_of](https://stripe.com/docs/api/setup_intents/object#setup_intent_object-on_behalf_of) on the SetupIntent at the time of this confirmation. - string - Account — 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 - `annual_revenue` AccountAnnualRevenue - `amount` integer, nullable — A non-negative integer representing the amount in the [smallest currency unit](/currencies#zero-decimal). - `currency` string, currency, nullable — Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). - `fiscal_year_end` string, nullable — The close-out date of the preceding fiscal year in ISO 8601 format. E.g. 2023-12-31 for the 31st of December, 2023. - `estimated_worker_count` integer, nullable — An estimated upper bound of employees, contractors, vendors, etc. currently working for the business. - `mcc` string, nullable — [The merchant category code for the account](/connect/setting-mcc). MCCs are used to classify businesses based on the goods or services they provide. - `monthly_estimated_revenue` AccountMonthlyEstimatedRevenue - `amount` integer, required — A non-negative integer representing how much to charge in the [smallest currency unit](/currencies#zero-decimal). - `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). - `name` string, nullable — The customer-facing business name. - `product_description` string, nullable — Internal-only description of the product sold or service provided by the business. It's used by Stripe for risk and underwriting purposes. - `support_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 (e.g., street, PO Box, or company name). - `line2` string, nullable — Address line 2 (e.g., apartment, suite, unit, or building). - `postal_code` string, nullable — ZIP or postal code. - `state` string, nullable — State, county, province, or region. - `support_email` string, nullable — A publicly available email address for sending support issues to. - `support_phone` string, nullable — A publicly available phone number to call with support issues. - `support_url` string, nullable — A publicly available website for handling support issues. - `url` string, nullable — The business's publicly available website. - `business_type` 'company' | 'government_entity' | 'individual' | 'non_profit', nullable — The business type. After you create an [Account Link](/api/account_links) or [Account Session](/api/account_sessions), this property is only returned for accounts where [controller.requirement_collection](/api/accounts/object#account_object-controller-requirement_collection) is `application`, which includes Custom accounts. - `capabilities` AccountCapabilities - `acss_debit_payments` 'active' | 'inactive' | 'pending' — The status of the Canadian pre-authorized debits payments capability of the account, or whether the account can directly process Canadian pre-authorized debits charges. - `affirm_payments` 'active' | 'inactive' | 'pending' — The status of the Affirm capability of the account, or whether the account can directly process Affirm charges. - `afterpay_clearpay_payments` 'active' | 'inactive' | 'pending' — The status of the Afterpay Clearpay capability of the account, or whether the account can directly process Afterpay Clearpay charges. - `alma_payments` 'active' | 'inactive' | 'pending' — The status of the Alma capability of the account, or whether the account can directly process Alma payments. - `amazon_pay_payments` 'active' | 'inactive' | 'pending' — The status of the AmazonPay capability of the account, or whether the account can directly process AmazonPay payments. - `au_becs_debit_payments` 'active' | 'inactive' | 'pending' — The status of the BECS Direct Debit (AU) payments capability of the account, or whether the account can directly process BECS Direct Debit (AU) charges. - `bacs_debit_payments` 'active' | 'inactive' | 'pending' — The status of the Bacs Direct Debits payments capability of the account, or whether the account can directly process Bacs Direct Debits charges. - `bancontact_payments` 'active' | 'inactive' | 'pending' — The status of the Bancontact payments capability of the account, or whether the account can directly process Bancontact charges. - `bank_transfer_payments` 'active' | 'inactive' | 'pending' — The status of the customer_balance payments capability of the account, or whether the account can directly process customer_balance charges. - `blik_payments` 'active' | 'inactive' | 'pending' — The status of the blik payments capability of the account, or whether the account can directly process blik charges. - `boleto_payments` 'active' | 'inactive' | 'pending' — The status of the boleto payments capability of the account, or whether the account can directly process boleto charges. - `card_issuing` 'active' | 'inactive' | 'pending' — The status of the card issuing capability of the account, or whether you can use Issuing to distribute funds on cards - `card_payments` 'active' | 'inactive' | 'pending' — The status of the card payments capability of the account, or whether the account can directly process credit and debit card charges. - `cartes_bancaires_payments` 'active' | 'inactive' | 'pending' — The status of the Cartes Bancaires payments capability of the account, or whether the account can directly process Cartes Bancaires card charges in EUR currency. - `cashapp_payments` 'active' | 'inactive' | 'pending' — The status of the Cash App Pay capability of the account, or whether the account can directly process Cash App Pay payments. - `eps_payments` 'active' | 'inactive' | 'pending' — The status of the EPS payments capability of the account, or whether the account can directly process EPS charges. - `fpx_payments` 'active' | 'inactive' | 'pending' — The status of the FPX payments capability of the account, or whether the account can directly process FPX charges. - `gb_bank_transfer_payments` 'active' | 'inactive' | 'pending' — The status of the GB customer_balance payments (GBP currency) capability of the account, or whether the account can directly process GB customer_balance charges. - `giropay_payments` 'active' | 'inactive' | 'pending' — The status of the giropay payments capability of the account, or whether the account can directly process giropay charges. - `grabpay_payments` 'active' | 'inactive' | 'pending' — The status of the GrabPay payments capability of the account, or whether the account can directly process GrabPay charges. - `ideal_payments` 'active' | 'inactive' | 'pending' — The status of the iDEAL payments capability of the account, or whether the account can directly process iDEAL charges. - `india_international_payments` 'active' | 'inactive' | 'pending' — The status of the india_international_payments capability of the account, or whether the account can process international charges (non INR) in India. - `jcb_payments` 'active' | 'inactive' | 'pending' — The status of the JCB payments capability of the account, or whether the account (Japan only) can directly process JCB credit card charges in JPY currency. - `jp_bank_transfer_payments` 'active' | 'inactive' | 'pending' — The status of the Japanese customer_balance payments (JPY currency) capability of the account, or whether the account can directly process Japanese customer_balance charges. - `kakao_pay_payments` 'active' | 'inactive' | 'pending' — The status of the KakaoPay capability of the account, or whether the account can directly process KakaoPay payments. - `klarna_payments` 'active' | 'inactive' | 'pending' — The status of the Klarna payments capability of the account, or whether the account can directly process Klarna charges. - `konbini_payments` 'active' | 'inactive' | 'pending' — The status of the konbini payments capability of the account, or whether the account can directly process konbini charges. - `kr_card_payments` 'active' | 'inactive' | 'pending' — The status of the KrCard capability of the account, or whether the account can directly process KrCard payments. - `legacy_payments` 'active' | 'inactive' | 'pending' — The status of the legacy payments capability of the account. - `link_payments` 'active' | 'inactive' | 'pending' — The status of the link_payments capability of the account, or whether the account can directly process Link charges. - `mobilepay_payments` 'active' | 'inactive' | 'pending' — The status of the MobilePay capability of the account, or whether the account can directly process MobilePay charges. - `multibanco_payments` 'active' | 'inactive' | 'pending' — The status of the Multibanco payments capability of the account, or whether the account can directly process Multibanco charges. - `mx_bank_transfer_payments` 'active' | 'inactive' | 'pending' — The status of the Mexican customer_balance payments (MXN currency) capability of the account, or whether the account can directly process Mexican customer_balance charges. - `naver_pay_payments` 'active' | 'inactive' | 'pending' — The status of the NaverPay capability of the account, or whether the account can directly process NaverPay payments. - `oxxo_payments` 'active' | 'inactive' | 'pending' — The status of the OXXO payments capability of the account, or whether the account can directly process OXXO charges. - `p24_payments` 'active' | 'inactive' | 'pending' — The status of the P24 payments capability of the account, or whether the account can directly process P24 charges. - `pay_by_bank_payments` 'active' | 'inactive' | 'pending' — The status of the pay_by_bank payments capability of the account, or whether the account can directly process pay_by_bank charges. - `payco_payments` 'active' | 'inactive' | 'pending' — The status of the Payco capability of the account, or whether the account can directly process Payco payments. - `paynow_payments` 'active' | 'inactive' | 'pending' — The status of the paynow payments capability of the account, or whether the account can directly process paynow charges. - `promptpay_payments` 'active' | 'inactive' | 'pending' — The status of the promptpay payments capability of the account, or whether the account can directly process promptpay charges. - `revolut_pay_payments` 'active' | 'inactive' | 'pending' — The status of the RevolutPay capability of the account, or whether the account can directly process RevolutPay payments. - `samsung_pay_payments` 'active' | 'inactive' | 'pending' — The status of the SamsungPay capability of the account, or whether the account can directly process SamsungPay payments. - `sepa_bank_transfer_payments` 'active' | 'inactive' | 'pending' — The status of the SEPA customer_balance payments (EUR currency) capability of the account, or whether the account can directly process SEPA customer_balance charges. - `sepa_debit_payments` 'active' | 'inactive' | 'pending' — The status of the SEPA Direct Debits payments capability of the account, or whether the account can directly process SEPA Direct Debits charges. - `sofort_payments` 'active' | 'inactive' | 'pending' — The status of the Sofort payments capability of the account, or whether the account can directly process Sofort charges. - `swish_payments` 'active' | 'inactive' | 'pending' — The status of the Swish capability of the account, or whether the account can directly process Swish payments. - `tax_reporting_us_1099_k` 'active' | 'inactive' | 'pending' — The status of the tax reporting 1099-K (US) capability of the account. - `tax_reporting_us_1099_misc` 'active' | 'inactive' | 'pending' — The status of the tax reporting 1099-MISC (US) capability of the account. - `transfers` 'active' | 'inactive' | 'pending' — The status of the transfers capability of the account, or whether your platform can transfer funds to the account. - `treasury` 'active' | 'inactive' | 'pending' — The status of the banking capability, or whether the account can have bank accounts. - `twint_payments` 'active' | 'inactive' | 'pending' — The status of the TWINT capability of the account, or whether the account can directly process TWINT charges. - `us_bank_account_ach_payments` 'active' | 'inactive' | 'pending' — The status of the US bank account ACH payments capability of the account, or whether the account can directly process US bank account charges. - `us_bank_transfer_payments` 'active' | 'inactive' | 'pending' — The status of the US customer_balance payments (USD currency) capability of the account, or whether the account can directly process US customer_balance charges. - `zip_payments` 'active' | 'inactive' | 'pending' — The status of the Zip capability of the account, or whether the account can directly process Zip charges. - `charges_enabled` boolean — Whether the account can process charges. - `company` LegalEntityCompany - `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 (e.g., street, PO Box, or company name). - `line2` string, nullable — Address line 2 (e.g., apartment, suite, unit, or building). - `postal_code` string, nullable — ZIP or postal code. - `state` string, nullable — State, county, province, or region. - `address_kana` LegalEntityJapanAddress - `city` string, nullable — City/Ward. - `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 — Block/Building number. - `line2` string, nullable — Building details. - `postal_code` string, nullable — ZIP or postal code. - `state` string, nullable — Prefecture. - `town` string, nullable — Town/cho-me. - `address_kanji` LegalEntityJapanAddress - `city` string, nullable — City/Ward. - `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 — Block/Building number. - `line2` string, nullable — Building details. - `postal_code` string, nullable — ZIP or postal code. - `state` string, nullable — Prefecture. - `town` string, nullable — Town/cho-me. - `directors_provided` boolean — Whether the company's directors have been provided. This Boolean will be `true` if you've manually indicated that all directors are provided via [the `directors_provided` parameter](https://stripe.com/docs/api/accounts/update#update_account-company-directors_provided). - `directorship_declaration` LegalEntityDirectorshipDeclaration - `date` integer, nullable — The Unix timestamp marking when the directorship declaration attestation was made. - `ip` string, nullable — The IP address from which the directorship declaration attestation was made. - `user_agent` string, nullable — The user-agent string from the browser where the directorship declaration attestation was made. - `executives_provided` boolean — Whether the company's executives have been provided. This Boolean will be `true` if you've manually indicated that all executives are provided via [the `executives_provided` parameter](https://stripe.com/docs/api/accounts/update#update_account-company-executives_provided), or if Stripe determined that sufficient executives were provided. - `export_license_id` string — The export license ID number of the company, also referred as Import Export Code (India only). - `export_purpose_code` string — The purpose code to use for export transactions (India only). - `name` string, nullable — The company's legal name. - `name_kana` string, nullable — The Kana variation of the company's legal name (Japan only). - `name_kanji` string, nullable — The Kanji variation of the company's legal name (Japan only). - `owners_provided` boolean — Whether the company's owners have been provided. This Boolean will be `true` if you've manually indicated that all owners are provided via [the `owners_provided` parameter](https://stripe.com/docs/api/accounts/update#update_account-company-owners_provided), or if Stripe determined that sufficient owners were provided. Stripe determines ownership requirements using both the number of owners provided and their total percent ownership (calculated by adding the `percent_ownership` of each owner together). - `ownership_declaration` LegalEntityUboDeclaration - `date` integer, nullable — The Unix timestamp marking when the beneficial owner attestation was made. - `ip` string, nullable — The IP address from which the beneficial owner attestation was made. - `user_agent` string, nullable — The user-agent string from the browser where the beneficial owner attestation was made. - `ownership_exemption_reason` 'qualified_entity_exceeds_ownership_threshold' | 'qualifies_as_financial_institution' - `phone` string, nullable — The company's phone number (used for verification). - `structure` 'free_zone_establishment' | 'free_zone_llc' | 'government_instrumentality' | 'governmental_unit' | 'incorporated_non_profit' | 'incorporated_partnership' | 'limited_liability_partnership' | 'llc' | 'multi_member_llc' | 'private_company' | 'private_corporation' | 'private_partnership' | 'public_company' | 'public_corporation' | 'public_partnership' | 'registered_charity' | 'single_member_llc' | 'sole_establishment' | 'sole_proprietorship' | 'tax_exempt_government_instrumentality' | 'unincorporated_association' | 'unincorporated_non_profit' | 'unincorporated_partnership' — The category identifying the legal structure of the company or legal entity. See [Business structure](https://stripe.com/docs/connect/identity-verification#business-structure) for more details. - `tax_id_provided` boolean — Whether the company's business ID number was provided. - `tax_id_registrar` string — The jurisdiction in which the `tax_id` is registered (Germany-based companies only). - `vat_id_provided` boolean — Whether the company's business VAT number was provided. - `verification` LegalEntityCompanyVerification - `document` LegalEntityCompanyVerificationDocument, required - … - `controller` AccountUnificationAccountController - `fees` AccountUnificationAccountControllerFees - `payer` 'account' | 'application' | 'application_custom' | 'application_express', required — A value indicating the responsible payer of a bundle of Stripe fees for pricing-control eligible products on this account. Learn more about [fee behavior on connected accounts](https://docs.stripe.com/connect/direct-charges-fee-payer-behavior). - `is_controller` boolean — `true` if the Connect application retrieving the resource controls the account and can therefore exercise [platform controls](https://stripe.com/docs/connect/platform-controls-for-standard-accounts). Otherwise, this field is null. - `losses` AccountUnificationAccountControllerLosses - `payments` 'application' | 'stripe', required — A value indicating who is liable when this account can't pay back negative balances from payments. - `requirement_collection` 'application' | 'stripe' — A value indicating responsibility for collecting requirements on this account. Only returned when the Connect application retrieving the resource controls the account. - `stripe_dashboard` AccountUnificationAccountControllerStripeDashboard - `type` 'express' | 'full' | 'none', required — A value indicating the Stripe dashboard this account has access to independent of the Connect application. - `type` 'account' | 'application', required — The controller type. Can be `application`, if a Connect application controls the account, or `account`, if the account controls itself. - `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. - `data` union[], required — The list contains all external accounts that have been attached to the Stripe account. These may be bank accounts or cards. - union - … - `has_more` boolean, required — True if this list has another page of items after this one that can be fetched. - `object` 'list', required — String representing the object's type. Objects of the same type share the same value. Always has the value `list`. - `url` string, required — The URL where this list can be accessed. - `future_requirements` AccountFutureRequirements - `alternatives` AccountRequirementsAlternative[], nullable — Fields that are due and can be satisfied by providing the corresponding alternative fields instead. - `alternative_fields_due` string[], required — Fields that can be provided to satisfy all fields in `original_fields_due`. - `original_fields_due` string[], required — Fields that are due and can be satisfied by providing all fields in `alternative_fields_due`. - `current_deadline` integer, nullable — Date on which `future_requirements` becomes the main `requirements` hash and `future_requirements` becomes empty. After the transition, `currently_due` requirements may immediately become `past_due`, but the account may also be given a grace period depending on its enablement state prior to transitioning. - `currently_due` string[], nullable — Fields that need to be collected to keep the account enabled. If not collected by `future_requirements[current_deadline]`, these fields will transition to the main `requirements` hash. - `disabled_reason` 'action_required.requested_capabilities' | 'listed' | 'other' | 'platform_paused' | 'rejected.fraud' | 'rejected.incomplete_verification' | 'rejected.listed' | 'rejected.other' | 'rejected.platform_fraud' | 'rejected.platform_other' | 'rejected.platform_terms_of_service' | 'rejected.terms_of_service' | 'requirements.past_due' | 'requirements.pending_verification' | 'under_review', nullable — This is typed as an enum for consistency with `requirements.disabled_reason`. - `errors` AccountRequirementsError[], nullable — Fields that are `currently_due` and need to be collected again because validation or verification failed. - `code` 'invalid_address_city_state_postal_code' | 'invalid_address_highway_contract_box' | 'invalid_address_private_mailbox' | 'invalid_business_profile_name' | 'invalid_business_profile_name_denylisted' | 'invalid_company_name_denylisted' | 'invalid_dob_age_over_maximum' | 'invalid_dob_age_under_18' | 'invalid_dob_age_under_minimum' | 'invalid_product_description_length' | 'invalid_product_description_url_match' | 'invalid_representative_country' | 'invalid_statement_descriptor_business_mismatch' | 'invalid_statement_descriptor_denylisted' | 'invalid_statement_descriptor_length' | 'invalid_statement_descriptor_prefix_denylisted' | 'invalid_statement_descriptor_prefix_mismatch' | 'invalid_street_address' | 'invalid_tax_id' | 'invalid_tax_id_format' | 'invalid_tos_acceptance' | 'invalid_url_denylisted' | 'invalid_url_format' | 'invalid_url_web_presence_detected' | 'invalid_url_website_business_information_mismatch' | 'invalid_url_website_empty' | 'invalid_url_website_inaccessible' | 'invalid_url_website_inaccessible_geoblocked' | 'invalid_url_website_inaccessible_password_protected' | 'invalid_url_website_incomplete' | 'invalid_url_website_incomplete_cancellation_policy' | 'invalid_url_website_incomplete_customer_service_details' | 'invalid_url_website_incomplete_legal_restrictions' | 'invalid_url_website_incomplete_refund_policy' | 'invalid_url_website_incomplete_return_policy' | 'invalid_url_website_incomplete_terms_and_conditions' | 'invalid_url_website_incomplete_under_construction' | 'invalid_url_website_other' | 'invalid_value_other' | 'verification_directors_mismatch' | 'verification_document_address_mismatch' | 'verification_document_address_missing' | 'verification_document_corrupt' | 'verification_document_country_not_supported' | 'verification_document_directors_mismatch' | 'verification_document_dob_mismatch' | 'verification_document_duplicate_type' | 'verification_document_expired' | 'verification_document_failed_copy' | 'verification_document_failed_greyscale' | 'verification_document_failed_other' | 'verification_document_failed_test_mode' | 'verification_document_fraudulent' | 'verification_document_id_number_mismatch' | 'verification_document_id_number_missing' | 'verification_document_incomplete' | 'verification_document_invalid' | 'verification_document_issue_or_expiry_date_missing' | 'verification_document_manipulated' | 'verification_document_missing_back' | 'verification_document_missing_front' | 'verification_document_name_mismatch' | 'verification_document_name_missing' | 'verification_document_nationality_mismatch' | 'verification_document_not_readable' | 'verification_document_not_signed' | 'verification_document_not_uploaded' | 'verification_document_photo_mismatch' | 'verification_document_too_large' | 'verification_document_type_not_supported' | 'verification_extraneous_directors' | 'verification_failed_address_match' | 'verification_failed_business_iec_number' | 'verification_failed_document_match' | 'verification_failed_id_number_match' | 'verification_failed_keyed_identity' | 'verification_failed_keyed_match' | 'verification_failed_name_match' | 'verification_failed_other' | 'verification_failed_representative_authority' | 'verification_failed_residential_address' | 'verification_failed_tax_id_match' | 'verification_failed_tax_id_not_issued' | 'verification_missing_directors' | 'verification_missing_executives' | 'verification_missing_owners' | 'verification_requires_additional_memorandum_of_associations' | 'verification_requires_additional_proof_of_registration' | 'verification_supportability', required — The code for the type of error. - `reason` string, required — An informative message that indicates the error type and provides additional details about the error. - `requirement` string, required — The specific user onboarding requirement field (in the requirements hash) that needs to be resolved. - `eventually_due` string[], nullable — Fields you must collect when all thresholds are reached. As they become required, they appear in `currently_due` as well. - `past_due` string[], nullable — Fields that weren't collected by `requirements.current_deadline`. These fields need to be collected to enable the capability on the account. New fields will never appear here; `future_requirements.past_due` will always be a subset of `requirements.past_due`. - `pending_verification` string[], nullable — Fields that might become required depending on the results of verification or review. It's an empty array unless an asynchronous verification is pending. If verification fails, these fields move to `eventually_due` or `currently_due`. Fields might appear in `eventually_due` or `currently_due` and in `pending_verification` if verification fails but another verification is still pending. - `groups` AccountGroupMembership - `payments_pricing` string, nullable — The group the account is in to determine their payments pricing, and null if the account is on customized pricing. [See the Platform pricing tool documentation](https://stripe.com/docs/connect/platform-pricing-tools) for details. - `id` string, required — Unique identifier for the object. - `individual` Person — This is an object representing a person associated with a Stripe account. A platform cannot access 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). - `account` string, required — The account the person is associated with. - `additional_tos_acceptances` PersonAdditionalTosAcceptances - `account` PersonAdditionalTosAcceptance - … - `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 (e.g., street, PO Box, or company name). - `line2` string, nullable — Address line 2 (e.g., apartment, suite, unit, or building). - `postal_code` string, nullable — ZIP or postal code. - `state` string, nullable — State, county, province, or region. - `address_kana` LegalEntityJapanAddress - `city` string, nullable — City/Ward. - `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 — Block/Building number. - `line2` string, nullable — Building details. - `postal_code` string, nullable — ZIP or postal code. - `state` string, nullable — Prefecture. - `town` string, nullable — Town/cho-me. - `address_kanji` LegalEntityJapanAddress - `city` string, nullable — City/Ward. - `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 — Block/Building number. - `line2` string, nullable — Building details. - `postal_code` string, nullable — ZIP or postal code. - `state` string, nullable — Prefecture. - `town` string, nullable — Town/cho-me. - `created` integer, required — Time at which the object was created. Measured in seconds since the Unix epoch. - `dob` LegalEntityDob - `day` integer, nullable — The day of birth, between 1 and 31. - `month` integer, nullable — The month of birth, between 1 and 12. - `year` integer, nullable — The four-digit year of birth. - `email` string, nullable — The person's email address. - `first_name` string, nullable — The person's first name. - `first_name_kana` string, nullable — The Kana variation of the person's first name (Japan only). - `first_name_kanji` string, nullable — The Kanji variation of the person's first name (Japan only). - `full_name_aliases` string[] — A list of alternate names or aliases that the person is known by. - `future_requirements` PersonFutureRequirements - `alternatives` AccountRequirementsAlternative[], nullable — Fields that are due and can be satisfied by providing the corresponding alternative fields instead. - … - `currently_due` string[], required — Fields that need to be collected to keep the person's account enabled. If not collected by the account's `future_requirements[current_deadline]`, these fields will transition to the main `requirements` hash, and may immediately become `past_due`, but the account may also be given a grace period depending on the account's enablement state prior to transition. - `errors` AccountRequirementsError[], required — Fields that are `currently_due` and need to be collected again because validation or verification failed. - … - `eventually_due` string[], required — Fields you must collect when all thresholds are reached. As they become required, they appear in `currently_due` as well, and the account's `future_requirements[current_deadline]` becomes set. - `past_due` string[], required — Fields that weren't collected by the account's `requirements.current_deadline`. These fields need to be collected to enable the person's account. New fields will never appear here; `future_requirements.past_due` will always be a subset of `requirements.past_due`. - `pending_verification` string[], required — Fields that might become required depending on the results of verification or review. It's an empty array unless an asynchronous verification is pending. If verification fails, these fields move to `eventually_due` or `currently_due`. Fields might appear in `eventually_due` or `currently_due` and in `pending_verification` if verification fails but another verification is still pending. - `gender` string, nullable — The person's gender. - `id` string, required — Unique identifier for the object. - `id_number_provided` boolean — Whether the person's `id_number` was provided. True if either the full ID number was provided or if only the required part of the ID number was provided (ex. last four of an individual's SSN for the US indicated by `ssn_last_4_provided`). - `id_number_secondary_provided` boolean — Whether the person's `id_number_secondary` was provided. - `last_name` string, nullable — The person's last name. - `last_name_kana` string, nullable — The Kana variation of the person's last name (Japan only). - `last_name_kanji` string, nullable — The Kanji variation of the person's last name (Japan only). - `maiden_name` string, nullable — The person's maiden name. - `metadata` object — Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. - `nationality` string, nullable — The country where the person is a national. - `object` 'person', required — String representing the object's type. Objects of the same type share the same value. - `phone` string, nullable — The person's phone number. - `political_exposure` 'existing' | 'none' — Indicates if the person or any of their representatives, family members, or other closely related persons, declares that they hold or have held an important public job or function, in any jurisdiction. - `registered_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 (e.g., street, PO Box, or company name). - `line2` string, nullable — Address line 2 (e.g., apartment, suite, unit, or building). - `postal_code` string, nullable — ZIP or postal code. - `state` string, nullable — State, county, province, or region. - `relationship` PersonRelationship - `authorizer` boolean, nullable — Whether the person is the authorizer of the account's representative. - `director` boolean, nullable — Whether the person is a director of the account's legal entity. Directors are typically members of the governing board of the company, or responsible for ensuring the company meets its regulatory obligations. - `executive` boolean, nullable — Whether the person has significant responsibility to control, manage, or direct the organization. - `legal_guardian` boolean, nullable — Whether the person is the legal guardian of the account's representative. - `owner` boolean, nullable — Whether the person is an owner of the account’s legal entity. - `percent_ownership` number, nullable — The percent owned by the person of the account's legal entity. - `representative` boolean, nullable — Whether the person is authorized as the primary representative of the account. This is the person nominated by the business to provide information about themselves, and general information about the account. There can only be one representative at any given time. At the time the account is created, this person should be set to the person responsible for opening the account. - `title` string, nullable — The person's title (e.g., CEO, Support Engineer). - `requirements` PersonRequirements - `alternatives` AccountRequirementsAlternative[], nullable — Fields that are due and can be satisfied by providing the corresponding alternative fields instead. - … - `currently_due` string[], required — Fields that need to be collected to keep the person's account enabled. If not collected by the account's `current_deadline`, these fields appear in `past_due` as well, and the account is disabled. - `errors` AccountRequirementsError[], required — Fields that are `currently_due` and need to be collected again because validation or verification failed. - … - `eventually_due` string[], required — Fields you must collect when all thresholds are reached. As they become required, they appear in `currently_due` as well, and the account's `current_deadline` becomes set. - `past_due` string[], required — Fields that weren't collected by the account's `current_deadline`. These fields need to be collected to enable the person's account. - `pending_verification` string[], required — Fields that might become required depending on the results of verification or review. It's an empty array unless an asynchronous verification is pending. If verification fails, these fields move to `eventually_due`, `currently_due`, or `past_due`. Fields might appear in `eventually_due`, `currently_due`, or `past_due` and in `pending_verification` if verification fails but another verification is still pending. - `ssn_last_4_provided` boolean — Whether the last four digits of the person's Social Security number have been provided (U.S. only). - `verification` LegalEntityPersonVerification - `additional_document` LegalEntityPersonVerificationDocument - … - `details` string, nullable — A user-displayable string describing the verification state for the person. For example, this may say "Provided identity information could not be verified". - `details_code` string, nullable — One of `document_address_mismatch`, `document_dob_mismatch`, `document_duplicate_type`, `document_id_number_mismatch`, `document_name_mismatch`, `document_nationality_mismatch`, `failed_keyed_identity`, or `failed_other`. A machine-readable code specifying the verification state for the person. - `document` LegalEntityPersonVerificationDocument - … - `status` string, required — The state of verification for the person. Possible values are `unverified`, `pending`, or `verified`. - `metadata` object — Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. - `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 - `alternatives` AccountRequirementsAlternative[], nullable — Fields that are due and can be satisfied by providing the corresponding alternative fields instead. - `alternative_fields_due` string[], required — Fields that can be provided to satisfy all fields in `original_fields_due`. - `original_fields_due` string[], required — Fields that are due and can be satisfied by providing all fields in `alternative_fields_due`. - `current_deadline` integer, nullable — Date by which the fields in `currently_due` must be collected to keep the account enabled. These fields may disable the account sooner if the next threshold is reached before they are collected. - `currently_due` string[], nullable — Fields that need to be collected to keep the account enabled. If not collected by `current_deadline`, these fields appear in `past_due` as well, and the account is disabled. - `disabled_reason` 'action_required.requested_capabilities' | 'listed' | 'other' | 'platform_paused' | 'rejected.fraud' | 'rejected.incomplete_verification' | 'rejected.listed' | 'rejected.other' | 'rejected.platform_fraud' | 'rejected.platform_other' | 'rejected.platform_terms_of_service' | 'rejected.terms_of_service' | 'requirements.past_due' | 'requirements.pending_verification' | 'under_review', nullable — If the account is disabled, this enum describes why. [Learn more about handling verification issues](https://stripe.com/docs/connect/handling-api-verification). - `errors` AccountRequirementsError[], nullable — Fields that are `currently_due` and need to be collected again because validation or verification failed. - `code` 'invalid_address_city_state_postal_code' | 'invalid_address_highway_contract_box' | 'invalid_address_private_mailbox' | 'invalid_business_profile_name' | 'invalid_business_profile_name_denylisted' | 'invalid_company_name_denylisted' | 'invalid_dob_age_over_maximum' | 'invalid_dob_age_under_18' | 'invalid_dob_age_under_minimum' | 'invalid_product_description_length' | 'invalid_product_description_url_match' | 'invalid_representative_country' | 'invalid_statement_descriptor_business_mismatch' | 'invalid_statement_descriptor_denylisted' | 'invalid_statement_descriptor_length' | 'invalid_statement_descriptor_prefix_denylisted' | 'invalid_statement_descriptor_prefix_mismatch' | 'invalid_street_address' | 'invalid_tax_id' | 'invalid_tax_id_format' | 'invalid_tos_acceptance' | 'invalid_url_denylisted' | 'invalid_url_format' | 'invalid_url_web_presence_detected' | 'invalid_url_website_business_information_mismatch' | 'invalid_url_website_empty' | 'invalid_url_website_inaccessible' | 'invalid_url_website_inaccessible_geoblocked' | 'invalid_url_website_inaccessible_password_protected' | 'invalid_url_website_incomplete' | 'invalid_url_website_incomplete_cancellation_policy' | 'invalid_url_website_incomplete_customer_service_details' | 'invalid_url_website_incomplete_legal_restrictions' | 'invalid_url_website_incomplete_refund_policy' | 'invalid_url_website_incomplete_return_policy' | 'invalid_url_website_incomplete_terms_and_conditions' | 'invalid_url_website_incomplete_under_construction' | 'invalid_url_website_other' | 'invalid_value_other' | 'verification_directors_mismatch' | 'verification_document_address_mismatch' | 'verification_document_address_missing' | 'verification_document_corrupt' | 'verification_document_country_not_supported' | 'verification_document_directors_mismatch' | 'verification_document_dob_mismatch' | 'verification_document_duplicate_type' | 'verification_document_expired' | 'verification_document_failed_copy' | 'verification_document_failed_greyscale' | 'verification_document_failed_other' | 'verification_document_failed_test_mode' | 'verification_document_fraudulent' | 'verification_document_id_number_mismatch' | 'verification_document_id_number_missing' | 'verification_document_incomplete' | 'verification_document_invalid' | 'verification_document_issue_or_expiry_date_missing' | 'verification_document_manipulated' | 'verification_document_missing_back' | 'verification_document_missing_front' | 'verification_document_name_mismatch' | 'verification_document_name_missing' | 'verification_document_nationality_mismatch' | 'verification_document_not_readable' | 'verification_document_not_signed' | 'verification_document_not_uploaded' | 'verification_document_photo_mismatch' | 'verification_document_too_large' | 'verification_document_type_not_supported' | 'verification_extraneous_directors' | 'verification_failed_address_match' | 'verification_failed_business_iec_number' | 'verification_failed_document_match' | 'verification_failed_id_number_match' | 'verification_failed_keyed_identity' | 'verification_failed_keyed_match' | 'verification_failed_name_match' | 'verification_failed_other' | 'verification_failed_representative_authority' | 'verification_failed_residential_address' | 'verification_failed_tax_id_match' | 'verification_failed_tax_id_not_issued' | 'verification_missing_directors' | 'verification_missing_executives' | 'verification_missing_owners' | 'verification_requires_additional_memorandum_of_associations' | 'verification_requires_additional_proof_of_registration' | 'verification_supportability', required — The code for the type of error. - `reason` string, required — An informative message that indicates the error type and provides additional details about the error. - `requirement` string, required — The specific user onboarding requirement field (in the requirements hash) that needs to be resolved. - `eventually_due` string[], nullable — Fields you must collect when all thresholds are reached. As they become required, they appear in `currently_due` as well, and `current_deadline` becomes set. - `past_due` string[], nullable — Fields that weren't collected by `current_deadline`. These fields need to be collected to enable the account. - `pending_verification` string[], nullable — Fields that might become required depending on the results of verification or review. It's an empty array unless an asynchronous verification is pending. If verification fails, these fields move to `eventually_due`, `currently_due`, or `past_due`. Fields might appear in `eventually_due`, `currently_due`, or `past_due` and in `pending_verification` if verification fails but another verification is still pending. - `settings` AccountSettings - `bacs_debit_payments` AccountBacsDebitPaymentsSettings - `display_name` string, nullable — The Bacs Direct Debit display name for this account. For payments made with Bacs Direct Debit, this name appears on the mandate as the statement descriptor. Mobile banking apps display it as the name of the business. To use custom branding, set the Bacs Direct Debit Display Name during or right after creation. Custom branding incurs an additional monthly fee for the platform. The fee appears 5 business days after requesting Bacs. If you don't set the display name before requesting Bacs capability, it's automatically set as "Stripe" and the account is onboarded to Stripe branding, which is free. - `service_user_number` string, nullable — The Bacs Direct Debit Service user number for this account. For payments made with Bacs Direct Debit, this number is a unique identifier of the account with our banking partners. - `branding` AccountBrandingSettings, required - `icon` union — (ID of a [file upload](https://stripe.com/docs/guides/file-upload)) An icon for the account. Must be square and at least 128px x 128px. - … - `logo` union — (ID of a [file upload](https://stripe.com/docs/guides/file-upload)) A logo for the account that will be used in Checkout instead of the icon and without the account's name next to it if provided. Must be at least 128px x 128px. - … - `primary_color` string, nullable — A CSS hex color value representing the primary branding color for this account - `secondary_color` string, nullable — A CSS hex color value representing the secondary branding color for this account - `card_issuing` AccountCardIssuingSettings - `tos_acceptance` CardIssuingAccountTermsOfService - … - `card_payments` AccountCardPaymentsSettings, required - `decline_on` AccountDeclineChargeOn - … - `statement_descriptor_prefix` string, nullable — The default text that appears on credit card statements when a charge is made. This field prefixes any dynamic `statement_descriptor` specified on the charge. `statement_descriptor_prefix` is useful for maximizing descriptor space for the dynamic portion. - `statement_descriptor_prefix_kana` string, nullable — The Kana variation of the default text that appears on credit card statements when a charge is made (Japan only). This field prefixes any dynamic `statement_descriptor_suffix_kana` specified on the charge. `statement_descriptor_prefix_kana` is useful for maximizing descriptor space for the dynamic portion. - `statement_descriptor_prefix_kanji` string, nullable — The Kanji variation of the default text that appears on credit card statements when a charge is made (Japan only). This field prefixes any dynamic `statement_descriptor_suffix_kanji` specified on the charge. `statement_descriptor_prefix_kanji` is useful for maximizing descriptor space for the dynamic portion. - `dashboard` AccountDashboardSettings, required - `display_name` string, nullable — The display name for this account. This is used on the Stripe Dashboard to differentiate between accounts. - `timezone` string, nullable — The timezone used in the Stripe Dashboard for this account. A list of possible time zone values is maintained at the [IANA Time Zone Database](http://www.iana.org/time-zones). - `invoices` AccountInvoicesSettings - `default_account_tax_ids` union[], nullable — The list of default Account Tax IDs to automatically include on invoices. Account Tax IDs get added when an invoice is finalized. - … - `payments` AccountPaymentsSettings, required - `statement_descriptor` string, nullable — The default text that appears on credit card statements when a charge is made. This field prefixes any dynamic `statement_descriptor` specified on the charge. - `statement_descriptor_kana` string, nullable — The Kana variation of `statement_descriptor` used for charges in Japan. Japanese statement descriptors have [special requirements](https://docs.stripe.com/get-started/account/statement-descriptors#set-japanese-statement-descriptors). - `statement_descriptor_kanji` string, nullable — The Kanji variation of `statement_descriptor` used for charges in Japan. Japanese statement descriptors have [special requirements](https://docs.stripe.com/get-started/account/statement-descriptors#set-japanese-statement-descriptors). - `statement_descriptor_prefix_kana` string, nullable — The Kana variation of `statement_descriptor_prefix` used for card charges in Japan. Japanese statement descriptors have [special requirements](https://docs.stripe.com/get-started/account/statement-descriptors#set-japanese-statement-descriptors). - `statement_descriptor_prefix_kanji` string, nullable — The Kanji variation of `statement_descriptor_prefix` used for card charges in Japan. Japanese statement descriptors have [special requirements](https://docs.stripe.com/get-started/account/statement-descriptors#set-japanese-statement-descriptors). - `payouts` AccountPayoutSettings - `debit_negative_balances` boolean, required — A Boolean indicating if Stripe should try to reclaim negative balances from an attached bank account. See [Understanding Connect account balances](/connect/account-balances) for details. The default value is `false` when [controller.requirement_collection](/api/accounts/object#account_object-controller-requirement_collection) is `application`, which includes Custom accounts, otherwise `true`. - `schedule` TransferSchedule, required - … - `statement_descriptor` string, nullable — The text that appears on the bank account statement for payouts. If not set, this defaults to the platform's bank descriptor as set in the Dashboard. - `sepa_debit_payments` AccountSepaDebitPaymentsSettings - `creditor_id` string — SEPA creditor identifier that identifies the company making the payment. - `treasury` AccountTreasurySettings - `tos_acceptance` AccountTermsOfService - … - `tos_acceptance` AccountTosAcceptance - `date` integer, nullable — The Unix timestamp marking when the account representative accepted their service agreement - `ip` string, nullable — The IP address from which the account representative accepted their service agreement - `service_agreement` string — The user's service agreement type - `user_agent` string, nullable — The user agent of the browser from which the account representative accepted their service agreement - `type` 'custom' | 'express' | 'none' | 'standard' — The Stripe account type. Can be `standard`, `express`, `custom`, or `none`. - `payment_method` union, required — ID of the payment method used with this SetupAttempt. - string - PaymentMethod — PaymentMethod objects represent your customer's payment instruments. You can use them with [PaymentIntents](https://stripe.com/docs/payments/payment-intents) to collect payments or save them to Customer objects to store instrument details for future payments. Related guides: [Payment Methods](https://stripe.com/docs/payments/payment-methods) and [More Payment Scenarios](https://stripe.com/docs/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 - `billing_details` BillingDetails, required - `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 (e.g., street, PO Box, or company name). - `line2` string, nullable — Address line 2 (e.g., apartment, suite, unit, or building). - `postal_code` string, nullable — ZIP or postal code. - `state` string, nullable — State, county, province, or region. - `email` string, nullable — Email address. - `name` string, nullable — Full name. - `phone` string, nullable — Billing phone number (including extension). - `blik` PaymentMethodBlik - `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`, `diners`, `discover`, `eftpos_au`, `jcb`, `link`, `mastercard`, `unionpay`, `visa`, or `unknown`. - `checks` PaymentMethodCardChecks - `address_line1_check` string, nullable — If a address line1 was provided, results of the check, one of `pass`, `fail`, `unavailable`, or `unchecked`. - `address_postal_code_check` string, nullable — If a address postal code was provided, results of the check, one of `pass`, `fail`, `unavailable`, or `unchecked`. - `cvc_check` string, nullable — If a CVC was provided, results of the check, one of `pass`, `fail`, `unavailable`, or `unchecked`. - `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 - `charge` string, nullable — The charge that created this object. - `payment_method_details` CardGeneratedFromPaymentMethodDetails - … - `setup_attempt` union — The ID of the SetupAttempt that generated this PaymentMethod, if any. - … - `last4` string, required — The last four digits of the card. - `networks` Networks - `available` string[], required — All available networks for the card. - `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. - `regulated_status` 'regulated' | 'unregulated', nullable — Status of a card based on the card issuer. - `three_d_secure_usage` ThreeDSecureUsage - `supported` boolean, required — Whether 3D Secure is supported on this card. - `wallet` PaymentMethodCardWallet - `amex_express_checkout` PaymentMethodCardWalletAmexExpressCheckout - `apple_pay` PaymentMethodCardWalletApplePay - `dynamic_last4` string, nullable — (For tokenized numbers only.) The last four digits of the device account number. - `google_pay` PaymentMethodCardWalletGooglePay - `link` PaymentMethodCardWalletLink - `masterpass` PaymentMethodCardWalletMasterpass - … - `samsung_pay` PaymentMethodCardWalletSamsungPay - `type` 'amex_express_checkout' | 'apple_pay' | 'google_pay' | 'link' | 'masterpass' | 'samsung_pay' | 'visa_checkout', required — The type of the card wallet, one of `amex_express_checkout`, `apple_pay`, `google_pay`, `masterpass`, `samsung_pay`, `visa_checkout`, or `link`. An additional hash is included on the Wallet subhash with a name matching this value. It contains additional information specific to the card wallet type. - `visa_checkout` PaymentMethodCardWalletVisaCheckout - … - `card_present` PaymentMethodCardPresent - `brand` string, nullable — Card brand. Can be `amex`, `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 - `available` string[], required — All available networks for the card. - `preferred` string, nullable — The preferred network for the card. - `offline` PaymentMethodDetailsCardPresentOffline - `stored_at` integer, nullable — Time at which the payment was collected while offline - `type` 'deferred', nullable — The method used to process this payment method offline. Only deferred is allowed. - `preferred_locales` string[], nullable — EMV tag 5F2D. Preferred languages specified by the integrated circuit 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 - `type` 'apple_pay' | 'google_pay' | 'samsung_pay' | 'unknown', required — The type of mobile wallet, one of `apple_pay`, `google_pay`, `samsung_pay`, or `unknown`. - `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. - `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://stripe.com/docs/invoicing/customer), [save payment](https://stripe.com/docs/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. 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. - `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. - `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://stripe.com/docs/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://stripe.com/docs/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://stripe.com/docs/api#coupons) or [promotion code](https://stripe.com/docs/api#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://stripe.com/docs/billing/subscriptions/discounts) - … - `email` string, nullable — The customer's email address. - `id` string, required — Unique identifier for the object. - `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 — Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. - `metadata` object — Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. - `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. - … - `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' | 'bsn' | 'cimb' | 'deutsche_bank' | 'hong_leong_bank' | 'hsbc' | 'kfh' | 'maybank2e' | 'maybank2u' | '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`, `bank_rakyat`, `bsn`, `cimb`, `hong_leong_bank`, `hsbc`, `kfh`, `maybank2u`, `ocbc`, `public_bank`, `rhb`, `standard_chartered`, `uob`, `deutsche_bank`, `maybank2e`, `pb_enterprise`, or `bank_of_china`. - `giropay` PaymentMethodGiropay - `grabpay` PaymentMethodGrabpay - `id` string, required — Unique identifier for the object. - `ideal` PaymentMethodIdeal - `bank` 'abn_amro' | 'asn_bank' | 'bunq' | 'handelsbanken' | 'ing' | 'knab' | '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`, `asn_bank`, `bunq`, `handelsbanken`, `ing`, `knab`, `moneyou`, `n26`, `nn`, `rabobank`, `regiobank`, `revolut`, `sns_bank`, `triodos_bank`, `van_lanschot`, or `yoursafe`. - `bic` 'ABNANL2A' | 'ASNBNL21' | 'BITSNL2A' | 'BUNQNL2A' | 'FVLBNL22' | 'HANDNL2A' | 'INGBNL2A' | 'KNABNL2H' | '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 - `available` string[], required — All available networks for the card. - `preferred` string, nullable — The preferred network for the card. - `preferred_locales` string[], nullable — EMV tag 5F2D. Preferred languages specified by the integrated circuit 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 - `day` integer, nullable — The day of birth, between 1 and 31. - `month` integer, nullable — The month of birth, between 1 and 12. - `year` integer, nullable — The four-digit year of birth. - `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 — Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. - `metadata` object, nullable — Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. - `mobilepay` PaymentMethodMobilepay - `multibanco` PaymentMethodMultibanco - `naver_pay` PaymentMethodNaverPay - `funding` 'card' | 'points', required — Whether to fund this transaction with Naver Pay points or a card. - `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. - `pix` PaymentMethodPix - `promptpay` PaymentMethodPromptpay - `radar_options` RadarRadarOptions — Options to configure Radar. See [Radar Session](https://stripe.com/docs/radar/radar-session) for more information. - `session` string — A [Radar Session](https://stripe.com/docs/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 - `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 - `charge` union — The ID of the Charge that generated this PaymentMethod, if any. - … - `setup_attempt` union — The ID of the SetupAttempt that generated this PaymentMethod, if any. - … - `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. - `swish` PaymentMethodSwish - `twint` PaymentMethodTwint - `type` 'acss_debit' | 'affirm' | 'afterpay_clearpay' | 'alipay' | 'alma' | 'amazon_pay' | 'au_becs_debit' | 'bacs_debit' | 'bancontact' | 'blik' | 'boleto' | 'card' | 'card_present' | 'cashapp' | 'customer_balance' | 'eps' | 'fpx' | 'giropay' | 'grabpay' | 'ideal' | 'interac_present' | 'kakao_pay' | 'klarna' | 'konbini' | 'kr_card' | 'link' | 'mobilepay' | 'multibanco' | 'naver_pay' | 'oxxo' | 'p24' | 'pay_by_bank' | 'payco' | 'paynow' | 'paypal' | 'pix' | 'promptpay' | 'revolut_pay' | 'samsung_pay' | 'sepa_debit' | 'sofort' | 'swish' | 'twint' | '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. - `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 - `preferred` string, nullable — The preferred network. - `supported` string[], required — All supported networks. - `routing_number` string, nullable — Routing number of the bank account. - `status_details` PaymentMethodUsBankAccountStatusDetails - `blocked` PaymentMethodUsBankAccountBlocked - … - `wechat_pay` PaymentMethodWechatPay - `zip` PaymentMethodZip - `payment_method_details` SetupAttemptPaymentMethodDetails, required - `acss_debit` SetupAttemptPaymentMethodDetailsAcssDebit - `amazon_pay` SetupAttemptPaymentMethodDetailsAmazonPay - `au_becs_debit` SetupAttemptPaymentMethodDetailsAuBecsDebit - `bacs_debit` SetupAttemptPaymentMethodDetailsBacsDebit - `bancontact` SetupAttemptPaymentMethodDetailsBancontact - `bank_code` string, nullable — Bank code of bank associated with the bank account. - `bank_name` string, nullable — Name of the bank associated with the bank account. - `bic` string, nullable — Bank Identifier Code of the bank associated with the bank account. - `generated_sepa_debit` union — The ID of the SEPA Direct Debit PaymentMethod which was generated by this SetupAttempt. - string - PaymentMethod — PaymentMethod objects represent your customer's payment instruments. You can use them with [PaymentIntents](https://stripe.com/docs/payments/payment-intents) to collect payments or save them to Customer objects to store instrument details for future payments. Related guides: [Payment Methods](https://stripe.com/docs/payments/payment-methods) and [More Payment Scenarios](https://stripe.com/docs/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 - `billing_details` BillingDetails, required - … - `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. - `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_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 — Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. - `metadata` object, nullable — Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. - `mobilepay` PaymentMethodMobilepay - `multibanco` PaymentMethodMultibanco - `naver_pay` PaymentMethodNaverPay - … - `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 - … - `pix` PaymentMethodPix - `promptpay` PaymentMethodPromptpay - `radar_options` RadarRadarOptions — Options to configure Radar. See [Radar Session](https://stripe.com/docs/radar/radar-session) for more information. - … - `revolut_pay` PaymentMethodRevolutPay - `samsung_pay` PaymentMethodSamsungPay - `sepa_debit` PaymentMethodSepaDebit - … - `sofort` PaymentMethodSofort - … - `swish` PaymentMethodSwish - `twint` PaymentMethodTwint - `type` 'acss_debit' | 'affirm' | 'afterpay_clearpay' | 'alipay' | 'alma' | 'amazon_pay' | 'au_becs_debit' | 'bacs_debit' | 'bancontact' | 'blik' | 'boleto' | 'card' | 'card_present' | 'cashapp' | 'customer_balance' | 'eps' | 'fpx' | 'giropay' | 'grabpay' | 'ideal' | 'interac_present' | 'kakao_pay' | 'klarna' | 'konbini' | 'kr_card' | 'link' | 'mobilepay' | 'multibanco' | 'naver_pay' | 'oxxo' | 'p24' | 'pay_by_bank' | 'payco' | 'paynow' | 'paypal' | 'pix' | 'promptpay' | 'revolut_pay' | 'samsung_pay' | 'sepa_debit' | 'sofort' | 'swish' | 'twint' | '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. - `us_bank_account` PaymentMethodUsBankAccount - … - `wechat_pay` PaymentMethodWechatPay - `zip` PaymentMethodZip - `generated_sepa_debit_mandate` union — The mandate for the SEPA Direct Debit PaymentMethod which was generated by this SetupAttempt. - string - Mandate — A Mandate is a record of the permission that your customer gives you to debit their payment method. - `customer_acceptance` CustomerAcceptance, required - … - `id` string, required — Unique identifier for the object. - `livemode` boolean, required — Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. - `multi_use` MandateMultiUse - `object` 'mandate', required — String representing the object's type. Objects of the same type share the same value. - `on_behalf_of` string — The account (if any) that the mandate is intended for. - `payment_method` union, required — ID of the payment method associated with this mandate. - … - `payment_method_details` MandatePaymentMethodDetails, required - … - `single_use` MandateSingleUse - … - `status` 'active' | 'inactive' | 'pending', required — The mandate status indicates whether or not you can use it to initiate a payment. - `type` 'multi_use' | 'single_use', required — The type of the mandate. - `iban_last4` string, nullable — Last four characters of the IBAN. - `preferred_language` 'de' | 'en' | 'fr' | 'nl', nullable — Preferred language of the Bancontact authorization page that the customer is redirected to. Can be one of `en`, `de`, `fr`, or `nl` - `verified_name` string, nullable — Owner's verified full name. Values are verified or provided by Bancontact directly (if supported) at the time of authorization or settlement. They cannot be set or mutated. - `boleto` SetupAttemptPaymentMethodDetailsBoleto - `card` SetupAttemptPaymentMethodDetailsCard - `brand` string, nullable — Card brand. Can be `amex`, `diners`, `discover`, `eftpos_au`, `jcb`, `link`, `mastercard`, `unionpay`, `visa`, or `unknown`. - `checks` SetupAttemptPaymentMethodDetailsCardChecks - `address_line1_check` string, nullable — If a address line1 was provided, results of the check, one of `pass`, `fail`, `unavailable`, or `unchecked`. - `address_postal_code_check` string, nullable — If a address postal code was provided, results of the check, one of `pass`, `fail`, `unavailable`, or `unchecked`. - `cvc_check` string, nullable — If a CVC was provided, results of the check, one of `pass`, `fail`, `unavailable`, or `unchecked`. - `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. - `exp_month` integer, nullable — Two-digit number representing the card's expiration month. - `exp_year` integer, nullable — 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`. - `last4` string, nullable — The last four digits of the card. - `network` string, nullable — Identifies which network this charge was processed on. Can be `amex`, `cartes_bancaires`, `diners`, `discover`, `eftpos_au`, `interac`, `jcb`, `link`, `mastercard`, `unionpay`, `visa`, or `unknown`. - `three_d_secure` ThreeDSecureDetails - `authentication_flow` 'challenge' | 'frictionless', nullable — For authenticated transactions: how the customer was authenticated by the issuing bank. - `electronic_commerce_indicator` '01' | '02' | '05' | '06' | '07', nullable — The Electronic Commerce Indicator (ECI). A protocol-level field indicating what degree of authentication was performed. - `result` 'attempt_acknowledged' | 'authenticated' | 'exempted' | 'failed' | 'not_supported' | 'processing_error', nullable — Indicates the outcome of 3D Secure authentication. - `result_reason` 'abandoned' | 'bypassed' | 'canceled' | 'card_not_enrolled' | 'network_not_supported' | 'protocol_error' | 'rejected', nullable — Additional information about why 3D Secure succeeded or failed based on the `result`. - `transaction_id` string, nullable — The 3D Secure 1 XID or 3D Secure 2 Directory Server Transaction ID (dsTransId) for this payment. - `version` '1.0.2' | '2.1.0' | '2.2.0', nullable — The version of 3D Secure that was used. - `wallet` SetupAttemptPaymentMethodDetailsCardWallet - `apple_pay` PaymentMethodDetailsCardWalletApplePay - `google_pay` PaymentMethodDetailsCardWalletGooglePay - `type` 'apple_pay' | 'google_pay' | 'link', required — The type of the card wallet, one of `apple_pay`, `google_pay`, or `link`. An additional hash is included on the Wallet subhash with a name matching this value. It contains additional information specific to the card wallet type. - `card_present` SetupAttemptPaymentMethodDetailsCardPresent - `generated_card` union — The ID of the Card PaymentMethod which was generated by this SetupAttempt. - string - PaymentMethod — PaymentMethod objects represent your customer's payment instruments. You can use them with [PaymentIntents](https://stripe.com/docs/payments/payment-intents) to collect payments or save them to Customer objects to store instrument details for future payments. Related guides: [Payment Methods](https://stripe.com/docs/payments/payment-methods) and [More Payment Scenarios](https://stripe.com/docs/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 - `billing_details` BillingDetails, required - … - `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. - `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_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 — Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. - `metadata` object, nullable — Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. - `mobilepay` PaymentMethodMobilepay - `multibanco` PaymentMethodMultibanco - `naver_pay` PaymentMethodNaverPay - … - `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 - … - `pix` PaymentMethodPix - `promptpay` PaymentMethodPromptpay - `radar_options` RadarRadarOptions — Options to configure Radar. See [Radar Session](https://stripe.com/docs/radar/radar-session) for more information. - … - `revolut_pay` PaymentMethodRevolutPay - `samsung_pay` PaymentMethodSamsungPay - `sepa_debit` PaymentMethodSepaDebit - … - `sofort` PaymentMethodSofort - … - `swish` PaymentMethodSwish - `twint` PaymentMethodTwint - `type` 'acss_debit' | 'affirm' | 'afterpay_clearpay' | 'alipay' | 'alma' | 'amazon_pay' | 'au_becs_debit' | 'bacs_debit' | 'bancontact' | 'blik' | 'boleto' | 'card' | 'card_present' | 'cashapp' | 'customer_balance' | 'eps' | 'fpx' | 'giropay' | 'grabpay' | 'ideal' | 'interac_present' | 'kakao_pay' | 'klarna' | 'konbini' | 'kr_card' | 'link' | 'mobilepay' | 'multibanco' | 'naver_pay' | 'oxxo' | 'p24' | 'pay_by_bank' | 'payco' | 'paynow' | 'paypal' | 'pix' | 'promptpay' | 'revolut_pay' | 'samsung_pay' | 'sepa_debit' | 'sofort' | 'swish' | 'twint' | '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. - `us_bank_account` PaymentMethodUsBankAccount - … - `wechat_pay` PaymentMethodWechatPay - `zip` PaymentMethodZip - `offline` PaymentMethodDetailsCardPresentOffline - `stored_at` integer, nullable — Time at which the payment was collected while offline - `type` 'deferred', nullable — The method used to process this payment method offline. Only deferred is allowed. - `cashapp` SetupAttemptPaymentMethodDetailsCashapp - `ideal` SetupAttemptPaymentMethodDetailsIdeal - `bank` 'abn_amro' | 'asn_bank' | 'bunq' | 'handelsbanken' | 'ing' | 'knab' | 'moneyou' | 'n26' | 'nn' | 'rabobank' | 'regiobank' | 'revolut' | 'sns_bank' | 'triodos_bank' | 'van_lanschot' | 'yoursafe', nullable — The customer's bank. Can be one of `abn_amro`, `asn_bank`, `bunq`, `handelsbanken`, `ing`, `knab`, `moneyou`, `n26`, `nn`, `rabobank`, `regiobank`, `revolut`, `sns_bank`, `triodos_bank`, `van_lanschot`, or `yoursafe`. - `bic` 'ABNANL2A' | 'ASNBNL21' | 'BITSNL2A' | 'BUNQNL2A' | 'FVLBNL22' | 'HANDNL2A' | 'INGBNL2A' | 'KNABNL2H' | 'MOYONL21' | 'NNBANL2G' | 'NTSBDEB1' | 'RABONL2U' | 'RBRBNL21' | 'REVOIE23' | 'REVOLT21' | 'SNSBNL2A' | 'TRIONL2U', nullable — The Bank Identifier Code of the customer's bank. - `generated_sepa_debit` union — The ID of the SEPA Direct Debit PaymentMethod which was generated by this SetupAttempt. - string - PaymentMethod — PaymentMethod objects represent your customer's payment instruments. You can use them with [PaymentIntents](https://stripe.com/docs/payments/payment-intents) to collect payments or save them to Customer objects to store instrument details for future payments. Related guides: [Payment Methods](https://stripe.com/docs/payments/payment-methods) and [More Payment Scenarios](https://stripe.com/docs/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 - `billing_details` BillingDetails, required - … - `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. - `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_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 — Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. - `metadata` object, nullable — Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. - `mobilepay` PaymentMethodMobilepay - `multibanco` PaymentMethodMultibanco - `naver_pay` PaymentMethodNaverPay - … - `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 - … - `pix` PaymentMethodPix - `promptpay` PaymentMethodPromptpay - `radar_options` RadarRadarOptions — Options to configure Radar. See [Radar Session](https://stripe.com/docs/radar/radar-session) for more information. - … - `revolut_pay` PaymentMethodRevolutPay - `samsung_pay` PaymentMethodSamsungPay - `sepa_debit` PaymentMethodSepaDebit - … - `sofort` PaymentMethodSofort - … - `swish` PaymentMethodSwish - `twint` PaymentMethodTwint - `type` 'acss_debit' | 'affirm' | 'afterpay_clearpay' | 'alipay' | 'alma' | 'amazon_pay' | 'au_becs_debit' | 'bacs_debit' | 'bancontact' | 'blik' | 'boleto' | 'card' | 'card_present' | 'cashapp' | 'customer_balance' | 'eps' | 'fpx' | 'giropay' | 'grabpay' | 'ideal' | 'interac_present' | 'kakao_pay' | 'klarna' | 'konbini' | 'kr_card' | 'link' | 'mobilepay' | 'multibanco' | 'naver_pay' | 'oxxo' | 'p24' | 'pay_by_bank' | 'payco' | 'paynow' | 'paypal' | 'pix' | 'promptpay' | 'revolut_pay' | 'samsung_pay' | 'sepa_debit' | 'sofort' | 'swish' | 'twint' | '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. - `us_bank_account` PaymentMethodUsBankAccount - … - `wechat_pay` PaymentMethodWechatPay - `zip` PaymentMethodZip - `generated_sepa_debit_mandate` union — The mandate for the SEPA Direct Debit PaymentMethod which was generated by this SetupAttempt. - string - Mandate — A Mandate is a record of the permission that your customer gives you to debit their payment method. - `customer_acceptance` CustomerAcceptance, required - … - `id` string, required — Unique identifier for the object. - `livemode` boolean, required — Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. - `multi_use` MandateMultiUse - `object` 'mandate', required — String representing the object's type. Objects of the same type share the same value. - `on_behalf_of` string — The account (if any) that the mandate is intended for. - `payment_method` union, required — ID of the payment method associated with this mandate. - … - `payment_method_details` MandatePaymentMethodDetails, required - … - `single_use` MandateSingleUse - … - `status` 'active' | 'inactive' | 'pending', required — The mandate status indicates whether or not you can use it to initiate a payment. - `type` 'multi_use' | 'single_use', required — The type of the mandate. - `iban_last4` string, nullable — Last four characters of the IBAN. - `verified_name` string, nullable — Owner's verified full name. Values are verified or provided by iDEAL directly (if supported) at the time of authorization or settlement. They cannot be set or mutated. - `kakao_pay` SetupAttemptPaymentMethodDetailsKakaoPay - `klarna` SetupAttemptPaymentMethodDetailsKlarna - `kr_card` SetupAttemptPaymentMethodDetailsKrCard - `link` SetupAttemptPaymentMethodDetailsLink - `paypal` SetupAttemptPaymentMethodDetailsPaypal - `revolut_pay` SetupAttemptPaymentMethodDetailsRevolutPay - `sepa_debit` SetupAttemptPaymentMethodDetailsSepaDebit - `sofort` SetupAttemptPaymentMethodDetailsSofort - `bank_code` string, nullable — Bank code of bank associated with the bank account. - `bank_name` string, nullable — Name of the bank associated with the bank account. - `bic` string, nullable — Bank Identifier Code of the bank associated with the bank account. - `generated_sepa_debit` union — The ID of the SEPA Direct Debit PaymentMethod which was generated by this SetupAttempt. - string - PaymentMethod — PaymentMethod objects represent your customer's payment instruments. You can use them with [PaymentIntents](https://stripe.com/docs/payments/payment-intents) to collect payments or save them to Customer objects to store instrument details for future payments. Related guides: [Payment Methods](https://stripe.com/docs/payments/payment-methods) and [More Payment Scenarios](https://stripe.com/docs/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 - `billing_details` BillingDetails, required - … - `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. - `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_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 — Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. - `metadata` object, nullable — Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. - `mobilepay` PaymentMethodMobilepay - `multibanco` PaymentMethodMultibanco - `naver_pay` PaymentMethodNaverPay - … - `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 - … - `pix` PaymentMethodPix - `promptpay` PaymentMethodPromptpay - `radar_options` RadarRadarOptions — Options to configure Radar. See [Radar Session](https://stripe.com/docs/radar/radar-session) for more information. - … - `revolut_pay` PaymentMethodRevolutPay - `samsung_pay` PaymentMethodSamsungPay - `sepa_debit` PaymentMethodSepaDebit - … - `sofort` PaymentMethodSofort - … - `swish` PaymentMethodSwish - `twint` PaymentMethodTwint - `type` 'acss_debit' | 'affirm' | 'afterpay_clearpay' | 'alipay' | 'alma' | 'amazon_pay' | 'au_becs_debit' | 'bacs_debit' | 'bancontact' | 'blik' | 'boleto' | 'card' | 'card_present' | 'cashapp' | 'customer_balance' | 'eps' | 'fpx' | 'giropay' | 'grabpay' | 'ideal' | 'interac_present' | 'kakao_pay' | 'klarna' | 'konbini' | 'kr_card' | 'link' | 'mobilepay' | 'multibanco' | 'naver_pay' | 'oxxo' | 'p24' | 'pay_by_bank' | 'payco' | 'paynow' | 'paypal' | 'pix' | 'promptpay' | 'revolut_pay' | 'samsung_pay' | 'sepa_debit' | 'sofort' | 'swish' | 'twint' | '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. - `us_bank_account` PaymentMethodUsBankAccount - … - `wechat_pay` PaymentMethodWechatPay - `zip` PaymentMethodZip - `generated_sepa_debit_mandate` union — The mandate for the SEPA Direct Debit PaymentMethod which was generated by this SetupAttempt. - string - Mandate — A Mandate is a record of the permission that your customer gives you to debit their payment method. - `customer_acceptance` CustomerAcceptance, required - … - `id` string, required — Unique identifier for the object. - `livemode` boolean, required — Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. - `multi_use` MandateMultiUse - `object` 'mandate', required — String representing the object's type. Objects of the same type share the same value. - `on_behalf_of` string — The account (if any) that the mandate is intended for. - `payment_method` union, required — ID of the payment method associated with this mandate. - … - `payment_method_details` MandatePaymentMethodDetails, required - … - `single_use` MandateSingleUse - … - `status` 'active' | 'inactive' | 'pending', required — The mandate status indicates whether or not you can use it to initiate a payment. - `type` 'multi_use' | 'single_use', required — The type of the mandate. - `iban_last4` string, nullable — Last four characters of the IBAN. - `preferred_language` 'de' | 'en' | 'fr' | 'nl', nullable — Preferred language of the Sofort authorization page that the customer is redirected to. Can be one of `en`, `de`, `fr`, or `nl` - `verified_name` string, nullable — Owner's verified full name. Values are verified or provided by Sofort directly (if supported) at the time of authorization or settlement. They cannot be set or mutated. - `type` string, required — The type of the payment method used in the SetupIntent (e.g., `card`). An additional hash is included on `payment_method_details` with a name matching this value. It contains confirmation-specific information for the payment method. - `us_bank_account` SetupAttemptPaymentMethodDetailsUsBankAccount - `setup_error` ApiErrors - `advice_code` string — For card errors resulting from a card issuer decline, a short string indicating [how to proceed with an error](https://stripe.com/docs/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://stripe.com/docs/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://stripe.com/docs/declines#issuer-declines) if they provide one. - `doc_url` string — A URL to more information about the [error code](https://stripe.com/docs/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 card errors resulting from a card issuer decline, a brand specific 2, 3, or 4 digit code which indicates the reason the authorization 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](https://stripe.com/docs/payments/intents#intent-statuses) 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://stripe.com/docs/payments/payment-intents) - `amount` integer, required — Amount intended to be collected by this PaymentIntent. A positive integer representing how much to charge in the [smallest currency unit](https://stripe.com/docs/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://stripe.com/docs/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 - `tip` PaymentFlowsAmountDetailsClientResourceTip - … - PaymentFlowsAmountDetailsClient - `tip` PaymentFlowsAmountDetailsClientResourceTip - … - `amount_received` integer — Amount that this PaymentIntent collects. - `application` union — ID of the Connect application that created the PaymentIntent. - 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. - `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 payment amount. For more information, see the PaymentIntents [use case for connected accounts](https://stripe.com/docs/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://stripe.com/docs/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' | '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`, or `automatic`). - `capture_method` 'automatic' | 'automatic_async' | 'manual', required — 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://stripe.com/docs/payments/accept-a-payment?ui=elements) and learn about how `client_secret` should be handled. - `confirmation_method` 'automatic' | 'manual', required — 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, 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 — 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://stripe.com/docs/api#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://stripe.com/docs/invoicing/customer), [save payment](https://stripe.com/docs/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. 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. - `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. - `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://stripe.com/docs/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://stripe.com/docs/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://stripe.com/docs/api#coupons) or [promotion code](https://stripe.com/docs/api#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://stripe.com/docs/billing/subscriptions/discounts) - … - `email` string, nullable — The customer's email address. - `id` string, required — Unique identifier for the object. - `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 — Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. - `metadata` object — Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. - `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. - `description` string, nullable — An arbitrary string attached to the object. Often useful for displaying to users. - `id` string, required — Unique identifier for the object. - `invoice` union — ID of the invoice that created this PaymentIntent, if it exists. - string - Invoice — Invoices are statements of amounts owed by a customer, and are either generated one-off, or generated periodically from a subscription. They contain [invoice items](https://stripe.com/docs/api#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://stripe.com/docs/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://stripe.com/docs/billing/customer/balance). Related guide: [Send invoices to customers](https://stripe.com/docs/billing/invoices/sending) - `account_country` string, nullable — The country of the business associated with this invoice, most often the business creating the invoice. - `account_name` string, nullable — The public name of the business associated with this invoice, most often the business creating the invoice. - `account_tax_ids` union[], nullable — The account tax IDs associated with the invoice. Only editable when the invoice is a draft. - … - `amount_due` integer, required — Final amount due at this time for this invoice. If the invoice's total is smaller than the minimum charge amount, for example, or if there is account credit that can be applied to the invoice, the `amount_due` may be 0. If there is a positive `starting_balance` for the invoice (the customer owes money), the `amount_due` will also take that into account. The charge that gets generated for the invoice will be for the amount specified in `amount_due`. - `amount_paid` integer, required — The amount, in cents (or local equivalent), that was paid. - `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. - … - `application_fee_amount` integer, nullable — The fee in cents (or local equivalent) that will be applied to the invoice and transferred to the application owner's Stripe account when the invoice is paid. - `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 — Controls whether Stripe performs [automatic collection](https://stripe.com/docs/invoicing/integration/automatic-advancement-collection) of the invoice. If `false`, the invoice's state doesn't automatically advance without an explicit action. - `automatic_tax` AutomaticTax, required - … - `automatically_finalizes_at` integer, nullable — The time when this invoice is currently scheduled to be automatically finalized. The field will be `null` if the invoice is not scheduled to finalize in the future. If the invoice is not in the draft state, this field will always be `null` - see `finalized_at` for the time when an already-finalized invoice was finalized. - `billing_reason` 'automatic_pending_invoice_item_invoice' | 'manual' | 'quote_accept' | 'subscription' | 'subscription_create' | 'subscription_cycle' | 'subscription_threshold' | 'subscription_update' | 'upcoming', nullable — Indicates the reason why the invoice was created. * `manual`: Unrelated to a subscription, for example, created via the invoice editor. * `subscription`: No longer in use. Applies to subscriptions from before May 2018 where no distinction was made between updates, cycles, and thresholds. * `subscription_create`: A new subscription was created. * `subscription_cycle`: A subscription advanced into a new period. * `subscription_threshold`: A subscription reached a billing threshold. * `subscription_update`: A subscription was updated. * `upcoming`: Reserved for simulated invoices, per the upcoming invoice endpoint. - `charge` union — ID of the latest charge generated for this invoice, if any. - … - `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. - `created` integer, required — Time at which the object was created. Measured in seconds since the Unix epoch. - `currency` string, currency, required — Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). - `custom_fields` InvoiceSettingCustomField[], nullable — Custom fields displayed on the invoice. - … - `customer` union — The ID of the customer who will be billed. - … - `customer_address` Address - … - `customer_email` string, nullable — The customer's email. Until the invoice is finalized, this field will equal `customer.email`. Once the invoice is finalized, this field will no longer be updated. - `customer_name` string, nullable — The customer's name. Until the invoice is finalized, this field will equal `customer.name`. Once the invoice is finalized, this field will no longer be updated. - `customer_phone` string, nullable — The customer's phone number. Until the invoice is finalized, this field will equal `customer.phone`. Once the invoice is finalized, this field will no longer be updated. - `customer_shipping` Shipping - … - `customer_tax_exempt` 'exempt' | 'none' | 'reverse', nullable — The customer's tax exempt status. Until the invoice is finalized, this field will equal `customer.tax_exempt`. Once the invoice is finalized, this field will no longer be updated. - `customer_tax_ids` InvoicesResourceInvoiceTaxId[], nullable — The customer's tax IDs. Until the invoice is finalized, this field will contain the same tax IDs as `customer.tax_ids`. Once the invoice is finalized, this field will no longer be updated. - … - `default_payment_method` union — ID of the default payment method for the invoice. It must belong to the customer associated with the invoice. If not set, defaults to the subscription's default payment method, if any, or to the default payment method in the customer's invoice settings. - … - `default_source` union — ID of the default payment source for the invoice. It must belong to the customer associated with the invoice and be in a chargeable state. If not set, defaults to the subscription's default source, if any, or to the customer's default source. - … - `default_tax_rates` TaxRate[], required — The tax rates applied to this invoice, if any. - … - `description` string, nullable — An arbitrary string attached to the object. Often useful for displaying to users. Referenced as 'memo' in the Dashboard. - `discount` Discount — A discount represents the actual application of a [coupon](https://stripe.com/docs/api#coupons) or [promotion code](https://stripe.com/docs/api#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://stripe.com/docs/billing/subscriptions/discounts) - … - `discounts` union[], required — The discounts applied to the invoice. Line item discounts are applied before invoice discounts. Use `expand[]=discounts` to expand each discount. - … - `due_date` integer, nullable — The date on which payment for this invoice is due. This value will be `null` for invoices where `collection_method=charge_automatically`. - `effective_at` integer, nullable — The date when this invoice is in effect. Same as `finalized_at` unless overwritten. When defined, this value replaces the system-generated 'Date of issue' printed on the invoice PDF and receipt. - `ending_balance` integer, nullable — Ending customer balance after the invoice is finalized. Invoices are finalized approximately an hour after successful webhook delivery or when payment collection is attempted for the invoice. If the invoice has not been finalized yet, this will be null. - `footer` string, nullable — Footer displayed on the invoice. - `from_invoice` InvoicesResourceFromInvoice - … - `hosted_invoice_url` string, nullable — The URL for the hosted invoice page, which allows customers to view and pay an invoice. If the invoice has not been finalized yet, this will be null. - `id` string — Unique identifier for the object. This property is always present unless the invoice is an upcoming invoice. See [Retrieve an upcoming invoice](https://stripe.com/docs/api/invoices/upcoming) for more details. - `invoice_pdf` string, nullable — The link to download the PDF for the invoice. If the invoice has not been finalized yet, this will be null. - `issuer` ConnectAccountReference, required - … - `last_finalization_error` ApiErrors — recursive - `latest_revision` union — The ID of the most recent non-draft revision of this invoice - … - `lines` object, required — The individual line items that make up the invoice. `lines` is sorted as follows: (1) pending invoice items (including prorations) in reverse chronological order, (2) subscription items in reverse chronological order, and (3) invoice items added after invoice creation in chronological order. - … - `livemode` boolean, required — Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. - `metadata` object, nullable — Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. - `next_payment_attempt` integer, nullable — The time at which payment will next be attempted. This value will be `null` for invoices where `collection_method=send_invoice`. - `number` string, nullable — A unique, identifying string that appears on emails sent to the customer for this invoice. This starts with the customer's unique invoice_prefix if it is specified. - `object` 'invoice', required — String representing the object's type. Objects of the same type share the same value. - `on_behalf_of` union — The account (if any) for which the funds of the invoice payment are intended. If set, the invoice will be presented with the branding and support information of the specified account. See the [Invoices with Connect](https://stripe.com/docs/billing/invoices/connect) documentation for details. - … - `paid` boolean, required — Whether payment was successfully collected for this invoice. An invoice can be paid (most commonly) with a charge or with credit from the customer's account balance. - `paid_out_of_band` boolean, required — Returns true if the invoice was manually marked paid, returns false if the invoice hasn't been paid yet or was paid on Stripe. - `payment_intent` union — The PaymentIntent associated with this invoice. The PaymentIntent is generated when the invoice is finalized, and can then be used to pay the invoice. Note that voiding an invoice will cancel the PaymentIntent. - … - `payment_settings` InvoicesPaymentSettings, required - … - `period_end` integer, required — End of the usage period during which invoice items were added to this invoice. This looks back one period for a subscription invoice. Use the [line item period](/api/invoices/line_item#invoice_line_item_object-period) to get the service period for each price. - `period_start` integer, required — Start of the usage period during which invoice items were added to this invoice. This looks back one period for a subscription invoice. Use the [line item period](/api/invoices/line_item#invoice_line_item_object-period) to get the service period for each price. - `post_payment_credit_notes_amount` integer, required — Total amount of all post-payment credit notes issued for this invoice. - `pre_payment_credit_notes_amount` integer, required — Total amount of all pre-payment credit notes issued for this invoice. - `quote` union — The quote this invoice was generated from. - … - `receipt_number` string, nullable — This is the transaction number that appears on email receipts sent for this invoice. - `rendering` InvoicesResourceInvoiceRendering - … - `shipping_cost` InvoicesResourceShippingCost - … - `shipping_details` Shipping - … - `starting_balance` integer, required — Starting customer balance before the invoice is finalized. If the invoice has not been finalized yet, this will be the current customer balance. For revision invoices, this also includes any customer balance that was applied to the original invoice. - `statement_descriptor` string, nullable — Extra information about an invoice for the customer's credit card statement. - `status` 'draft' | 'open' | 'paid' | 'uncollectible' | 'void', nullable — The status of the invoice, one of `draft`, `open`, `paid`, `uncollectible`, or `void`. [Learn more](https://stripe.com/docs/billing/invoices/workflow#workflow-overview) - `status_transitions` InvoicesResourceStatusTransitions, required - … - `subscription` union — The subscription that this invoice was prepared for, if any. - … - `subscription_details` SubscriptionDetailsData - … - `subscription_proration_date` integer — Only set for upcoming invoices that preview prorations. The time used to calculate prorations. - `subtotal` integer, required — Total of all subscriptions, invoice items, and prorations on the invoice before any invoice level discount or exclusive tax is applied. Item discounts are already incorporated - `subtotal_excluding_tax` integer, nullable — The integer amount in cents (or local equivalent) representing the subtotal of the invoice before any invoice level discount or tax is applied. Item discounts are already incorporated - `tax` integer, nullable — The amount of tax on this invoice. This is the sum of all the tax amounts on this invoice. - `test_clock` union — ID of the test clock this invoice belongs to. - … - `threshold_reason` InvoiceThresholdReason - … - `total` integer, required — Total after discounts and taxes. - `total_discount_amounts` DiscountsResourceDiscountAmount[], nullable — The aggregate amounts calculated per discount across all line items. - … - `total_excluding_tax` integer, nullable — The integer amount in cents (or local equivalent) representing the total amount of the invoice including all discounts but excluding all tax. - `total_pretax_credit_amounts` InvoicesResourcePretaxCreditAmount[], nullable — Contains pretax credit amounts (ex: discount, credit grants, etc) that apply to this invoice. This is a combined list of total_pretax_credit_amounts across all invoice line items. - … - `total_tax_amounts` InvoiceTaxAmount[], required — The aggregate amounts calculated per tax rate for all line items. - … - `transfer_data` InvoiceTransferData - … - `webhooks_delivered_at` integer, nullable — Invoices are automatically paid or sent 1 hour after webhooks are delivered, or until all webhook delivery attempts have [been exhausted](https://stripe.com/docs/billing/webhooks#understand). This field tracks the time when webhooks for this invoice were successfully delivered. If the invoice had no webhooks to deliver, this will be set while the invoice is being created. - `last_payment_error` ApiErrors — recursive - `latest_charge` union — ID of the latest [Charge object](https://stripe.com/docs/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 transferring money to a different Stripe account through Connect also creates Charges. Some legacy payment flows create Charges directly, which is not recommended for new integrations. - `amount` integer, required — Amount intended to be collected by this payment. A positive integer representing how much to charge in the [smallest currency unit](https://stripe.com/docs/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://stripe.com/docs/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_captured` integer, required — Amount in cents (or local equivalent) captured (can be less than the amount attribute on the charge if a partial capture was made). - `amount_refunded` integer, required — Amount in cents (or local equivalent) refunded (can be less than the amount attribute on the charge if a partial refund was issued). - `application` union — ID of the Connect application that created the charge. - … - `application_fee` union — The application fee (if any) for the charge. [See the Connect documentation](https://stripe.com/docs/connect/direct-charges#collect-fees) for details. - … - `application_fee_amount` integer, nullable — The amount of the application fee (if any) requested for the charge. [See the Connect documentation](https://stripe.com/docs/connect/direct-charges#collect-fees) for details. - `balance_transaction` union — ID of the balance transaction that describes the impact of this charge on your account balance (not including refunds or disputes). - … - `billing_details` BillingDetails, required - … - `calculated_statement_descriptor` string, nullable — The full statement descriptor that is passed to card networks, and that is displayed on your customers' credit card and bank statements. Allows you to see what the statement descriptor looks like after the static and dynamic portions are combined. This value only exists for card payments. - `captured` boolean, required — If the charge was created without capturing, this Boolean represents whether it is still uncaptured or has since been captured. - `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 — ID of the customer this charge is for if one exists. - … - `description` string, nullable — An arbitrary string attached to the object. Often useful for displaying to users. - `disputed` boolean, required — Whether the charge has been disputed. - `failure_balance_transaction` union — ID of the balance transaction that describes the reversal of the balance on your account due to payment failure. - … - `failure_code` string, nullable — Error code explaining reason for charge failure if available (see [the errors section](https://stripe.com/docs/error-codes) for a list of codes). - `failure_message` string, nullable — Message to user further explaining reason for charge failure if available. - `fraud_details` ChargeFraudDetails - … - `id` string, required — Unique identifier for the object. - `invoice` union — ID of the invoice this charge is for if one exists. - … - `livemode` boolean, required — Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. - `metadata` object, required — Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. - `object` 'charge', 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 without triggering an automatic transfer. See the [Connect documentation](https://stripe.com/docs/connect/separate-charges-and-transfers) for details. - … - `outcome` ChargeOutcome - … - `paid` boolean, required — `true` if the charge succeeded, or was successfully authorized for later capture. - `payment_intent` union — ID of the PaymentIntent associated with this charge, if one exists. - … - `payment_method` string, nullable — ID of the payment method used in this charge. - `payment_method_details` PaymentMethodDetails - … - `radar_options` RadarRadarOptions — Options to configure Radar. See [Radar Session](https://stripe.com/docs/radar/radar-session) for more information. - … - `receipt_email` string, nullable — This is the email address that the receipt for this charge was sent to. - `receipt_number` string, nullable — This is the transaction number that appears on email receipts sent for this charge. This attribute will be `null` until a receipt has been sent. - `receipt_url` string, nullable — This is the URL to view the receipt for this charge. The receipt is kept up-to-date to the latest state of the charge, including any refunds. If the charge is for an Invoice, the receipt will be stylized as an Invoice receipt. - `refunded` boolean, required — Whether the charge has been fully refunded. If the charge is only partially refunded, this attribute will still be false. - `refunds` object, nullable — A list of refunds that have been applied to the charge. - … - `review` union — ID of the review associated with this charge if one exists. - … - `shipping` Shipping - … - `source_transfer` union — The transfer ID which created this charge. Only present if the charge came from another Stripe account. [See the Connect documentation](https://docs.stripe.com/connect/destination-charges) for details. - … - `statement_descriptor` string, nullable — For a non-card charge, text that appears on the customer's statement as the statement descriptor. This value overrides the account's default statement descriptor. For information about requirements, including the 22-character limit, see [the Statement Descriptor docs](https://docs.stripe.com/get-started/account/statement-descriptors). For a card charge, this value is ignored unless you don't specify a `statement_descriptor_suffix`, in which case this value is used as the suffix. - `statement_descriptor_suffix` string, nullable — Provides information about a card charge. Concatenated to the account's [statement descriptor prefix](https://docs.stripe.com/get-started/account/statement-descriptors#static) to form the complete statement descriptor that appears on the customer's statement. If the account has no prefix value, the suffix is concatenated to the account's statement descriptor. - `status` 'failed' | 'pending' | 'succeeded', required — The status of the payment is either `succeeded`, `pending`, or `failed`. - `transfer` union — ID of the transfer to the `destination` account (only applicable if the charge was created using the `destination` parameter). - … - `transfer_data` ChargeTransferData - … - `transfer_group` string, nullable — A string that identifies this transaction as part of a group. See the [Connect documentation](https://stripe.com/docs/connect/separate-charges-and-transfers#transfer-options) for details. - `livemode` boolean, required — Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. - `metadata` object — Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Learn more about [storing information in metadata](https://stripe.com/docs/payments/payment-intents/creating-payment-intents#storing-information-in-metadata). - `next_action` PaymentIntentNextAction - `alipay_handle_redirect` PaymentIntentNextActionAlipayHandleRedirect - `native_data` string, nullable — The native data to be used with Alipay SDK you must redirect your customer to in order to authenticate the payment in an Android App. - `native_url` string, nullable — The native URL you must redirect your customer to in order to authenticate the payment in an iOS App. - `return_url` string, nullable — If the customer does not exit their browser while authenticating, they will be redirected to this specified URL after completion. - `url` string, nullable — The URL you must redirect your customer to in order to authenticate the payment. - `boleto_display_details` PaymentIntentNextActionBoleto - `expires_at` integer, nullable — The timestamp after which the boleto expires. - `hosted_voucher_url` string, nullable — The URL to the hosted boleto voucher page, which allows customers to view the boleto voucher. - `number` string, nullable — The boleto number. - `pdf` string, nullable — The URL to the downloadable boleto voucher PDF. - `card_await_notification` PaymentIntentNextActionCardAwaitNotification - `charge_attempt_at` integer, nullable — The time that payment will be attempted. If customer approval is required, they need to provide approval before this time. - `customer_approval_required` boolean, nullable — For payments greater than INR 15000, the customer must provide explicit approval of the payment with their bank. For payments of lower amount, no customer action is required. - `cashapp_handle_redirect_or_display_qr_code` PaymentIntentNextActionCashappHandleRedirectOrDisplayQrCode - `hosted_instructions_url` string, required — The URL to the hosted Cash App Pay instructions page, which allows customers to view the QR code, and supports QR code refreshing on expiration. - `mobile_auth_url` string, required — The url for mobile redirect based auth - `qr_code` PaymentIntentNextActionCashappQrCode, required - … - `display_bank_transfer_instructions` PaymentIntentNextActionDisplayBankTransferInstructions - `amount_remaining` integer, nullable — The remaining amount that needs to be transferred to complete the payment. - `currency` string, currency, nullable — Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). - `financial_addresses` FundingInstructionsBankTransferFinancialAddress[] — A list of financial addresses that can be used to fund the customer balance - … - `hosted_instructions_url` string, nullable — A link to a hosted page that guides your customer through completing the transfer. - `reference` string, nullable — A string identifying this payment. Instruct your customer to include this code in the reference or memo field of their bank transfer. - `type` 'eu_bank_transfer' | 'gb_bank_transfer' | 'jp_bank_transfer' | 'mx_bank_transfer' | 'us_bank_transfer', required — Type of bank transfer - `konbini_display_details` PaymentIntentNextActionKonbini - `expires_at` integer, required — The timestamp at which the pending Konbini payment expires. - `hosted_voucher_url` string, nullable — The URL for the Konbini payment instructions page, which allows customers to view and print a Konbini voucher. - `stores` PaymentIntentNextActionKonbiniStores, required - … - `multibanco_display_details` PaymentIntentNextActionDisplayMultibancoDetails - `entity` string, nullable — Entity number associated with this Multibanco payment. - `expires_at` integer, nullable — The timestamp at which the Multibanco voucher expires. - `hosted_voucher_url` string, nullable — The URL for the hosted Multibanco voucher page, which allows customers to view a Multibanco voucher. - `reference` string, nullable — Reference number associated with this Multibanco payment. - `oxxo_display_details` PaymentIntentNextActionDisplayOxxoDetails - `expires_after` integer, nullable — The timestamp after which the OXXO voucher expires. - `hosted_voucher_url` string, nullable — The URL for the hosted OXXO voucher page, which allows customers to view and print an OXXO voucher. - `number` string, nullable — OXXO reference number. - `paynow_display_qr_code` PaymentIntentNextActionPaynowDisplayQrCode - `data` string, required — The raw data string used to generate QR code, it should be used together with QR code library. - `hosted_instructions_url` string, nullable — The URL to the hosted PayNow instructions page, which allows customers to view the PayNow QR code. - `image_url_png` string, required — The image_url_png string used to render QR code - `image_url_svg` string, required — The image_url_svg string used to render QR code - `pix_display_qr_code` PaymentIntentNextActionPixDisplayQrCode - `data` string — The raw data string used to generate QR code, it should be used together with QR code library. - `expires_at` integer — The date (unix timestamp) when the PIX expires. - `hosted_instructions_url` string — The URL to the hosted pix instructions page, which allows customers to view the pix QR code. - `image_url_png` string — The image_url_png string used to render png QR code - `image_url_svg` string — The image_url_svg string used to render svg QR code - `promptpay_display_qr_code` PaymentIntentNextActionPromptpayDisplayQrCode - `data` string, required — The raw data string used to generate QR code, it should be used together with QR code library. - `hosted_instructions_url` string, required — The URL to the hosted PromptPay instructions page, which allows customers to view the PromptPay QR code. - `image_url_png` string, required — The PNG path used to render the QR code, can be used as the source in an HTML img tag - `image_url_svg` string, required — The SVG path used to render the QR code, can be used as the source in an HTML img tag - `redirect_to_url` PaymentIntentNextActionRedirectToUrl - `return_url` string, nullable — If the customer does not exit their browser while authenticating, they will be redirected to this specified URL after completion. - `url` string, nullable — The URL you must redirect your customer to in order to authenticate the payment. - `swish_handle_redirect_or_display_qr_code` PaymentIntentNextActionSwishHandleRedirectOrDisplayQrCode - `hosted_instructions_url` string, required — The URL to the hosted Swish instructions page, which allows customers to view the QR code. - `qr_code` PaymentIntentNextActionSwishQrCode, required - … - `type` string, required — Type of the next action to perform, one of `redirect_to_url`, `use_stripe_sdk`, `alipay_handle_redirect`, `oxxo_display_details`, or `verify_with_microdeposits`. - `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 - `arrival_date` integer, required — The timestamp when the microdeposits are expected to land. - `hosted_verification_url` string, required — The URL for the hosted verification page, which allows customers to verify their bank account. - `microdeposit_type` 'amounts' | 'descriptor_code', nullable — The type of the microdeposit sent to the customer. Used to distinguish between different verification methods. - `wechat_pay_display_qr_code` PaymentIntentNextActionWechatPayDisplayQrCode - `data` string, required — The data being used to generate QR code - `hosted_instructions_url` string, required — The URL to the hosted WeChat Pay instructions page, which allows customers to view the WeChat Pay QR code. - `image_data_url` string, required — The base64 image data for a pre-generated QR code - `image_url_png` string, required — The image_url_png string used to render QR code - `image_url_svg` string, required — The image_url_svg string used to render QR code - `wechat_pay_redirect_to_android_app` PaymentIntentNextActionWechatPayRedirectToAndroidApp - `app_id` string, required — app_id is the APP ID registered on WeChat open platform - `nonce_str` string, required — nonce_str is a random string - `package` string, required — package is static value - `partner_id` string, required — an unique merchant ID assigned by WeChat Pay - `prepay_id` string, required — an unique trading ID assigned by WeChat Pay - `sign` string, required — A signature - `timestamp` string, required — Specifies the current time in epoch format - `wechat_pay_redirect_to_ios_app` PaymentIntentNextActionWechatPayRedirectToIosApp - `native_url` string, required — An universal link that redirect to WeChat Pay app - `object` 'payment_intent', required — String representing the object's type. Objects of the same type share the same value. - `on_behalf_of` union — The account (if any) for which the funds of the PaymentIntent are intended. See the PaymentIntents [use case for connected accounts](https://stripe.com/docs/payments/connected-accounts) for details. - string - Account — 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. After you create an [Account Link](/api/account_links) or [Account Session](/api/account_sessions), this property is only returned for accounts where [controller.requirement_collection](/api/accounts/object#account_object-controller-requirement_collection) is `application`, which includes Custom accounts. - `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 cannot access 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://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. - `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`. - `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://stripe.com/docs/payments/payment-intents) to collect payments or save them to Customer objects to store instrument details for future payments. Related guides: [Payment Methods](https://stripe.com/docs/payments/payment-methods) and [More Payment Scenarios](https://stripe.com/docs/payments/more-payment-scenarios). - `acss_debit` PaymentMethodAcssDebit - … - `affirm` PaymentMethodAffirm - … truncated; see the full OpenAPI document linked below ## Other responses - `default` — Error response. ## Changes > 9 revisions in range; 2 not diffed. - **2025-01-17** `b8a91ebdacb7` — 16 info - added the optional property `data/items/setup_error/anyOf[subschema #1: APIErrors]/advice_code` to the response with the `200` status - added the optional property `data/items/setup_error/anyOf[subschema #1: APIErrors]/payment_intent/invoice/anyOf[subschema #2: Invoice]/charge/anyOf[subschema #2: Charge]/outcome/anyOf[subschema #1: ChargeOutcome]/advice_code` to the response with the `200` status - added the optional property `data/items/setup_error/anyOf[subschema #1: APIErrors]/payment_intent/invoice/anyOf[subschema #2: Invoice]/charge/anyOf[subschema #2: Charge]/payment_method_details/anyOf[subschema #1: payment_method_details]/pay_by_bank` to the response with the `200` status - added the optional property `data/items/setup_error/anyOf[subschema #1: APIErrors]/payment_intent/invoice/anyOf[subschema #2: Invoice]/charge/anyOf[subschema #2: Charge]/payment_method_details/anyOf[subschema #1: payment_method_details]/paypal/country` to the response with the `200` status - …12 more - …earlier changes not shown [Full history](https://skmtc.dev/stripe/apis/spec3/changes/v1/setup_attempts/get.md) --- [API](https://skmtc.dev/stripe/apis/spec3.md) · [All operations](https://skmtc.dev/stripe/apis/spec3/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/stripe/spec3/revisions/b8a91ebdacb7/schema)