components: schemas: account: description: >- 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 Custom accounts, the properties below are always returned. For other accounts, some properties are returned until that account has started to go through Connect Onboarding. Once you create an [Account Link](https://stripe.com/docs/api/account_links) or [Account Session](https://stripe.com/docs/api/account_sessions), some properties are only returned for Custom accounts. Learn about the differences [between accounts](https://stripe.com/docs/connect/accounts). properties: business_profile: anyOf: - $ref: '#/components/schemas/account_business_profile' description: Business information about the account. nullable: true business_type: description: >- The business type. Once you create an [Account Link](https://stripe.com/docs/api/account_links) or [Account Session](https://stripe.com/docs/api/account_sessions), this property is only returned for Custom accounts. enum: - company - government_entity - individual - non_profit nullable: true type: string x-stripeBypassValidation: true capabilities: $ref: '#/components/schemas/account_capabilities' charges_enabled: description: Whether the account can create live charges. type: boolean company: $ref: '#/components/schemas/legal_entity_company' controller: $ref: '#/components/schemas/account_unification_account_controller' country: description: The account's country. maxLength: 5000 type: string created: description: >- Time at which the account was connected. Measured in seconds since the Unix epoch. format: unix-time type: integer default_currency: description: >- 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). maxLength: 5000 type: string details_submitted: description: >- Whether account details have been submitted. Standard accounts cannot receive payouts before this is true. type: boolean email: description: >- 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. maxLength: 5000 nullable: true type: string external_accounts: description: >- 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. properties: data: description: >- The list contains all external accounts that have been attached to the Stripe account. These may be bank accounts or cards. items: anyOf: - $ref: '#/components/schemas/bank_account' - $ref: '#/components/schemas/card' title: Polymorphic x-stripeBypassValidation: true type: array has_more: description: >- True if this list has another page of items after this one that can be fetched. type: boolean object: description: >- String representing the object's type. Objects of the same type share the same value. Always has the value `list`. enum: - list type: string url: description: The URL where this list can be accessed. maxLength: 5000 type: string required: - data - has_more - object - url title: ExternalAccountList type: object x-expandableFields: - data future_requirements: $ref: '#/components/schemas/account_future_requirements' id: description: Unique identifier for the object. maxLength: 5000 type: string individual: $ref: '#/components/schemas/person' metadata: additionalProperties: maxLength: 500 type: string description: >- 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. type: object object: description: >- String representing the object's type. Objects of the same type share the same value. enum: - account type: string payouts_enabled: description: Whether Stripe can send payouts to this account. type: boolean requirements: $ref: '#/components/schemas/account_requirements' settings: anyOf: - $ref: '#/components/schemas/account_settings' description: Options for customizing how the account functions within Stripe. nullable: true tos_acceptance: $ref: '#/components/schemas/account_tos_acceptance' type: description: 'The Stripe account type. Can be `standard`, `express`, or `custom`.' enum: - custom - express - none - standard type: string required: - id - object title: Account type: object x-expandableFields: - business_profile - capabilities - company - controller - external_accounts - future_requirements - individual - requirements - settings - tos_acceptance x-resourceId: account account_annual_revenue: description: '' properties: amount: description: >- A non-negative integer representing the amount in the [smallest currency unit](https://docs.stripe.com/currencies#zero-decimal). nullable: true type: integer currency: description: >- 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). nullable: true type: string fiscal_year_end: description: >- The close-out date of the preceding fiscal year in ISO 8601 format. E.g. 2023-12-31 for the 31st of December, 2023. maxLength: 5000 nullable: true type: string title: AccountAnnualRevenue type: object x-expandableFields: [] account_bacs_debit_payments_settings: description: '' properties: display_name: description: >- 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. maxLength: 5000 nullable: true type: string service_user_number: description: >- 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. maxLength: 5000 nullable: true type: string title: AccountBacsDebitPaymentsSettings type: object x-expandableFields: [] account_branding_settings: description: '' properties: icon: anyOf: - maxLength: 5000 type: string - $ref: '#/components/schemas/file' description: >- (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. nullable: true x-expansionResources: oneOf: - $ref: '#/components/schemas/file' logo: anyOf: - maxLength: 5000 type: string - $ref: '#/components/schemas/file' description: >- (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. nullable: true x-expansionResources: oneOf: - $ref: '#/components/schemas/file' primary_color: description: >- A CSS hex color value representing the primary branding color for this account maxLength: 5000 nullable: true type: string secondary_color: description: >- A CSS hex color value representing the secondary branding color for this account maxLength: 5000 nullable: true type: string title: AccountBrandingSettings type: object x-expandableFields: - icon - logo account_business_profile: description: '' properties: annual_revenue: anyOf: - $ref: '#/components/schemas/account_annual_revenue' description: The applicant's gross annual revenue for its preceding fiscal year. nullable: true estimated_worker_count: description: >- An estimated upper bound of employees, contractors, vendors, etc. currently working for the business. nullable: true type: integer mcc: description: >- [The merchant category code for the account](https://stripe.com/docs/connect/setting-mcc). MCCs are used to classify businesses based on the goods or services they provide. maxLength: 5000 nullable: true type: string monthly_estimated_revenue: $ref: '#/components/schemas/account_monthly_estimated_revenue' name: description: The customer-facing business name. maxLength: 5000 nullable: true type: string product_description: description: >- Internal-only description of the product sold or service provided by the business. It's used by Stripe for risk and underwriting purposes. maxLength: 40000 nullable: true type: string support_address: anyOf: - $ref: '#/components/schemas/address' description: A publicly available mailing address for sending support issues to. nullable: true support_email: description: A publicly available email address for sending support issues to. maxLength: 5000 nullable: true type: string support_phone: description: A publicly available phone number to call with support issues. maxLength: 5000 nullable: true type: string support_url: description: A publicly available website for handling support issues. maxLength: 5000 nullable: true type: string url: description: The business's publicly available website. maxLength: 5000 nullable: true type: string title: AccountBusinessProfile type: object x-expandableFields: - annual_revenue - monthly_estimated_revenue - support_address account_capabilities: description: '' properties: acss_debit_payments: description: >- 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. enum: - active - inactive - pending type: string affirm_payments: description: >- The status of the Affirm capability of the account, or whether the account can directly process Affirm charges. enum: - active - inactive - pending type: string afterpay_clearpay_payments: description: >- The status of the Afterpay Clearpay capability of the account, or whether the account can directly process Afterpay Clearpay charges. enum: - active - inactive - pending type: string amazon_pay_payments: description: >- The status of the AmazonPay capability of the account, or whether the account can directly process AmazonPay payments. enum: - active - inactive - pending type: string au_becs_debit_payments: description: >- 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. enum: - active - inactive - pending type: string bacs_debit_payments: description: >- The status of the Bacs Direct Debits payments capability of the account, or whether the account can directly process Bacs Direct Debits charges. enum: - active - inactive - pending type: string bancontact_payments: description: >- The status of the Bancontact payments capability of the account, or whether the account can directly process Bancontact charges. enum: - active - inactive - pending type: string bank_transfer_payments: description: >- The status of the customer_balance payments capability of the account, or whether the account can directly process customer_balance charges. enum: - active - inactive - pending type: string blik_payments: description: >- The status of the blik payments capability of the account, or whether the account can directly process blik charges. enum: - active - inactive - pending type: string boleto_payments: description: >- The status of the boleto payments capability of the account, or whether the account can directly process boleto charges. enum: - active - inactive - pending type: string card_issuing: description: >- The status of the card issuing capability of the account, or whether you can use Issuing to distribute funds on cards enum: - active - inactive - pending type: string card_payments: description: >- The status of the card payments capability of the account, or whether the account can directly process credit and debit card charges. enum: - active - inactive - pending type: string cartes_bancaires_payments: description: >- 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. enum: - active - inactive - pending type: string cashapp_payments: description: >- The status of the Cash App Pay capability of the account, or whether the account can directly process Cash App Pay payments. enum: - active - inactive - pending type: string eps_payments: description: >- The status of the EPS payments capability of the account, or whether the account can directly process EPS charges. enum: - active - inactive - pending type: string fpx_payments: description: >- The status of the FPX payments capability of the account, or whether the account can directly process FPX charges. enum: - active - inactive - pending type: string giropay_payments: description: >- The status of the giropay payments capability of the account, or whether the account can directly process giropay charges. enum: - active - inactive - pending type: string grabpay_payments: description: >- The status of the GrabPay payments capability of the account, or whether the account can directly process GrabPay charges. enum: - active - inactive - pending type: string ideal_payments: description: >- The status of the iDEAL payments capability of the account, or whether the account can directly process iDEAL charges. enum: - active - inactive - pending type: string india_international_payments: description: >- The status of the india_international_payments capability of the account, or whether the account can process international charges (non INR) in India. enum: - active - inactive - pending type: string jcb_payments: description: >- 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. enum: - active - inactive - pending type: string klarna_payments: description: >- The status of the Klarna payments capability of the account, or whether the account can directly process Klarna charges. enum: - active - inactive - pending type: string konbini_payments: description: >- The status of the konbini payments capability of the account, or whether the account can directly process konbini charges. enum: - active - inactive - pending type: string legacy_payments: description: The status of the legacy payments capability of the account. enum: - active - inactive - pending type: string link_payments: description: >- The status of the link_payments capability of the account, or whether the account can directly process Link charges. enum: - active - inactive - pending type: string mobilepay_payments: description: >- The status of the MobilepPay capability of the account, or whether the account can directly process MobilePay charges. enum: - active - inactive - pending type: string oxxo_payments: description: >- The status of the OXXO payments capability of the account, or whether the account can directly process OXXO charges. enum: - active - inactive - pending type: string p24_payments: description: >- The status of the P24 payments capability of the account, or whether the account can directly process P24 charges. enum: - active - inactive - pending type: string paynow_payments: description: >- The status of the paynow payments capability of the account, or whether the account can directly process paynow charges. enum: - active - inactive - pending type: string promptpay_payments: description: >- The status of the promptpay payments capability of the account, or whether the account can directly process promptpay charges. enum: - active - inactive - pending type: string revolut_pay_payments: description: >- The status of the RevolutPay capability of the account, or whether the account can directly process RevolutPay payments. enum: - active - inactive - pending type: string sepa_debit_payments: description: >- The status of the SEPA Direct Debits payments capability of the account, or whether the account can directly process SEPA Direct Debits charges. enum: - active - inactive - pending type: string sofort_payments: description: >- The status of the Sofort payments capability of the account, or whether the account can directly process Sofort charges. enum: - active - inactive - pending type: string swish_payments: description: >- The status of the Swish capability of the account, or whether the account can directly process Swish payments. enum: - active - inactive - pending type: string tax_reporting_us_1099_k: description: >- The status of the tax reporting 1099-K (US) capability of the account. enum: - active - inactive - pending type: string tax_reporting_us_1099_misc: description: >- The status of the tax reporting 1099-MISC (US) capability of the account. enum: - active - inactive - pending type: string transfers: description: >- The status of the transfers capability of the account, or whether your platform can transfer funds to the account. enum: - active - inactive - pending type: string treasury: description: >- The status of the banking capability, or whether the account can have bank accounts. enum: - active - inactive - pending type: string us_bank_account_ach_payments: description: >- The status of the US bank account ACH payments capability of the account, or whether the account can directly process US bank account charges. enum: - active - inactive - pending type: string zip_payments: description: >- The status of the Zip capability of the account, or whether the account can directly process Zip charges. enum: - active - inactive - pending type: string title: AccountCapabilities type: object x-expandableFields: [] account_capability_future_requirements: description: '' properties: alternatives: description: >- Fields that are due and can be satisfied by providing the corresponding alternative fields instead. items: $ref: '#/components/schemas/account_requirements_alternative' nullable: true type: array current_deadline: description: >- Date on which `future_requirements` merges with 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 the capability's enablement state prior to transitioning. format: unix-time nullable: true type: integer currently_due: description: >- Fields that need to be collected to keep the capability enabled. If not collected by `future_requirements[current_deadline]`, these fields will transition to the main `requirements` hash. items: maxLength: 5000 type: string type: array disabled_reason: description: >- This is typed as a string for consistency with `requirements.disabled_reason`, but it safe to assume `future_requirements.disabled_reason` is empty because fields in `future_requirements` will never disable the account. maxLength: 5000 nullable: true type: string errors: description: >- Fields that are `currently_due` and need to be collected again because validation or verification failed. items: $ref: '#/components/schemas/account_requirements_error' type: array eventually_due: description: >- Fields that need to be collected assuming all volume thresholds are reached. As they become required, they appear in `currently_due` as well. items: maxLength: 5000 type: string type: array past_due: description: >- 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`. items: maxLength: 5000 type: string type: array pending_verification: description: >- 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. items: maxLength: 5000 type: string type: array required: - currently_due - errors - eventually_due - past_due - pending_verification title: AccountCapabilityFutureRequirements type: object x-expandableFields: - alternatives - errors account_capability_requirements: description: '' properties: alternatives: description: >- Fields that are due and can be satisfied by providing the corresponding alternative fields instead. items: $ref: '#/components/schemas/account_requirements_alternative' nullable: true type: array current_deadline: description: >- Date by which the fields in `currently_due` must be collected to keep the capability enabled for the account. These fields may disable the capability sooner if the next threshold is reached before they are collected. format: unix-time nullable: true type: integer currently_due: description: >- Fields that need to be collected to keep the capability enabled. If not collected by `current_deadline`, these fields appear in `past_due` as well, and the capability is disabled. items: maxLength: 5000 type: string type: array disabled_reason: description: >- If the capability is disabled, this string describes why. Can be `requirements.past_due`, `requirements.pending_verification`, `listed`, `platform_paused`, `rejected.fraud`, `rejected.listed`, `rejected.terms_of_service`, `rejected.other`, `under_review`, or `other`. `rejected.unsupported_business` means that the account's business is not supported by the capability. For example, payment methods may restrict the businesses they support in their terms of service: - [Afterpay Clearpay's terms of service](/afterpay-clearpay/legal#restricted-businesses) If you believe that the rejection is in error, please contact support at https://support.stripe.com/contact/ for assistance. maxLength: 5000 nullable: true type: string errors: description: >- Fields that are `currently_due` and need to be collected again because validation or verification failed. items: $ref: '#/components/schemas/account_requirements_error' type: array eventually_due: description: >- Fields that need to be collected assuming all volume thresholds are reached. As they become required, they appear in `currently_due` as well, and `current_deadline` becomes set. items: maxLength: 5000 type: string type: array past_due: description: >- Fields that weren't collected by `current_deadline`. These fields need to be collected to enable the capability on the account. items: maxLength: 5000 type: string type: array pending_verification: description: >- 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. items: maxLength: 5000 type: string type: array required: - currently_due - errors - eventually_due - past_due - pending_verification title: AccountCapabilityRequirements type: object x-expandableFields: - alternatives - errors account_card_issuing_settings: description: '' properties: tos_acceptance: $ref: '#/components/schemas/card_issuing_account_terms_of_service' title: AccountCardIssuingSettings type: object x-expandableFields: - tos_acceptance account_card_payments_settings: description: '' properties: decline_on: $ref: '#/components/schemas/account_decline_charge_on' statement_descriptor_prefix: description: >- 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. maxLength: 5000 nullable: true type: string statement_descriptor_prefix_kana: description: >- 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. maxLength: 5000 nullable: true type: string statement_descriptor_prefix_kanji: description: >- 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. maxLength: 5000 nullable: true type: string title: AccountCardPaymentsSettings type: object x-expandableFields: - decline_on account_dashboard_settings: description: '' properties: display_name: description: >- The display name for this account. This is used on the Stripe Dashboard to differentiate between accounts. maxLength: 5000 nullable: true type: string timezone: description: >- 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). maxLength: 5000 nullable: true type: string title: AccountDashboardSettings type: object x-expandableFields: [] account_decline_charge_on: description: '' properties: avs_failure: description: >- Whether Stripe automatically declines charges with an incorrect ZIP or postal code. This setting only applies when a ZIP or postal code is provided and they fail bank verification. type: boolean cvc_failure: description: >- Whether Stripe automatically declines charges with an incorrect CVC. This setting only applies when a CVC is provided and it fails bank verification. type: boolean required: - avs_failure - cvc_failure title: AccountDeclineChargeOn type: object x-expandableFields: [] account_future_requirements: description: '' properties: alternatives: description: >- Fields that are due and can be satisfied by providing the corresponding alternative fields instead. items: $ref: '#/components/schemas/account_requirements_alternative' nullable: true type: array current_deadline: description: >- Date on which `future_requirements` merges with 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. format: unix-time nullable: true type: integer currently_due: description: >- 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. items: maxLength: 5000 type: string nullable: true type: array disabled_reason: description: >- This is typed as a string for consistency with `requirements.disabled_reason`. maxLength: 5000 nullable: true type: string errors: description: >- Fields that are `currently_due` and need to be collected again because validation or verification failed. items: $ref: '#/components/schemas/account_requirements_error' nullable: true type: array eventually_due: description: >- Fields that need to be collected assuming all volume thresholds are reached. As they become required, they appear in `currently_due` as well. items: maxLength: 5000 type: string nullable: true type: array past_due: description: >- 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`. items: maxLength: 5000 type: string nullable: true type: array pending_verification: description: >- 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. items: maxLength: 5000 type: string nullable: true type: array title: AccountFutureRequirements type: object x-expandableFields: - alternatives - errors account_invoices_settings: description: '' properties: default_account_tax_ids: description: >- The list of default Account Tax IDs to automatically include on invoices. Account Tax IDs get added when an invoice is finalized. items: anyOf: - maxLength: 5000 type: string - $ref: '#/components/schemas/tax_id' x-expansionResources: oneOf: - $ref: '#/components/schemas/tax_id' nullable: true type: array title: AccountInvoicesSettings type: object x-expandableFields: - default_account_tax_ids account_link: description: >- Account Links are the means by which a Connect platform grants a connected account permission to access Stripe-hosted applications, such as Connect Onboarding. Related guide: [Connect Onboarding](https://stripe.com/docs/connect/custom/hosted-onboarding) properties: created: description: >- Time at which the object was created. Measured in seconds since the Unix epoch. format: unix-time type: integer expires_at: description: The timestamp at which this account link will expire. format: unix-time type: integer object: description: >- String representing the object's type. Objects of the same type share the same value. enum: - account_link type: string url: description: The URL for the account link. maxLength: 5000 type: string required: - created - expires_at - object - url title: AccountLink type: object x-expandableFields: [] x-resourceId: account_link account_monthly_estimated_revenue: description: '' properties: amount: description: >- A non-negative integer representing how much to charge in the [smallest currency unit](https://docs.stripe.com/currencies#zero-decimal). type: integer currency: description: >- 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). type: string required: - amount - currency title: AccountMonthlyEstimatedRevenue type: object x-expandableFields: [] account_payments_settings: description: '' properties: statement_descriptor: description: >- 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. maxLength: 5000 nullable: true type: string statement_descriptor_kana: description: >- The Kana variation of the default text that appears on credit card statements when a charge is made (Japan only) maxLength: 5000 nullable: true type: string statement_descriptor_kanji: description: >- The Kanji variation of the default text that appears on credit card statements when a charge is made (Japan only) maxLength: 5000 nullable: true type: string statement_descriptor_prefix_kana: description: >- 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. maxLength: 5000 nullable: true type: string statement_descriptor_prefix_kanji: description: >- 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. maxLength: 5000 nullable: true type: string title: AccountPaymentsSettings type: object x-expandableFields: [] account_payout_settings: description: '' properties: debit_negative_balances: description: >- A Boolean indicating if Stripe should try to reclaim negative balances from an attached bank account. See our [Understanding Connect Account Balances](https://stripe.com/docs/connect/account-balances) documentation for details. Default value is `false` for Custom accounts, otherwise `true`. type: boolean schedule: $ref: '#/components/schemas/transfer_schedule' statement_descriptor: description: >- 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. maxLength: 5000 nullable: true type: string required: - debit_negative_balances - schedule title: AccountPayoutSettings type: object x-expandableFields: - schedule account_requirements: description: '' properties: alternatives: description: >- Fields that are due and can be satisfied by providing the corresponding alternative fields instead. items: $ref: '#/components/schemas/account_requirements_alternative' nullable: true type: array current_deadline: description: >- 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. format: unix-time nullable: true type: integer currently_due: description: >- 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. items: maxLength: 5000 type: string nullable: true type: array disabled_reason: description: >- If the account is disabled, this string describes why. [Learn more about handling verification issues](https://stripe.com/docs/connect/handling-api-verification). Can be `action_required.requested_capabilities`, `requirements.past_due`, `requirements.pending_verification`, `listed`, `platform_paused`, `rejected.fraud`, `rejected.incomplete_verification`, `rejected.listed`, `rejected.other`, `rejected.terms_of_service`, `under_review`, or `other`. maxLength: 5000 nullable: true type: string errors: description: >- Fields that are `currently_due` and need to be collected again because validation or verification failed. items: $ref: '#/components/schemas/account_requirements_error' nullable: true type: array eventually_due: description: >- Fields that need to be collected assuming all volume thresholds are reached. As they become required, they appear in `currently_due` as well, and `current_deadline` becomes set. items: maxLength: 5000 type: string nullable: true type: array past_due: description: >- Fields that weren't collected by `current_deadline`. These fields need to be collected to enable the account. items: maxLength: 5000 type: string nullable: true type: array pending_verification: description: >- 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. items: maxLength: 5000 type: string nullable: true type: array title: AccountRequirements type: object x-expandableFields: - alternatives - errors account_requirements_alternative: description: '' properties: alternative_fields_due: description: >- Fields that can be provided to satisfy all fields in `original_fields_due`. items: maxLength: 5000 type: string type: array original_fields_due: description: >- Fields that are due and can be satisfied by providing all fields in `alternative_fields_due`. items: maxLength: 5000 type: string type: array required: - alternative_fields_due - original_fields_due title: AccountRequirementsAlternative type: object x-expandableFields: [] account_requirements_error: description: '' properties: code: description: The code for the type of error. enum: - 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 type: string x-stripeBypassValidation: true reason: description: >- An informative message that indicates the error type and provides additional details about the error. maxLength: 5000 type: string requirement: description: >- The specific user onboarding requirement field (in the requirements hash) that needs to be resolved. maxLength: 5000 type: string required: - code - reason - requirement title: AccountRequirementsError type: object x-expandableFields: [] account_sepa_debit_payments_settings: description: '' properties: creditor_id: description: >- SEPA creditor identifier that identifies the company making the payment. maxLength: 5000 type: string title: AccountSepaDebitPaymentsSettings type: object x-expandableFields: [] account_session: description: >- An AccountSession allows a Connect platform to grant access to a connected account in Connect embedded components. We recommend that you create an AccountSession each time you need to display an embedded component to your user. Do not save AccountSessions to your database as they expire relatively quickly, and cannot be used more than once. Related guide: [Connect embedded components](https://stripe.com/docs/connect/get-started-connect-embedded-components) properties: account: description: The ID of the account the AccountSession was created for maxLength: 5000 type: string client_secret: description: >- The client secret of this AccountSession. Used on the client to set up secure access to the given `account`. The client secret can be used to provide access to `account` from your frontend. It should not be stored, logged, or exposed to anyone other than the connected account. Make sure that you have TLS enabled on any page that includes the client secret. Refer to our docs to [setup Connect embedded components](https://stripe.com/docs/connect/get-started-connect-embedded-components) and learn about how `client_secret` should be handled. maxLength: 5000 type: string components: $ref: >- #/components/schemas/connect_embedded_account_session_create_components expires_at: description: The timestamp at which this AccountSession will expire. format: unix-time type: integer livemode: description: >- Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. type: boolean object: description: >- String representing the object's type. Objects of the same type share the same value. enum: - account_session type: string required: - account - client_secret - components - expires_at - livemode - object title: ConnectEmbeddedMethodAccountSessionCreateMethodAccountSession type: object x-expandableFields: - components x-resourceId: account_session account_settings: description: '' properties: bacs_debit_payments: $ref: '#/components/schemas/account_bacs_debit_payments_settings' branding: $ref: '#/components/schemas/account_branding_settings' card_issuing: $ref: '#/components/schemas/account_card_issuing_settings' card_payments: $ref: '#/components/schemas/account_card_payments_settings' dashboard: $ref: '#/components/schemas/account_dashboard_settings' invoices: $ref: '#/components/schemas/account_invoices_settings' payments: $ref: '#/components/schemas/account_payments_settings' payouts: $ref: '#/components/schemas/account_payout_settings' sepa_debit_payments: $ref: '#/components/schemas/account_sepa_debit_payments_settings' treasury: $ref: '#/components/schemas/account_treasury_settings' required: - branding - card_payments - dashboard - payments title: AccountSettings type: object x-expandableFields: - bacs_debit_payments - branding - card_issuing - card_payments - dashboard - invoices - payments - payouts - sepa_debit_payments - treasury account_terms_of_service: description: '' properties: date: description: >- The Unix timestamp marking when the account representative accepted the service agreement. nullable: true type: integer ip: description: >- The IP address from which the account representative accepted the service agreement. maxLength: 5000 nullable: true type: string user_agent: description: >- The user agent of the browser from which the account representative accepted the service agreement. maxLength: 5000 type: string title: AccountTermsOfService type: object x-expandableFields: [] account_tos_acceptance: description: '' properties: date: description: >- The Unix timestamp marking when the account representative accepted their service agreement format: unix-time nullable: true type: integer ip: description: >- The IP address from which the account representative accepted their service agreement maxLength: 5000 nullable: true type: string service_agreement: description: The user's service agreement type maxLength: 5000 type: string user_agent: description: >- The user agent of the browser from which the account representative accepted their service agreement maxLength: 5000 nullable: true type: string title: AccountTOSAcceptance type: object x-expandableFields: [] account_treasury_settings: description: '' properties: tos_acceptance: $ref: '#/components/schemas/account_terms_of_service' title: AccountTreasurySettings type: object x-expandableFields: - tos_acceptance account_unification_account_controller: description: '' properties: fees: $ref: '#/components/schemas/account_unification_account_controller_fees' is_controller: description: >- `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. type: boolean losses: $ref: '#/components/schemas/account_unification_account_controller_losses' requirement_collection: description: >- A value indicating responsibility for collecting requirements on this account. Only returned when the Connect application retrieving the resource controls the account. enum: - application - stripe type: string stripe_dashboard: $ref: >- #/components/schemas/account_unification_account_controller_stripe_dashboard type: description: >- The controller type. Can be `application`, if a Connect application controls the account, or `account`, if the account controls itself. enum: - account - application type: string required: - type title: AccountUnificationAccountController type: object x-expandableFields: - fees - losses - stripe_dashboard account_unification_account_controller_fees: description: '' properties: payer: description: >- A value indicating the responsible payer of a bundle of Stripe fees for pricing-control eligible products on this account. enum: - account - application - application_custom - application_express type: string x-stripeBypassValidation: true required: - payer title: AccountUnificationAccountControllerFees type: object x-expandableFields: [] account_unification_account_controller_losses: description: '' properties: payments: description: >- A value indicating who is liable when this account can't pay back negative balances from payments. enum: - application - stripe type: string required: - payments title: AccountUnificationAccountControllerLosses type: object x-expandableFields: [] account_unification_account_controller_stripe_dashboard: description: '' properties: type: description: >- A value indicating the Stripe dashboard this account has access to independent of the Connect application. enum: - express - full - none type: string required: - type title: AccountUnificationAccountControllerStripeDashboard type: object x-expandableFields: [] address: description: '' properties: city: description: 'City, district, suburb, town, or village.' maxLength: 5000 nullable: true type: string country: description: >- Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)). maxLength: 5000 nullable: true type: string line1: description: 'Address line 1 (e.g., street, PO Box, or company name).' maxLength: 5000 nullable: true type: string line2: description: 'Address line 2 (e.g., apartment, suite, unit, or building).' maxLength: 5000 nullable: true type: string postal_code: description: ZIP or postal code. maxLength: 5000 nullable: true type: string state: description: 'State, county, province, or region.' maxLength: 5000 nullable: true type: string title: Address type: object x-expandableFields: [] api_errors: description: '' properties: charge: description: 'For card errors, the ID of the failed charge.' maxLength: 5000 type: string code: description: >- For some errors that could be handled programmatically, a short string indicating the [error code](https://stripe.com/docs/error-codes) reported. maxLength: 5000 type: string decline_code: description: >- 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. maxLength: 5000 type: string doc_url: description: >- A URL to more information about the [error code](https://stripe.com/docs/error-codes) reported. maxLength: 5000 type: string message: description: >- A human-readable message providing more details about the error. For card errors, these messages can be shown to your users. maxLength: 40000 type: string param: description: >- 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. maxLength: 5000 type: string payment_intent: $ref: '#/components/schemas/payment_intent' payment_method: $ref: '#/components/schemas/payment_method' payment_method_type: description: >- If the error is specific to the type of payment method, the payment method type that had a problem. This field is only populated for invoice-related errors. maxLength: 5000 type: string request_log_url: description: A URL to the request log entry in your dashboard. maxLength: 5000 type: string setup_intent: $ref: '#/components/schemas/setup_intent' source: anyOf: - $ref: '#/components/schemas/bank_account' - $ref: '#/components/schemas/card' - $ref: '#/components/schemas/source' description: >- The [source object](https://stripe.com/docs/api/sources/object) for errors returned on a request involving a source. type: description: >- The type of error returned. One of `api_error`, `card_error`, `idempotency_error`, or `invalid_request_error` enum: - api_error - card_error - idempotency_error - invalid_request_error type: string required: - type title: APIErrors type: object x-expandableFields: - payment_intent - payment_method - setup_intent - source apple_pay_domain: description: '' properties: created: description: >- Time at which the object was created. Measured in seconds since the Unix epoch. format: unix-time type: integer domain_name: maxLength: 5000 type: string id: description: Unique identifier for the object. maxLength: 5000 type: string livemode: description: >- Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. type: boolean object: description: >- String representing the object's type. Objects of the same type share the same value. enum: - apple_pay_domain type: string required: - created - domain_name - id - livemode - object title: ApplePayDomain type: object x-expandableFields: [] x-resourceId: apple_pay_domain application: description: '' properties: id: description: Unique identifier for the object. maxLength: 5000 type: string name: description: The name of the application. maxLength: 5000 nullable: true type: string object: description: >- String representing the object's type. Objects of the same type share the same value. enum: - application type: string required: - id - object title: Application type: object x-expandableFields: [] application_fee: description: '' properties: account: anyOf: - maxLength: 5000 type: string - $ref: '#/components/schemas/account' description: ID of the Stripe account this fee was taken from. x-expansionResources: oneOf: - $ref: '#/components/schemas/account' amount: description: 'Amount earned, in cents (or local equivalent).' type: integer amount_refunded: description: >- Amount in cents (or local equivalent) refunded (can be less than the amount attribute on the fee if a partial refund was issued) type: integer application: anyOf: - maxLength: 5000 type: string - $ref: '#/components/schemas/application' description: ID of the Connect application that earned the fee. x-expansionResources: oneOf: - $ref: '#/components/schemas/application' balance_transaction: anyOf: - maxLength: 5000 type: string - $ref: '#/components/schemas/balance_transaction' description: >- Balance transaction that describes the impact of this collected application fee on your account balance (not including refunds). nullable: true x-expansionResources: oneOf: - $ref: '#/components/schemas/balance_transaction' charge: anyOf: - maxLength: 5000 type: string - $ref: '#/components/schemas/charge' description: ID of the charge that the application fee was taken from. x-expansionResources: oneOf: - $ref: '#/components/schemas/charge' created: description: >- Time at which the object was created. Measured in seconds since the Unix epoch. format: unix-time type: integer currency: description: >- 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). type: string id: description: Unique identifier for the object. maxLength: 5000 type: string livemode: description: >- Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. type: boolean object: description: >- String representing the object's type. Objects of the same type share the same value. enum: - application_fee type: string originating_transaction: anyOf: - maxLength: 5000 type: string - $ref: '#/components/schemas/charge' description: >- ID of the corresponding charge on the platform account, if this fee was the result of a charge using the `destination` parameter. nullable: true x-expansionResources: oneOf: - $ref: '#/components/schemas/charge' refunded: description: >- Whether the fee has been fully refunded. If the fee is only partially refunded, this attribute will still be false. type: boolean refunds: description: A list of refunds that have been applied to the fee. properties: data: description: Details about each object. items: $ref: '#/components/schemas/fee_refund' type: array has_more: description: >- True if this list has another page of items after this one that can be fetched. type: boolean object: description: >- String representing the object's type. Objects of the same type share the same value. Always has the value `list`. enum: - list type: string url: description: The URL where this list can be accessed. maxLength: 5000 type: string required: - data - has_more - object - url title: FeeRefundList type: object x-expandableFields: - data required: - account - amount - amount_refunded - application - charge - created - currency - id - livemode - object - refunded - refunds title: PlatformFee type: object x-expandableFields: - account - application - balance_transaction - charge - originating_transaction - refunds x-resourceId: application_fee apps.secret: description: >- Secret Store is an API that allows Stripe Apps developers to securely persist secrets for use by UI Extensions and app backends. The primary resource in Secret Store is a `secret`. Other apps can't view secrets created by an app. Additionally, secrets are scoped to provide further permission control. All Dashboard users and the app backend share `account` scoped secrets. Use the `account` scope for secrets that don't change per-user, like a third-party API key. A `user` scoped secret is accessible by the app backend and one specific Dashboard user. Use the `user` scope for per-user secrets like per-user OAuth tokens, where different users might have different permissions. Related guide: [Store data between page reloads](https://stripe.com/docs/stripe-apps/store-auth-data-custom-objects) properties: created: description: >- Time at which the object was created. Measured in seconds since the Unix epoch. format: unix-time type: integer deleted: description: 'If true, indicates that this secret has been deleted' type: boolean expires_at: description: >- The Unix timestamp for the expiry time of the secret, after which the secret deletes. format: unix-time nullable: true type: integer id: description: Unique identifier for the object. maxLength: 5000 type: string livemode: description: >- Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. type: boolean name: description: A name for the secret that's unique within the scope. maxLength: 5000 type: string object: description: >- String representing the object's type. Objects of the same type share the same value. enum: - apps.secret type: string payload: description: The plaintext secret value to be stored. maxLength: 5000 nullable: true type: string scope: $ref: '#/components/schemas/secret_service_resource_scope' required: - created - id - livemode - name - object - scope title: SecretServiceResourceSecret type: object x-expandableFields: - scope x-resourceId: apps.secret automatic_tax: description: '' properties: enabled: description: >- Whether Stripe automatically computes tax on this invoice. Note that incompatible invoice items (invoice items with manually specified [tax rates](https://stripe.com/docs/api/tax_rates), negative amounts, or `tax_behavior=unspecified`) cannot be added to automatic tax invoices. type: boolean liability: anyOf: - $ref: '#/components/schemas/connect_account_reference' description: >- The account that's liable for tax. If set, the business address and tax registrations required to perform the tax calculation are loaded from this account. The tax transaction is returned in the report of the connected account. nullable: true status: description: >- The status of the most recent automated tax calculation for this invoice. enum: - complete - failed - requires_location_inputs nullable: true type: string required: - enabled title: AutomaticTax type: object x-expandableFields: - liability balance: description: >- This is an object representing your Stripe balance. You can retrieve it to see the balance currently on your Stripe account. You can also retrieve the balance history, which contains a list of [transactions](https://stripe.com/docs/reporting/balance-transaction-types) that contributed to the balance (charges, payouts, and so forth). The available and pending amounts for each currency are broken down further by payment source types. Related guide: [Understanding Connect account balances](https://stripe.com/docs/connect/account-balances) properties: available: description: >- Available funds that you can transfer or pay out automatically by Stripe or explicitly through the [Transfers API](https://stripe.com/docs/api#transfers) or [Payouts API](https://stripe.com/docs/api#payouts). You can find the available balance for each currency and payment type in the `source_types` property. items: $ref: '#/components/schemas/balance_amount' type: array connect_reserved: description: >- Funds held due to negative balances on connected Custom accounts. You can find the connect reserve balance for each currency and payment type in the `source_types` property. items: $ref: '#/components/schemas/balance_amount' type: array instant_available: description: Funds that you can pay out using Instant Payouts. items: $ref: '#/components/schemas/balance_amount_net' type: array issuing: $ref: '#/components/schemas/balance_detail' livemode: description: >- Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. type: boolean object: description: >- String representing the object's type. Objects of the same type share the same value. enum: - balance type: string pending: description: >- Funds that aren't available in the balance yet. You can find the pending balance for each currency and each payment type in the `source_types` property. items: $ref: '#/components/schemas/balance_amount' type: array required: - available - livemode - object - pending title: Balance type: object x-expandableFields: - available - connect_reserved - instant_available - issuing - pending x-resourceId: balance balance_amount: description: '' properties: amount: description: Balance amount. type: integer currency: description: >- 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). type: string source_types: $ref: '#/components/schemas/balance_amount_by_source_type' required: - amount - currency title: BalanceAmount type: object x-expandableFields: - source_types balance_amount_by_source_type: description: '' properties: bank_account: description: Amount for bank account. type: integer card: description: Amount for card. type: integer fpx: description: Amount for FPX. type: integer title: BalanceAmountBySourceType type: object x-expandableFields: [] balance_amount_net: description: '' properties: amount: description: Balance amount. type: integer currency: description: >- 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). type: string source_types: $ref: '#/components/schemas/balance_amount_by_source_type' required: - amount - currency title: BalanceAmountNet type: object x-expandableFields: - source_types balance_detail: description: '' properties: available: description: Funds that are available for use. items: $ref: '#/components/schemas/balance_amount' type: array required: - available title: BalanceDetail type: object x-expandableFields: - available balance_transaction: description: >- Balance transactions represent funds moving through your Stripe account. Stripe creates them for every type of transaction that enters or leaves your Stripe account balance. Related guide: [Balance transaction types](https://stripe.com/docs/reports/balance-transaction-types) properties: amount: description: >- Gross amount of this transaction (in cents (or local equivalent)). A positive value represents funds charged to another party, and a negative value represents funds sent to another party. type: integer available_on: description: >- The date that the transaction's net funds become available in the Stripe balance. format: unix-time type: integer created: description: >- Time at which the object was created. Measured in seconds since the Unix epoch. format: unix-time type: integer currency: description: >- 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). type: string description: description: >- An arbitrary string attached to the object. Often useful for displaying to users. maxLength: 5000 nullable: true type: string exchange_rate: description: >- If applicable, this transaction uses an exchange rate. If money converts from currency A to currency B, then the `amount` in currency A, multipled by the `exchange_rate`, equals the `amount` in currency B. For example, if you charge a customer 10.00 EUR, the PaymentIntent's `amount` is `1000` and `currency` is `eur`. If this converts to 12.34 USD in your Stripe account, the BalanceTransaction's `amount` is `1234`, its `currency` is `usd`, and the `exchange_rate` is `1.234`. nullable: true type: number fee: description: >- Fees (in cents (or local equivalent)) paid for this transaction. Represented as a positive integer when assessed. type: integer fee_details: description: >- Detailed breakdown of fees (in cents (or local equivalent)) paid for this transaction. items: $ref: '#/components/schemas/fee' type: array id: description: Unique identifier for the object. maxLength: 5000 type: string net: description: >- Net impact to a Stripe balance (in cents (or local equivalent)). A positive value represents incrementing a Stripe balance, and a negative value decrementing a Stripe balance. You can calculate the net impact of a transaction on a balance by `amount` - `fee` type: integer object: description: >- String representing the object's type. Objects of the same type share the same value. enum: - balance_transaction type: string reporting_category: description: >- Learn more about how [reporting categories](https://stripe.com/docs/reports/reporting-categories) can help you understand balance transactions from an accounting perspective. maxLength: 5000 type: string source: anyOf: - maxLength: 5000 type: string - $ref: '#/components/schemas/application_fee' - $ref: '#/components/schemas/charge' - $ref: '#/components/schemas/connect_collection_transfer' - $ref: '#/components/schemas/customer_cash_balance_transaction' - $ref: '#/components/schemas/dispute' - $ref: '#/components/schemas/fee_refund' - $ref: '#/components/schemas/issuing.authorization' - $ref: '#/components/schemas/issuing.dispute' - $ref: '#/components/schemas/issuing.transaction' - $ref: '#/components/schemas/payout' - $ref: '#/components/schemas/platform_tax_fee' - $ref: '#/components/schemas/refund' - $ref: '#/components/schemas/reserve_transaction' - $ref: '#/components/schemas/tax_deducted_at_source' - $ref: '#/components/schemas/topup' - $ref: '#/components/schemas/transfer' - $ref: '#/components/schemas/transfer_reversal' description: This transaction relates to the Stripe object. nullable: true x-expansionResources: oneOf: - $ref: '#/components/schemas/application_fee' - $ref: '#/components/schemas/charge' - $ref: '#/components/schemas/connect_collection_transfer' - $ref: '#/components/schemas/customer_cash_balance_transaction' - $ref: '#/components/schemas/dispute' - $ref: '#/components/schemas/fee_refund' - $ref: '#/components/schemas/issuing.authorization' - $ref: '#/components/schemas/issuing.dispute' - $ref: '#/components/schemas/issuing.transaction' - $ref: '#/components/schemas/payout' - $ref: '#/components/schemas/platform_tax_fee' - $ref: '#/components/schemas/refund' - $ref: '#/components/schemas/reserve_transaction' - $ref: '#/components/schemas/tax_deducted_at_source' - $ref: '#/components/schemas/topup' - $ref: '#/components/schemas/transfer' - $ref: '#/components/schemas/transfer_reversal' x-stripeBypassValidation: true status: description: >- The transaction's net funds status in the Stripe balance, which are either `available` or `pending`. maxLength: 5000 type: string type: description: >- Transaction type: `adjustment`, `advance`, `advance_funding`, `anticipation_repayment`, `application_fee`, `application_fee_refund`, `charge`, `climate_order_purchase`, `climate_order_refund`, `connect_collection_transfer`, `contribution`, `issuing_authorization_hold`, `issuing_authorization_release`, `issuing_dispute`, `issuing_transaction`, `obligation_outbound`, `obligation_reversal_inbound`, `payment`, `payment_failure_refund`, `payment_network_reserve_hold`, `payment_network_reserve_release`, `payment_refund`, `payment_reversal`, `payment_unreconciled`, `payout`, `payout_cancel`, `payout_failure`, `refund`, `refund_failure`, `reserve_transaction`, `reserved_funds`, `stripe_fee`, `stripe_fx_fee`, `tax_fee`, `topup`, `topup_reversal`, `transfer`, `transfer_cancel`, `transfer_failure`, or `transfer_refund`. Learn more about [balance transaction types and what they represent](https://stripe.com/docs/reports/balance-transaction-types). To classify transactions for accounting purposes, consider `reporting_category` instead. enum: - adjustment - advance - advance_funding - anticipation_repayment - application_fee - application_fee_refund - charge - climate_order_purchase - climate_order_refund - connect_collection_transfer - contribution - issuing_authorization_hold - issuing_authorization_release - issuing_dispute - issuing_transaction - obligation_outbound - obligation_reversal_inbound - payment - payment_failure_refund - payment_network_reserve_hold - payment_network_reserve_release - payment_refund - payment_reversal - payment_unreconciled - payout - payout_cancel - payout_failure - refund - refund_failure - reserve_transaction - reserved_funds - stripe_fee - stripe_fx_fee - tax_fee - topup - topup_reversal - transfer - transfer_cancel - transfer_failure - transfer_refund type: string required: - amount - available_on - created - currency - fee - fee_details - id - net - object - reporting_category - status - type title: BalanceTransaction type: object x-expandableFields: - fee_details - source x-resourceId: balance_transaction bank_account: description: >- These bank accounts are payment methods on `Customer` objects. On the other hand [External Accounts](https://stripe.com/docs/api#external_accounts) are transfer destinations on `Account` objects for [Custom accounts](https://stripe.com/docs/connect/custom-accounts). They can be bank accounts or debit cards as well, and are documented in the links above. Related guide: [Bank debits and transfers](https://stripe.com/docs/payments/bank-debits-transfers) properties: account: anyOf: - maxLength: 5000 type: string - $ref: '#/components/schemas/account' description: The ID of the account that the bank account is associated with. nullable: true x-expansionResources: oneOf: - $ref: '#/components/schemas/account' account_holder_name: description: The name of the person or business that owns the bank account. maxLength: 5000 nullable: true type: string account_holder_type: description: >- The type of entity that holds the account. This can be either `individual` or `company`. maxLength: 5000 nullable: true type: string account_type: description: >- The bank account type. This can only be `checking` or `savings` in most countries. In Japan, this can only be `futsu` or `toza`. maxLength: 5000 nullable: true type: string available_payout_methods: description: >- 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. items: enum: - instant - standard type: string nullable: true type: array bank_name: description: >- Name of the bank associated with the routing number (e.g., `WELLS FARGO`). maxLength: 5000 nullable: true type: string country: description: >- Two-letter ISO code representing the country the bank account is located in. maxLength: 5000 type: string currency: description: >- Three-letter [ISO code for the currency](https://stripe.com/docs/payouts) paid out to the bank account. type: string customer: anyOf: - maxLength: 5000 type: string - $ref: '#/components/schemas/customer' - $ref: '#/components/schemas/deleted_customer' description: The ID of the customer that the bank account is associated with. nullable: true x-expansionResources: oneOf: - $ref: '#/components/schemas/customer' - $ref: '#/components/schemas/deleted_customer' default_for_currency: description: >- Whether this bank account is the default external account for its currency. nullable: true type: boolean fingerprint: description: >- Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same. maxLength: 5000 nullable: true type: string future_requirements: anyOf: - $ref: '#/components/schemas/external_account_requirements' description: >- Information about the [upcoming new requirements for the bank account](https://stripe.com/docs/connect/custom-accounts/future-requirements), including what information needs to be collected, and by when. nullable: true id: description: Unique identifier for the object. maxLength: 5000 type: string last4: description: The last four digits of the bank account number. maxLength: 5000 type: string metadata: additionalProperties: maxLength: 500 type: string description: >- 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. nullable: true type: object object: description: >- String representing the object's type. Objects of the same type share the same value. enum: - bank_account type: string requirements: anyOf: - $ref: '#/components/schemas/external_account_requirements' description: >- Information about the requirements for the bank account, including what information needs to be collected. nullable: true routing_number: description: The routing transit number for the bank account. maxLength: 5000 nullable: true type: string status: description: >- 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. maxLength: 5000 type: string required: - country - currency - id - last4 - object - status title: BankAccount type: object x-expandableFields: - account - customer - future_requirements - requirements x-resourceId: bank_account bank_connections_resource_accountholder: description: '' properties: account: anyOf: - maxLength: 5000 type: string - $ref: '#/components/schemas/account' description: >- The ID of the Stripe account this account belongs to. Should only be present if `account_holder.type` is `account`. x-expansionResources: oneOf: - $ref: '#/components/schemas/account' customer: anyOf: - maxLength: 5000 type: string - $ref: '#/components/schemas/customer' description: >- ID of the Stripe customer this account belongs to. Present if and only if `account_holder.type` is `customer`. x-expansionResources: oneOf: - $ref: '#/components/schemas/customer' type: description: Type of account holder that this account belongs to. enum: - account - customer type: string required: - type title: BankConnectionsResourceAccountholder type: object x-expandableFields: - account - customer bank_connections_resource_balance: description: '' properties: as_of: description: >- The time that the external institution calculated this balance. Measured in seconds since the Unix epoch. format: unix-time type: integer cash: $ref: >- #/components/schemas/bank_connections_resource_balance_api_resource_cash_balance credit: $ref: >- #/components/schemas/bank_connections_resource_balance_api_resource_credit_balance current: additionalProperties: type: integer description: >- The balances owed to (or by) the account holder. Each key is a three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Each value is a integer amount. A positive amount indicates money owed to the account holder. A negative amount indicates money owed by the account holder. type: object type: description: >- The `type` of the balance. An additional hash is included on the balance with a name matching this value. enum: - cash - credit type: string required: - as_of - current - type title: BankConnectionsResourceBalance type: object x-expandableFields: - cash - credit bank_connections_resource_balance_api_resource_cash_balance: description: '' properties: available: additionalProperties: type: integer description: >- The funds available to the account holder. Typically this is the current balance less any holds. Each key is a three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Each value is a integer amount. A positive amount indicates money owed to the account holder. A negative amount indicates money owed by the account holder. nullable: true type: object title: BankConnectionsResourceBalanceAPIResourceCashBalance type: object x-expandableFields: [] bank_connections_resource_balance_api_resource_credit_balance: description: '' properties: used: additionalProperties: type: integer description: >- The credit that has been used by the account holder. Each key is a three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Each value is a integer amount. A positive amount indicates money owed to the account holder. A negative amount indicates money owed by the account holder. nullable: true type: object title: BankConnectionsResourceBalanceAPIResourceCreditBalance type: object x-expandableFields: [] bank_connections_resource_balance_refresh: description: '' properties: last_attempted_at: description: >- The time at which the last refresh attempt was initiated. Measured in seconds since the Unix epoch. format: unix-time type: integer next_refresh_available_at: description: >- Time at which the next balance refresh can be initiated. This value will be `null` when `status` is `pending`. Measured in seconds since the Unix epoch. format: unix-time nullable: true type: integer status: description: The status of the last refresh attempt. enum: - failed - pending - succeeded type: string required: - last_attempted_at - status title: BankConnectionsResourceBalanceRefresh type: object x-expandableFields: [] bank_connections_resource_link_account_session_filters: description: '' properties: countries: description: List of countries from which to filter accounts. items: maxLength: 5000 type: string nullable: true type: array title: BankConnectionsResourceLinkAccountSessionFilters type: object x-expandableFields: [] bank_connections_resource_ownership_refresh: description: '' properties: last_attempted_at: description: >- The time at which the last refresh attempt was initiated. Measured in seconds since the Unix epoch. format: unix-time type: integer next_refresh_available_at: description: >- Time at which the next ownership refresh can be initiated. This value will be `null` when `status` is `pending`. Measured in seconds since the Unix epoch. format: unix-time nullable: true type: integer status: description: The status of the last refresh attempt. enum: - failed - pending - succeeded type: string required: - last_attempted_at - status title: BankConnectionsResourceOwnershipRefresh type: object x-expandableFields: [] bank_connections_resource_transaction_refresh: description: '' properties: id: description: Unique identifier for the object. maxLength: 5000 type: string last_attempted_at: description: >- The time at which the last refresh attempt was initiated. Measured in seconds since the Unix epoch. format: unix-time type: integer next_refresh_available_at: description: >- Time at which the next transaction refresh can be initiated. This value will be `null` when `status` is `pending`. Measured in seconds since the Unix epoch. format: unix-time nullable: true type: integer status: description: The status of the last refresh attempt. enum: - failed - pending - succeeded type: string required: - id - last_attempted_at - status title: BankConnectionsResourceTransactionRefresh type: object x-expandableFields: [] bank_connections_resource_transaction_resource_status_transitions: description: '' properties: posted_at: description: >- Time at which this transaction posted. Measured in seconds since the Unix epoch. format: unix-time nullable: true type: integer void_at: description: >- Time at which this transaction was voided. Measured in seconds since the Unix epoch. format: unix-time nullable: true type: integer title: BankConnectionsResourceTransactionResourceStatusTransitions type: object x-expandableFields: [] billing.meter: description: >- A billing meter is a resource that allows you to track usage of a particular event. For example, you might create a billing meter to track the number of API calls made by a particular user. You can then attach the billing meter to a price and attach the price to a subscription to charge the user for the number of API calls they make. properties: created: description: >- Time at which the object was created. Measured in seconds since the Unix epoch. format: unix-time type: integer customer_mapping: $ref: >- #/components/schemas/billing_meter_resource_customer_mapping_settings default_aggregation: $ref: '#/components/schemas/billing_meter_resource_aggregation_settings' display_name: description: The meter's name. maxLength: 5000 type: string event_name: description: >- The name of the meter event to record usage for. Corresponds with the `event_name` field on meter events. maxLength: 5000 type: string event_time_window: description: 'The time window to pre-aggregate meter events for, if any.' enum: - day - hour nullable: true type: string id: description: Unique identifier for the object. maxLength: 5000 type: string livemode: description: >- Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. type: boolean object: description: >- String representing the object's type. Objects of the same type share the same value. enum: - billing.meter type: string status: description: The meter's status. enum: - active - inactive type: string status_transitions: $ref: >- #/components/schemas/billing_meter_resource_billing_meter_status_transitions updated: description: >- Time at which the object was last updated. Measured in seconds since the Unix epoch. format: unix-time type: integer value_settings: $ref: '#/components/schemas/billing_meter_resource_billing_meter_value' required: - created - customer_mapping - default_aggregation - display_name - event_name - id - livemode - object - status - status_transitions - updated - value_settings title: BillingMeter type: object x-expandableFields: - customer_mapping - default_aggregation - status_transitions - value_settings x-resourceId: billing.meter billing.meter_event: description: >- A billing meter event represents a customer's usage of a product. Meter events are used to bill a customer based on their usage. Meter events are associated with billing meters, which define the shape of the event's payload and how those events are aggregated for billing. properties: created: description: >- Time at which the object was created. Measured in seconds since the Unix epoch. format: unix-time type: integer event_name: description: >- The name of the meter event. Corresponds with the `event_name` field on a meter. maxLength: 100 type: string identifier: description: A unique identifier for the event. maxLength: 5000 type: string livemode: description: >- Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. type: boolean object: description: >- String representing the object's type. Objects of the same type share the same value. enum: - billing.meter_event type: string payload: additionalProperties: maxLength: 100 type: string description: >- The payload of the event. This contains the fields corresponding to a meter's `customer_mapping.event_payload_key` (default is `stripe_customer_id`) and `value_settings.event_payload_key` (default is `value`). Read more about the [payload](https://stripe.com/docs/billing/subscriptions/usage-based/recording-usage#payload-key-overrides). type: object timestamp: description: >- The timestamp passed in when creating the event. Measured in seconds since the Unix epoch. format: unix-time type: integer required: - created - event_name - identifier - livemode - object - payload - timestamp title: BillingMeterEvent type: object x-expandableFields: [] x-resourceId: billing.meter_event billing.meter_event_adjustment: description: >- A billing meter event adjustment is a resource that allows you to cancel a meter event. For example, you might create a billing meter event adjustment to cancel a meter event that was created in error or attached to the wrong customer. properties: cancel: anyOf: - $ref: >- #/components/schemas/billing_meter_resource_billing_meter_event_adjustment_cancel description: Specifies which event to cancel. nullable: true event_name: description: >- The name of the meter event. Corresponds with the `event_name` field on a meter. maxLength: 100 type: string livemode: description: >- Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. type: boolean object: description: >- String representing the object's type. Objects of the same type share the same value. enum: - billing.meter_event_adjustment type: string status: description: The meter event adjustment's status. enum: - complete - pending type: string type: description: >- Specifies whether to cancel a single event or a range of events for a time period. Time period cancellation is not supported yet. enum: - cancel type: string required: - event_name - livemode - object - status - type title: BillingMeterEventAdjustment type: object x-expandableFields: - cancel x-resourceId: billing.meter_event_adjustment billing.meter_event_summary: description: >- A billing meter event summary represents an aggregated view of a customer's billing meter events within a specified timeframe. It indicates how much usage was accrued by a customer for that period. properties: aggregated_value: description: >- Aggregated value of all the events within `start_time` (inclusive) and `end_time` (inclusive). The aggregation strategy is defined on meter via `default_aggregation`. type: number end_time: description: End timestamp for this event summary (inclusive). format: unix-time type: integer id: description: Unique identifier for the object. maxLength: 5000 type: string livemode: description: >- Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. type: boolean meter: description: The meter associated with this event summary. maxLength: 5000 type: string object: description: >- String representing the object's type. Objects of the same type share the same value. enum: - billing.meter_event_summary type: string start_time: description: Start timestamp for this event summary (inclusive). format: unix-time type: integer required: - aggregated_value - end_time - id - livemode - meter - object - start_time title: BillingMeterEventSummary type: object x-expandableFields: [] x-resourceId: billing.meter_event_summary billing_details: description: '' properties: address: anyOf: - $ref: '#/components/schemas/address' description: Billing address. nullable: true email: description: Email address. maxLength: 5000 nullable: true type: string name: description: Full name. maxLength: 5000 nullable: true type: string phone: description: Billing phone number (including extension). maxLength: 5000 nullable: true type: string title: billing_details type: object x-expandableFields: - address billing_meter_resource_aggregation_settings: description: '' properties: formula: description: Specifies how events are aggregated. enum: - count - sum type: string required: - formula title: BillingMeterResourceAggregationSettings type: object x-expandableFields: [] billing_meter_resource_billing_meter_event_adjustment_cancel: description: '' properties: identifier: description: Unique identifier for the event. maxLength: 100 nullable: true type: string title: BillingMeterResourceBillingMeterEventAdjustmentCancel type: object x-expandableFields: [] billing_meter_resource_billing_meter_status_transitions: description: '' properties: deactivated_at: description: >- The time the meter was deactivated, if any. Measured in seconds since Unix epoch. format: unix-time nullable: true type: integer title: BillingMeterResourceBillingMeterStatusTransitions type: object x-expandableFields: [] billing_meter_resource_billing_meter_value: description: '' properties: event_payload_key: description: >- The key in the meter event payload to use as the value for this meter. maxLength: 5000 type: string required: - event_payload_key title: BillingMeterResourceBillingMeterValue type: object x-expandableFields: [] billing_meter_resource_customer_mapping_settings: description: '' properties: event_payload_key: description: >- The key in the meter event payload to use for mapping the event to a customer. maxLength: 5000 type: string type: description: The method for mapping a meter event to a customer. enum: - by_id type: string required: - event_payload_key - type title: BillingMeterResourceCustomerMappingSettings type: object x-expandableFields: [] billing_portal.configuration: description: >- A portal configuration describes the functionality and behavior of a portal session. properties: active: description: >- Whether the configuration is active and can be used to create portal sessions. type: boolean application: anyOf: - maxLength: 5000 type: string - $ref: '#/components/schemas/application' - $ref: '#/components/schemas/deleted_application' description: ID of the Connect Application that created the configuration. nullable: true x-expansionResources: oneOf: - $ref: '#/components/schemas/application' - $ref: '#/components/schemas/deleted_application' business_profile: $ref: '#/components/schemas/portal_business_profile' created: description: >- Time at which the object was created. Measured in seconds since the Unix epoch. format: unix-time type: integer default_return_url: description: >- The default URL to redirect customers to when they click on the portal's link to return to your website. This can be [overriden](https://stripe.com/docs/api/customer_portal/sessions/create#create_portal_session-return_url) when creating the session. maxLength: 5000 nullable: true type: string features: $ref: '#/components/schemas/portal_features' id: description: Unique identifier for the object. maxLength: 5000 type: string is_default: description: >- Whether the configuration is the default. If `true`, this configuration can be managed in the Dashboard and portal sessions will use this configuration unless it is overriden when creating the session. type: boolean livemode: description: >- Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. type: boolean login_page: $ref: '#/components/schemas/portal_login_page' metadata: additionalProperties: maxLength: 500 type: string description: >- 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. nullable: true type: object object: description: >- String representing the object's type. Objects of the same type share the same value. enum: - billing_portal.configuration type: string updated: description: >- Time at which the object was last updated. Measured in seconds since the Unix epoch. format: unix-time type: integer required: - active - business_profile - created - features - id - is_default - livemode - login_page - object - updated title: PortalConfiguration type: object x-expandableFields: - application - business_profile - features - login_page x-resourceId: billing_portal.configuration billing_portal.session: description: >- The Billing customer portal is a Stripe-hosted UI for subscription and billing management. A portal configuration describes the functionality and features that you want to provide to your customers through the portal. A portal session describes the instantiation of the customer portal for a particular customer. By visiting the session's URL, the customer can manage their subscriptions and billing details. For security reasons, sessions are short-lived and will expire if the customer does not visit the URL. Create sessions on-demand when customers intend to manage their subscriptions and billing details. Learn more in the [integration guide](https://stripe.com/docs/billing/subscriptions/integrating-customer-portal). properties: configuration: anyOf: - maxLength: 5000 type: string - $ref: '#/components/schemas/billing_portal.configuration' description: >- The configuration used by this session, describing the features available. x-expansionResources: oneOf: - $ref: '#/components/schemas/billing_portal.configuration' created: description: >- Time at which the object was created. Measured in seconds since the Unix epoch. format: unix-time type: integer customer: description: The ID of the customer for this session. maxLength: 5000 type: string flow: anyOf: - $ref: '#/components/schemas/portal_flows_flow' description: >- Information about a specific flow for the customer to go through. See the [docs](https://stripe.com/docs/customer-management/portal-deep-links) to learn more about using customer portal deep links and flows. nullable: true id: description: Unique identifier for the object. maxLength: 5000 type: string livemode: description: >- Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. type: boolean locale: description: >- The IETF language tag of the locale Customer Portal is displayed in. If blank or auto, the customer’s `preferred_locales` or browser’s locale is used. enum: - auto - bg - cs - da - de - el - en - en-AU - en-CA - en-GB - en-IE - en-IN - en-NZ - en-SG - es - es-419 - et - fi - fil - fr - fr-CA - hr - hu - id - it - ja - ko - lt - lv - ms - mt - nb - nl - pl - pt - pt-BR - ro - ru - sk - sl - sv - th - tr - vi - zh - zh-HK - zh-TW nullable: true type: string object: description: >- String representing the object's type. Objects of the same type share the same value. enum: - billing_portal.session type: string on_behalf_of: description: >- The account for which the session was created on behalf of. When specified, only subscriptions and invoices with this `on_behalf_of` account appear in the portal. For more information, see the [docs](https://stripe.com/docs/connect/separate-charges-and-transfers#settlement-merchant). Use the [Accounts API](https://stripe.com/docs/api/accounts/object#account_object-settings-branding) to modify the `on_behalf_of` account's branding settings, which the portal displays. maxLength: 5000 nullable: true type: string return_url: description: >- The URL to redirect customers to when they click on the portal's link to return to your website. maxLength: 5000 nullable: true type: string url: description: >- The short-lived URL of the session that gives customers access to the customer portal. maxLength: 5000 type: string required: - configuration - created - customer - id - livemode - object - url title: PortalSession type: object x-expandableFields: - configuration - flow x-resourceId: billing_portal.session cancellation_details: description: '' properties: comment: description: >- Additional comments about why the user canceled the subscription, if the subscription was canceled explicitly by the user. maxLength: 5000 nullable: true type: string feedback: description: >- The customer submitted reason for why they canceled, if the subscription was canceled explicitly by the user. enum: - customer_service - low_quality - missing_features - other - switched_service - too_complex - too_expensive - unused nullable: true type: string reason: description: Why this subscription was canceled. enum: - cancellation_requested - payment_disputed - payment_failed nullable: true type: string title: CancellationDetails type: object x-expandableFields: [] capability: description: >- This is an object representing a capability for a Stripe account. Related guide: [Account capabilities](https://stripe.com/docs/connect/account-capabilities) properties: account: anyOf: - maxLength: 5000 type: string - $ref: '#/components/schemas/account' description: The account for which the capability enables functionality. x-expansionResources: oneOf: - $ref: '#/components/schemas/account' future_requirements: $ref: '#/components/schemas/account_capability_future_requirements' id: description: The identifier for the capability. maxLength: 5000 type: string object: description: >- String representing the object's type. Objects of the same type share the same value. enum: - capability type: string requested: description: Whether the capability has been requested. type: boolean requested_at: description: >- Time at which the capability was requested. Measured in seconds since the Unix epoch. format: unix-time nullable: true type: integer requirements: $ref: '#/components/schemas/account_capability_requirements' status: description: >- The status of the capability. Can be `active`, `inactive`, `pending`, or `unrequested`. enum: - active - disabled - inactive - pending - unrequested type: string required: - account - id - object - requested - status title: AccountCapability type: object x-expandableFields: - account - future_requirements - requirements x-resourceId: capability card: description: >- 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) properties: account: anyOf: - maxLength: 5000 type: string - $ref: '#/components/schemas/account' description: >- 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. nullable: true x-expansionResources: oneOf: - $ref: '#/components/schemas/account' address_city: description: City/District/Suburb/Town/Village. maxLength: 5000 nullable: true type: string address_country: description: 'Billing address country, if provided when creating card.' maxLength: 5000 nullable: true type: string address_line1: description: Address line 1 (Street address/PO Box/Company name). maxLength: 5000 nullable: true type: string address_line1_check: description: >- If `address_line1` was provided, results of the check: `pass`, `fail`, `unavailable`, or `unchecked`. maxLength: 5000 nullable: true type: string address_line2: description: Address line 2 (Apartment/Suite/Unit/Building). maxLength: 5000 nullable: true type: string address_state: description: State/County/Province/Region. maxLength: 5000 nullable: true type: string address_zip: description: ZIP or postal code. maxLength: 5000 nullable: true type: string address_zip_check: description: >- If `address_zip` was provided, results of the check: `pass`, `fail`, `unavailable`, or `unchecked`. maxLength: 5000 nullable: true type: string available_payout_methods: description: >- A set of available payout methods for this card. Only values from this set should be passed as the `method` when creating a payout. items: enum: - instant - standard type: string nullable: true type: array brand: description: >- Card brand. Can be `American Express`, `Diners Club`, `Discover`, `Eftpos Australia`, `JCB`, `MasterCard`, `UnionPay`, `Visa`, or `Unknown`. maxLength: 5000 type: string country: description: >- 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. maxLength: 5000 nullable: true type: string currency: description: >- Three-letter [ISO code for currency](https://stripe.com/docs/payouts). Only applicable on accounts (not customers or recipients). The card can be used as a transfer destination for funds in this currency. nullable: true type: string customer: anyOf: - maxLength: 5000 type: string - $ref: '#/components/schemas/customer' - $ref: '#/components/schemas/deleted_customer' description: >- 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. nullable: true x-expansionResources: oneOf: - $ref: '#/components/schemas/customer' - $ref: '#/components/schemas/deleted_customer' cvc_check: description: >- 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). maxLength: 5000 nullable: true type: string default_for_currency: description: Whether this card is the default external account for its currency. nullable: true type: boolean dynamic_last4: description: >- (For tokenized numbers only.) The last four digits of the device account number. maxLength: 5000 nullable: true type: string exp_month: description: Two-digit number representing the card's expiration month. type: integer exp_year: description: Four-digit number representing the card's expiration year. type: integer fingerprint: description: >- 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.* maxLength: 5000 nullable: true type: string funding: description: >- Card funding type. Can be `credit`, `debit`, `prepaid`, or `unknown`. maxLength: 5000 type: string id: description: Unique identifier for the object. maxLength: 5000 type: string last4: description: The last four digits of the card. maxLength: 5000 type: string metadata: additionalProperties: maxLength: 500 type: string description: >- 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. nullable: true type: object name: description: Cardholder name. maxLength: 5000 nullable: true type: string networks: $ref: '#/components/schemas/token_card_networks' object: description: >- String representing the object's type. Objects of the same type share the same value. enum: - card type: string status: description: >- 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. maxLength: 5000 nullable: true type: string tokenization_method: description: >- 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. maxLength: 5000 nullable: true type: string required: - brand - exp_month - exp_year - funding - id - last4 - object title: Card type: object x-expandableFields: - account - customer - networks x-resourceId: card card_generated_from_payment_method_details: description: '' properties: card_present: $ref: '#/components/schemas/payment_method_details_card_present' type: description: >- The type of payment method transaction-specific details from the transaction that generated this `card` payment method. Always `card_present`. maxLength: 5000 type: string required: - type title: card_generated_from_payment_method_details type: object x-expandableFields: - card_present card_issuing_account_terms_of_service: description: '' properties: date: description: >- The Unix timestamp marking when the account representative accepted the service agreement. nullable: true type: integer ip: description: >- The IP address from which the account representative accepted the service agreement. maxLength: 5000 nullable: true type: string user_agent: description: >- The user agent of the browser from which the account representative accepted the service agreement. maxLength: 5000 type: string title: CardIssuingAccountTermsOfService type: object x-expandableFields: [] card_mandate_payment_method_details: description: '' properties: {} title: card_mandate_payment_method_details type: object x-expandableFields: [] cash_balance: description: >- 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. properties: available: additionalProperties: type: integer description: >- 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). nullable: true type: object customer: description: The ID of the customer whose cash balance this object represents. maxLength: 5000 type: string livemode: description: >- Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. type: boolean object: description: >- String representing the object's type. Objects of the same type share the same value. enum: - cash_balance type: string settings: $ref: '#/components/schemas/customer_balance_customer_balance_settings' required: - customer - livemode - object - settings title: cash_balance type: object x-expandableFields: - settings x-resourceId: cash_balance charge: description: >- 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. properties: amount: description: >- 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). type: integer amount_captured: description: >- Amount in cents (or local equivalent) captured (can be less than the amount attribute on the charge if a partial capture was made). type: integer amount_refunded: description: >- Amount in cents (or local equivalent) refunded (can be less than the amount attribute on the charge if a partial refund was issued). type: integer application: anyOf: - maxLength: 5000 type: string - $ref: '#/components/schemas/application' description: ID of the Connect application that created the charge. nullable: true x-expansionResources: oneOf: - $ref: '#/components/schemas/application' application_fee: anyOf: - maxLength: 5000 type: string - $ref: '#/components/schemas/application_fee' description: >- The application fee (if any) for the charge. [See the Connect documentation](https://stripe.com/docs/connect/direct-charges#collect-fees) for details. nullable: true x-expansionResources: oneOf: - $ref: '#/components/schemas/application_fee' application_fee_amount: description: >- 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. nullable: true type: integer balance_transaction: anyOf: - maxLength: 5000 type: string - $ref: '#/components/schemas/balance_transaction' description: >- ID of the balance transaction that describes the impact of this charge on your account balance (not including refunds or disputes). nullable: true x-expansionResources: oneOf: - $ref: '#/components/schemas/balance_transaction' billing_details: $ref: '#/components/schemas/billing_details' calculated_statement_descriptor: description: >- 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. maxLength: 5000 nullable: true type: string captured: description: >- If the charge was created without capturing, this Boolean represents whether it is still uncaptured or has since been captured. type: boolean created: description: >- Time at which the object was created. Measured in seconds since the Unix epoch. format: unix-time type: integer currency: description: >- 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). type: string customer: anyOf: - maxLength: 5000 type: string - $ref: '#/components/schemas/customer' - $ref: '#/components/schemas/deleted_customer' description: ID of the customer this charge is for if one exists. nullable: true x-expansionResources: oneOf: - $ref: '#/components/schemas/customer' - $ref: '#/components/schemas/deleted_customer' description: description: >- An arbitrary string attached to the object. Often useful for displaying to users. maxLength: 40000 nullable: true type: string disputed: description: Whether the charge has been disputed. type: boolean failure_balance_transaction: anyOf: - maxLength: 5000 type: string - $ref: '#/components/schemas/balance_transaction' description: >- ID of the balance transaction that describes the reversal of the balance on your account due to payment failure. nullable: true x-expansionResources: oneOf: - $ref: '#/components/schemas/balance_transaction' failure_code: description: >- Error code explaining reason for charge failure if available (see [the errors section](https://stripe.com/docs/error-codes) for a list of codes). maxLength: 5000 nullable: true type: string failure_message: description: >- Message to user further explaining reason for charge failure if available. maxLength: 5000 nullable: true type: string fraud_details: anyOf: - $ref: '#/components/schemas/charge_fraud_details' description: Information on fraud assessments for the charge. nullable: true id: description: Unique identifier for the object. maxLength: 5000 type: string invoice: anyOf: - maxLength: 5000 type: string - $ref: '#/components/schemas/invoice' description: ID of the invoice this charge is for if one exists. nullable: true x-expansionResources: oneOf: - $ref: '#/components/schemas/invoice' livemode: description: >- Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. type: boolean metadata: additionalProperties: maxLength: 500 type: string description: >- 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. type: object object: description: >- String representing the object's type. Objects of the same type share the same value. enum: - charge type: string on_behalf_of: anyOf: - maxLength: 5000 type: string - $ref: '#/components/schemas/account' description: >- 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. nullable: true x-expansionResources: oneOf: - $ref: '#/components/schemas/account' outcome: anyOf: - $ref: '#/components/schemas/charge_outcome' description: >- Details about whether the payment was accepted, and why. See [understanding declines](https://stripe.com/docs/declines) for details. nullable: true paid: description: >- `true` if the charge succeeded, or was successfully authorized for later capture. type: boolean payment_intent: anyOf: - maxLength: 5000 type: string - $ref: '#/components/schemas/payment_intent' description: 'ID of the PaymentIntent associated with this charge, if one exists.' nullable: true x-expansionResources: oneOf: - $ref: '#/components/schemas/payment_intent' payment_method: description: ID of the payment method used in this charge. maxLength: 5000 nullable: true type: string payment_method_details: anyOf: - $ref: '#/components/schemas/payment_method_details' description: Details about the payment method at the time of the transaction. nullable: true radar_options: $ref: '#/components/schemas/radar_radar_options' receipt_email: description: >- This is the email address that the receipt for this charge was sent to. maxLength: 5000 nullable: true type: string receipt_number: description: >- 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. maxLength: 5000 nullable: true type: string receipt_url: description: >- 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. maxLength: 5000 nullable: true type: string refunded: description: >- Whether the charge has been fully refunded. If the charge is only partially refunded, this attribute will still be false. type: boolean refunds: description: A list of refunds that have been applied to the charge. nullable: true properties: data: description: Details about each object. items: $ref: '#/components/schemas/refund' type: array has_more: description: >- True if this list has another page of items after this one that can be fetched. type: boolean object: description: >- String representing the object's type. Objects of the same type share the same value. Always has the value `list`. enum: - list type: string url: description: The URL where this list can be accessed. maxLength: 5000 type: string required: - data - has_more - object - url title: RefundList type: object x-expandableFields: - data review: anyOf: - maxLength: 5000 type: string - $ref: '#/components/schemas/review' description: ID of the review associated with this charge if one exists. nullable: true x-expansionResources: oneOf: - $ref: '#/components/schemas/review' shipping: anyOf: - $ref: '#/components/schemas/shipping' description: Shipping information for the charge. nullable: true source_transfer: anyOf: - maxLength: 5000 type: string - $ref: '#/components/schemas/transfer' description: >- The transfer ID which created this charge. Only present if the charge came from another Stripe account. [See the Connect documentation](https://stripe.com/docs/connect/destination-charges) for details. nullable: true x-expansionResources: oneOf: - $ref: '#/components/schemas/transfer' statement_descriptor: description: >- For card charges, use `statement_descriptor_suffix` instead. Otherwise, you can use this value as the complete description of a charge on your customers’ statements. Must contain at least one letter, maximum 22 characters. maxLength: 5000 nullable: true type: string statement_descriptor_suffix: description: >- Provides information about the charge that customers see on their statements. Concatenated with the prefix (shortened descriptor) or statement descriptor that’s set on the account to form the complete statement descriptor. Maximum 22 characters for the concatenated descriptor. maxLength: 5000 nullable: true type: string status: description: >- The status of the payment is either `succeeded`, `pending`, or `failed`. enum: - failed - pending - succeeded type: string transfer: anyOf: - maxLength: 5000 type: string - $ref: '#/components/schemas/transfer' description: >- ID of the transfer to the `destination` account (only applicable if the charge was created using the `destination` parameter). x-expansionResources: oneOf: - $ref: '#/components/schemas/transfer' transfer_data: anyOf: - $ref: '#/components/schemas/charge_transfer_data' description: >- An optional dictionary including the account to automatically transfer to as part of a destination charge. [See the Connect documentation](https://stripe.com/docs/connect/destination-charges) for details. nullable: true transfer_group: description: >- 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. maxLength: 5000 nullable: true type: string required: - amount - amount_captured - amount_refunded - billing_details - captured - created - currency - disputed - id - livemode - metadata - object - paid - refunded - status title: Charge type: object x-expandableFields: - application - application_fee - balance_transaction - billing_details - customer - failure_balance_transaction - fraud_details - invoice - on_behalf_of - outcome - payment_intent - payment_method_details - radar_options - refunds - review - shipping - source_transfer - transfer - transfer_data x-resourceId: charge charge_fraud_details: description: '' properties: stripe_report: description: 'Assessments from Stripe. If set, the value is `fraudulent`.' maxLength: 5000 type: string user_report: description: >- Assessments reported by you. If set, possible values of are `safe` and `fraudulent`. maxLength: 5000 type: string title: ChargeFraudDetails type: object x-expandableFields: [] charge_outcome: description: '' properties: network_status: description: >- Possible values are `approved_by_network`, `declined_by_network`, `not_sent_to_network`, and `reversed_after_approval`. The value `reversed_after_approval` indicates the payment was [blocked by Stripe](https://stripe.com/docs/declines#blocked-payments) after bank authorization, and may temporarily appear as "pending" on a cardholder's statement. maxLength: 5000 nullable: true type: string reason: description: >- An enumerated value providing a more detailed explanation of the outcome's `type`. Charges blocked by Radar's default block rule have the value `highest_risk_level`. Charges placed in review by Radar's default review rule have the value `elevated_risk_level`. Charges authorized, blocked, or placed in review by custom rules have the value `rule`. See [understanding declines](https://stripe.com/docs/declines) for more details. maxLength: 5000 nullable: true type: string risk_level: description: >- Stripe Radar's evaluation of the riskiness of the payment. Possible values for evaluated payments are `normal`, `elevated`, `highest`. For non-card payments, and card-based payments predating the public assignment of risk levels, this field will have the value `not_assessed`. In the event of an error in the evaluation, this field will have the value `unknown`. This field is only available with Radar. maxLength: 5000 type: string risk_score: description: >- Stripe Radar's evaluation of the riskiness of the payment. Possible values for evaluated payments are between 0 and 100. For non-card payments, card-based payments predating the public assignment of risk scores, or in the event of an error during evaluation, this field will not be present. This field is only available with Radar for Fraud Teams. type: integer rule: anyOf: - maxLength: 5000 type: string - $ref: '#/components/schemas/rule' description: 'The ID of the Radar rule that matched the payment, if applicable.' x-expansionResources: oneOf: - $ref: '#/components/schemas/rule' seller_message: description: >- A human-readable description of the outcome type and reason, designed for you (the recipient of the payment), not your customer. maxLength: 5000 nullable: true type: string type: description: >- Possible values are `authorized`, `manual_review`, `issuer_declined`, `blocked`, and `invalid`. See [understanding declines](https://stripe.com/docs/declines) and [Radar reviews](https://stripe.com/docs/radar/reviews) for details. maxLength: 5000 type: string required: - type title: ChargeOutcome type: object x-expandableFields: - rule charge_transfer_data: description: '' properties: amount: description: >- The amount transferred to the destination account, if specified. By default, the entire charge amount is transferred to the destination account. nullable: true type: integer destination: anyOf: - maxLength: 5000 type: string - $ref: '#/components/schemas/account' description: >- ID of an existing, connected Stripe account to transfer funds to if `transfer_data` was specified in the charge request. x-expansionResources: oneOf: - $ref: '#/components/schemas/account' required: - destination title: ChargeTransferData type: object x-expandableFields: - destination checkout.session: description: >- A Checkout Session represents your customer's session as they pay for one-time purchases or subscriptions through [Checkout](https://stripe.com/docs/payments/checkout) or [Payment Links](https://stripe.com/docs/payments/payment-links). We recommend creating a new Session each time your customer attempts to pay. Once payment is successful, the Checkout Session will contain a reference to the [Customer](https://stripe.com/docs/api/customers), and either the successful [PaymentIntent](https://stripe.com/docs/api/payment_intents) or an active [Subscription](https://stripe.com/docs/api/subscriptions). You can create a Checkout Session on your server and redirect to its URL to begin Checkout. Related guide: [Checkout quickstart](https://stripe.com/docs/checkout/quickstart) properties: after_expiration: anyOf: - $ref: >- #/components/schemas/payment_pages_checkout_session_after_expiration description: >- When set, provides configuration for actions to take if this Checkout Session expires. nullable: true allow_promotion_codes: description: Enables user redeemable promotion codes. nullable: true type: boolean amount_subtotal: description: Total of all items before discounts or taxes are applied. nullable: true type: integer amount_total: description: Total of all items after discounts and taxes are applied. nullable: true type: integer automatic_tax: $ref: '#/components/schemas/payment_pages_checkout_session_automatic_tax' billing_address_collection: description: >- Describes whether Checkout should collect the customer's billing address. Defaults to `auto`. enum: - auto - required nullable: true type: string cancel_url: description: >- If set, Checkout displays a back button and customers will be directed to this URL if they decide to cancel payment and return to your website. maxLength: 5000 nullable: true type: string client_reference_id: description: |- A unique string to reference the Checkout Session. This can be a customer ID, a cart ID, or similar, and can be used to reconcile the Session with your internal systems. maxLength: 5000 nullable: true type: string client_secret: description: >- Client secret to be used when initializing Stripe.js embedded checkout. maxLength: 5000 nullable: true type: string consent: anyOf: - $ref: '#/components/schemas/payment_pages_checkout_session_consent' description: Results of `consent_collection` for this session. nullable: true consent_collection: anyOf: - $ref: >- #/components/schemas/payment_pages_checkout_session_consent_collection description: >- When set, provides configuration for the Checkout Session to gather active consent from customers. nullable: true created: description: >- Time at which the object was created. Measured in seconds since the Unix epoch. format: unix-time type: integer currency: description: >- 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). nullable: true type: string currency_conversion: anyOf: - $ref: >- #/components/schemas/payment_pages_checkout_session_currency_conversion description: >- Currency conversion details for automatic currency conversion sessions nullable: true custom_fields: description: >- Collect additional information from your customer using custom fields. Up to 3 fields are supported. items: $ref: '#/components/schemas/payment_pages_checkout_session_custom_fields' type: array custom_text: $ref: '#/components/schemas/payment_pages_checkout_session_custom_text' customer: anyOf: - maxLength: 5000 type: string - $ref: '#/components/schemas/customer' - $ref: '#/components/schemas/deleted_customer' description: >- The ID of the customer for this Session. For Checkout Sessions in `subscription` mode or Checkout Sessions with `customer_creation` set as `always` in `payment` mode, Checkout will create a new customer object based on information provided during the payment flow unless an existing customer was provided when the Session was created. nullable: true x-expansionResources: oneOf: - $ref: '#/components/schemas/customer' - $ref: '#/components/schemas/deleted_customer' customer_creation: description: >- Configure whether a Checkout Session creates a Customer when the Checkout Session completes. enum: - always - if_required nullable: true type: string customer_details: anyOf: - $ref: >- #/components/schemas/payment_pages_checkout_session_customer_details description: >- The customer details including the customer's tax exempt status and the customer's tax IDs. Customer's address details are not present on Sessions in `setup` mode. nullable: true customer_email: description: >- If provided, this value will be used when the Customer object is created. If not provided, customers will be asked to enter their email address. Use this parameter to prefill customer data if you already have an email on file. To access information about the customer once the payment flow is complete, use the `customer` attribute. maxLength: 5000 nullable: true type: string expires_at: description: The timestamp at which the Checkout Session will expire. format: unix-time type: integer id: description: Unique identifier for the object. maxLength: 5000 type: string invoice: anyOf: - maxLength: 5000 type: string - $ref: '#/components/schemas/invoice' description: 'ID of the invoice created by the Checkout Session, if it exists.' nullable: true x-expansionResources: oneOf: - $ref: '#/components/schemas/invoice' invoice_creation: anyOf: - $ref: >- #/components/schemas/payment_pages_checkout_session_invoice_creation description: Details on the state of invoice creation for the Checkout Session. nullable: true line_items: description: The line items purchased by the customer. properties: data: description: Details about each object. items: $ref: '#/components/schemas/item' type: array has_more: description: >- True if this list has another page of items after this one that can be fetched. type: boolean object: description: >- String representing the object's type. Objects of the same type share the same value. Always has the value `list`. enum: - list type: string url: description: The URL where this list can be accessed. maxLength: 5000 type: string required: - data - has_more - object - url title: PaymentPagesCheckoutSessionListLineItems type: object x-expandableFields: - data livemode: description: >- Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. type: boolean locale: description: >- The IETF language tag of the locale Checkout is displayed in. If blank or `auto`, the browser's locale is used. enum: - auto - bg - cs - da - de - el - en - en-GB - es - es-419 - et - fi - fil - fr - fr-CA - hr - hu - id - it - ja - ko - lt - lv - ms - mt - nb - nl - pl - pt - pt-BR - ro - ru - sk - sl - sv - th - tr - vi - zh - zh-HK - zh-TW nullable: true type: string x-stripeBypassValidation: true metadata: additionalProperties: maxLength: 500 type: string description: >- 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. nullable: true type: object mode: description: The mode of the Checkout Session. enum: - payment - setup - subscription type: string object: description: >- String representing the object's type. Objects of the same type share the same value. enum: - checkout.session type: string payment_intent: anyOf: - maxLength: 5000 type: string - $ref: '#/components/schemas/payment_intent' description: The ID of the PaymentIntent for Checkout Sessions in `payment` mode. nullable: true x-expansionResources: oneOf: - $ref: '#/components/schemas/payment_intent' payment_link: anyOf: - maxLength: 5000 type: string - $ref: '#/components/schemas/payment_link' description: The ID of the Payment Link that created this Session. nullable: true x-expansionResources: oneOf: - $ref: '#/components/schemas/payment_link' payment_method_collection: description: >- Configure whether a Checkout Session should collect a payment method. Defaults to `always`. enum: - always - if_required nullable: true type: string payment_method_configuration_details: anyOf: - $ref: >- #/components/schemas/payment_method_config_biz_payment_method_configuration_details description: >- Information about the payment method configuration used for this Checkout session if using dynamic payment methods. nullable: true payment_method_options: anyOf: - $ref: '#/components/schemas/checkout_session_payment_method_options' description: >- Payment-method-specific configuration for the PaymentIntent or SetupIntent of this CheckoutSession. nullable: true payment_method_types: description: |- A list of the types of payment methods (e.g. card) this Checkout Session is allowed to accept. items: maxLength: 5000 type: string type: array payment_status: description: >- The payment status of the Checkout Session, one of `paid`, `unpaid`, or `no_payment_required`. You can use this value to decide when to fulfill your customer's order. enum: - no_payment_required - paid - unpaid type: string phone_number_collection: $ref: >- #/components/schemas/payment_pages_checkout_session_phone_number_collection recovered_from: description: >- The ID of the original expired Checkout Session that triggered the recovery flow. maxLength: 5000 nullable: true type: string redirect_on_completion: description: >- This parameter applies to `ui_mode: embedded`. Learn more about the [redirect behavior](https://stripe.com/docs/payments/checkout/custom-redirect-behavior) of embedded sessions. Defaults to `always`. enum: - always - if_required - never type: string return_url: description: >- Applies to Checkout Sessions with `ui_mode: embedded`. The URL to redirect your customer back to after they authenticate or cancel their payment on the payment method's app or site. maxLength: 5000 type: string saved_payment_method_options: anyOf: - $ref: >- #/components/schemas/payment_pages_checkout_session_saved_payment_method_options description: >- Controls saved payment method settings for the session. Only available in `payment` and `subscription` mode. nullable: true setup_intent: anyOf: - maxLength: 5000 type: string - $ref: '#/components/schemas/setup_intent' description: The ID of the SetupIntent for Checkout Sessions in `setup` mode. nullable: true x-expansionResources: oneOf: - $ref: '#/components/schemas/setup_intent' shipping_address_collection: anyOf: - $ref: >- #/components/schemas/payment_pages_checkout_session_shipping_address_collection description: >- When set, provides configuration for Checkout to collect a shipping address from a customer. nullable: true shipping_cost: anyOf: - $ref: >- #/components/schemas/payment_pages_checkout_session_shipping_cost description: >- The details of the customer cost of shipping, including the customer chosen ShippingRate. nullable: true shipping_details: anyOf: - $ref: '#/components/schemas/shipping' description: Shipping information for this Checkout Session. nullable: true shipping_options: description: The shipping rate options applied to this Session. items: $ref: >- #/components/schemas/payment_pages_checkout_session_shipping_option type: array status: description: >- The status of the Checkout Session, one of `open`, `complete`, or `expired`. enum: - complete - expired - open nullable: true type: string submit_type: description: >- Describes the type of transaction being performed by Checkout in order to customize relevant text on the page, such as the submit button. `submit_type` can only be specified on Checkout Sessions in `payment` mode. If blank or `auto`, `pay` is used. enum: - auto - book - donate - pay nullable: true type: string subscription: anyOf: - maxLength: 5000 type: string - $ref: '#/components/schemas/subscription' description: >- The ID of the subscription for Checkout Sessions in `subscription` mode. nullable: true x-expansionResources: oneOf: - $ref: '#/components/schemas/subscription' success_url: description: |- The URL the customer will be directed to after the payment or subscription creation is successful. maxLength: 5000 nullable: true type: string tax_id_collection: $ref: >- #/components/schemas/payment_pages_checkout_session_tax_id_collection total_details: anyOf: - $ref: >- #/components/schemas/payment_pages_checkout_session_total_details description: Tax and discount details for the computed total amount. nullable: true ui_mode: description: The UI mode of the Session. Defaults to `hosted`. enum: - embedded - hosted nullable: true type: string x-stripeBypassValidation: true url: description: >- The URL to the Checkout Session. Redirect customers to this URL to take them to Checkout. If you’re using [Custom Domains](https://stripe.com/docs/payments/checkout/custom-domains), the URL will use your subdomain. Otherwise, it’ll use `checkout.stripe.com.` This value is only present when the session is active. maxLength: 5000 nullable: true type: string required: - automatic_tax - created - custom_fields - custom_text - expires_at - id - livemode - mode - object - payment_method_types - payment_status - shipping_options title: Session type: object x-expandableFields: - after_expiration - automatic_tax - consent - consent_collection - currency_conversion - custom_fields - custom_text - customer - customer_details - invoice - invoice_creation - line_items - payment_intent - payment_link - payment_method_configuration_details - payment_method_options - phone_number_collection - saved_payment_method_options - setup_intent - shipping_address_collection - shipping_cost - shipping_details - shipping_options - subscription - tax_id_collection - total_details x-resourceId: checkout.session checkout_acss_debit_mandate_options: description: '' properties: custom_mandate_url: description: A URL for custom mandate text maxLength: 5000 type: string default_for: description: >- List of Stripe products where this mandate can be selected automatically. Returned when the Session is in `setup` mode. items: enum: - invoice - subscription type: string type: array interval_description: description: >- Description of the interval. Only required if the 'payment_schedule' parameter is 'interval' or 'combined'. maxLength: 5000 nullable: true type: string payment_schedule: description: Payment schedule for the mandate. enum: - combined - interval - sporadic nullable: true type: string transaction_type: description: Transaction type of the mandate. enum: - business - personal nullable: true type: string title: CheckoutAcssDebitMandateOptions type: object x-expandableFields: [] checkout_acss_debit_payment_method_options: description: '' properties: currency: description: >- Currency supported by the bank account. Returned when the Session is in `setup` mode. enum: - cad - usd type: string mandate_options: $ref: '#/components/schemas/checkout_acss_debit_mandate_options' setup_future_usage: description: >- Indicates that you intend to make future payments with this PaymentIntent's payment method. Providing this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes. When processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication). enum: - none - off_session - on_session type: string verification_method: description: Bank account verification method. enum: - automatic - instant - microdeposits type: string x-stripeBypassValidation: true title: CheckoutAcssDebitPaymentMethodOptions type: object x-expandableFields: - mandate_options checkout_affirm_payment_method_options: description: '' properties: setup_future_usage: description: >- Indicates that you intend to make future payments with this PaymentIntent's payment method. Providing this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes. When processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication). enum: - none type: string title: CheckoutAffirmPaymentMethodOptions type: object x-expandableFields: [] checkout_afterpay_clearpay_payment_method_options: description: '' properties: setup_future_usage: description: >- Indicates that you intend to make future payments with this PaymentIntent's payment method. Providing this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes. When processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication). enum: - none type: string title: CheckoutAfterpayClearpayPaymentMethodOptions type: object x-expandableFields: [] checkout_alipay_payment_method_options: description: '' properties: setup_future_usage: description: >- Indicates that you intend to make future payments with this PaymentIntent's payment method. Providing this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes. When processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication). enum: - none type: string title: CheckoutAlipayPaymentMethodOptions type: object x-expandableFields: [] checkout_amazon_pay_payment_method_options: description: '' properties: {} title: CheckoutAmazonPayPaymentMethodOptions type: object x-expandableFields: [] checkout_au_becs_debit_payment_method_options: description: '' properties: setup_future_usage: description: >- Indicates that you intend to make future payments with this PaymentIntent's payment method. Providing this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes. When processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication). enum: - none type: string title: CheckoutAuBecsDebitPaymentMethodOptions type: object x-expandableFields: [] checkout_bacs_debit_payment_method_options: description: '' properties: setup_future_usage: description: >- Indicates that you intend to make future payments with this PaymentIntent's payment method. Providing this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes. When processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication). enum: - none - off_session - on_session type: string title: CheckoutBacsDebitPaymentMethodOptions type: object x-expandableFields: [] checkout_bancontact_payment_method_options: description: '' properties: setup_future_usage: description: >- Indicates that you intend to make future payments with this PaymentIntent's payment method. Providing this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes. When processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication). enum: - none type: string title: CheckoutBancontactPaymentMethodOptions type: object x-expandableFields: [] checkout_boleto_payment_method_options: description: '' properties: expires_after_days: description: >- The number of calendar days before a Boleto voucher expires. For example, if you create a Boleto voucher on Monday and you set expires_after_days to 2, the Boleto voucher will expire on Wednesday at 23:59 America/Sao_Paulo time. type: integer setup_future_usage: description: >- Indicates that you intend to make future payments with this PaymentIntent's payment method. Providing this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes. When processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication). enum: - none - off_session - on_session type: string required: - expires_after_days title: CheckoutBoletoPaymentMethodOptions type: object x-expandableFields: [] checkout_card_installments_options: description: '' properties: enabled: description: Indicates if installments are enabled type: boolean title: CheckoutCardInstallmentsOptions type: object x-expandableFields: [] checkout_card_payment_method_options: description: '' properties: installments: $ref: '#/components/schemas/checkout_card_installments_options' request_three_d_secure: description: >- We strongly recommend that you rely on our SCA Engine to automatically prompt your customers for authentication based on risk level and [other requirements](https://stripe.com/docs/strong-customer-authentication). However, if you wish to request 3D Secure based on logic from your own fraud engine, provide this option. If not provided, this value defaults to `automatic`. Read our guide on [manually requesting 3D Secure](https://stripe.com/docs/payments/3d-secure/authentication-flow#manual-three-ds) for more information on how this configuration interacts with Radar and our SCA Engine. enum: - any - automatic - challenge type: string x-stripeBypassValidation: true setup_future_usage: description: >- Indicates that you intend to make future payments with this PaymentIntent's payment method. Providing this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes. When processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication). enum: - none - off_session - on_session type: string statement_descriptor_suffix_kana: description: >- Provides information about a card payment that customers see on their statements. Concatenated with the Kana prefix (shortened Kana descriptor) or Kana statement descriptor that’s set on the account to form the complete statement descriptor. Maximum 22 characters. On card statements, the *concatenation* of both prefix and suffix (including separators) will appear truncated to 22 characters. maxLength: 5000 type: string statement_descriptor_suffix_kanji: description: >- Provides information about a card payment that customers see on their statements. Concatenated with the Kanji prefix (shortened Kanji descriptor) or Kanji statement descriptor that’s set on the account to form the complete statement descriptor. Maximum 17 characters. On card statements, the *concatenation* of both prefix and suffix (including separators) will appear truncated to 17 characters. maxLength: 5000 type: string required: - request_three_d_secure title: CheckoutCardPaymentMethodOptions type: object x-expandableFields: - installments checkout_cashapp_payment_method_options: description: '' properties: setup_future_usage: description: >- Indicates that you intend to make future payments with this PaymentIntent's payment method. Providing this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes. When processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication). enum: - none type: string title: CheckoutCashappPaymentMethodOptions type: object x-expandableFields: [] checkout_customer_balance_bank_transfer_payment_method_options: description: '' properties: eu_bank_transfer: $ref: >- #/components/schemas/payment_method_options_customer_balance_eu_bank_account requested_address_types: description: >- List of address types that should be returned in the financial_addresses response. If not specified, all valid types will be returned. Permitted values include: `sort_code`, `zengin`, `iban`, or `spei`. items: enum: - aba - iban - sepa - sort_code - spei - swift - zengin type: string x-stripeBypassValidation: true type: array type: description: >- The bank transfer type that this PaymentIntent is allowed to use for funding Permitted values include: `eu_bank_transfer`, `gb_bank_transfer`, `jp_bank_transfer`, `mx_bank_transfer`, or `us_bank_transfer`. enum: - eu_bank_transfer - gb_bank_transfer - jp_bank_transfer - mx_bank_transfer - us_bank_transfer nullable: true type: string x-stripeBypassValidation: true title: CheckoutCustomerBalanceBankTransferPaymentMethodOptions type: object x-expandableFields: - eu_bank_transfer checkout_customer_balance_payment_method_options: description: '' properties: bank_transfer: $ref: >- #/components/schemas/checkout_customer_balance_bank_transfer_payment_method_options funding_type: description: >- The funding method type to be used when there are not enough funds in the customer balance. Permitted values include: `bank_transfer`. enum: - bank_transfer nullable: true type: string setup_future_usage: description: >- Indicates that you intend to make future payments with this PaymentIntent's payment method. Providing this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes. When processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication). enum: - none type: string title: CheckoutCustomerBalancePaymentMethodOptions type: object x-expandableFields: - bank_transfer checkout_eps_payment_method_options: description: '' properties: setup_future_usage: description: >- Indicates that you intend to make future payments with this PaymentIntent's payment method. Providing this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes. When processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication). enum: - none type: string title: CheckoutEpsPaymentMethodOptions type: object x-expandableFields: [] checkout_fpx_payment_method_options: description: '' properties: setup_future_usage: description: >- Indicates that you intend to make future payments with this PaymentIntent's payment method. Providing this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes. When processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication). enum: - none type: string title: CheckoutFpxPaymentMethodOptions type: object x-expandableFields: [] checkout_giropay_payment_method_options: description: '' properties: setup_future_usage: description: >- Indicates that you intend to make future payments with this PaymentIntent's payment method. Providing this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes. When processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication). enum: - none type: string title: CheckoutGiropayPaymentMethodOptions type: object x-expandableFields: [] checkout_grab_pay_payment_method_options: description: '' properties: setup_future_usage: description: >- Indicates that you intend to make future payments with this PaymentIntent's payment method. Providing this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes. When processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication). enum: - none type: string title: CheckoutGrabPayPaymentMethodOptions type: object x-expandableFields: [] checkout_ideal_payment_method_options: description: '' properties: setup_future_usage: description: >- Indicates that you intend to make future payments with this PaymentIntent's payment method. Providing this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes. When processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication). enum: - none type: string title: CheckoutIdealPaymentMethodOptions type: object x-expandableFields: [] checkout_klarna_payment_method_options: description: '' properties: setup_future_usage: description: >- Indicates that you intend to make future payments with this PaymentIntent's payment method. Providing this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes. When processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication). enum: - none - off_session - on_session type: string title: CheckoutKlarnaPaymentMethodOptions type: object x-expandableFields: [] checkout_konbini_payment_method_options: description: '' properties: expires_after_days: description: >- The number of calendar days (between 1 and 60) after which Konbini payment instructions will expire. For example, if a PaymentIntent is confirmed with Konbini and `expires_after_days` set to 2 on Monday JST, the instructions will expire on Wednesday 23:59:59 JST. nullable: true type: integer setup_future_usage: description: >- Indicates that you intend to make future payments with this PaymentIntent's payment method. Providing this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes. When processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication). enum: - none type: string title: CheckoutKonbiniPaymentMethodOptions type: object x-expandableFields: [] checkout_link_payment_method_options: description: '' properties: setup_future_usage: description: >- Indicates that you intend to make future payments with this PaymentIntent's payment method. Providing this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes. When processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication). enum: - none - off_session type: string title: CheckoutLinkPaymentMethodOptions type: object x-expandableFields: [] checkout_mobilepay_payment_method_options: description: '' properties: setup_future_usage: description: >- Indicates that you intend to make future payments with this PaymentIntent's payment method. Providing this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes. When processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication). enum: - none type: string title: CheckoutMobilepayPaymentMethodOptions type: object x-expandableFields: [] checkout_oxxo_payment_method_options: description: '' properties: expires_after_days: description: >- The number of calendar days before an OXXO invoice expires. For example, if you create an OXXO invoice on Monday and you set expires_after_days to 2, the OXXO invoice will expire on Wednesday at 23:59 America/Mexico_City time. type: integer setup_future_usage: description: >- Indicates that you intend to make future payments with this PaymentIntent's payment method. Providing this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes. When processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication). enum: - none type: string required: - expires_after_days title: CheckoutOxxoPaymentMethodOptions type: object x-expandableFields: [] checkout_p24_payment_method_options: description: '' properties: setup_future_usage: description: >- Indicates that you intend to make future payments with this PaymentIntent's payment method. Providing this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes. When processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication). enum: - none type: string title: CheckoutP24PaymentMethodOptions type: object x-expandableFields: [] checkout_paynow_payment_method_options: description: '' properties: setup_future_usage: description: >- Indicates that you intend to make future payments with this PaymentIntent's payment method. Providing this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes. When processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication). enum: - none type: string title: CheckoutPaynowPaymentMethodOptions type: object x-expandableFields: [] checkout_paypal_payment_method_options: description: '' properties: capture_method: description: >- Controls when the funds will be captured from the customer's account. enum: - manual type: string preferred_locale: description: >- Preferred locale of the PayPal checkout page that the customer is redirected to. maxLength: 5000 nullable: true type: string reference: description: >- A reference of the PayPal transaction visible to customer which is mapped to PayPal's invoice ID. This must be a globally unique ID if you have configured in your PayPal settings to block multiple payments per invoice ID. maxLength: 5000 nullable: true type: string setup_future_usage: description: >- Indicates that you intend to make future payments with this PaymentIntent's payment method. Providing this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes. When processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication). enum: - none - off_session type: string title: CheckoutPaypalPaymentMethodOptions type: object x-expandableFields: [] checkout_pix_payment_method_options: description: '' properties: expires_after_seconds: description: The number of seconds after which Pix payment will expire. nullable: true type: integer title: CheckoutPixPaymentMethodOptions type: object x-expandableFields: [] checkout_revolut_pay_payment_method_options: description: '' properties: {} title: CheckoutRevolutPayPaymentMethodOptions type: object x-expandableFields: [] checkout_sepa_debit_payment_method_options: description: '' properties: setup_future_usage: description: >- Indicates that you intend to make future payments with this PaymentIntent's payment method. Providing this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes. When processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication). enum: - none - off_session - on_session type: string title: CheckoutSepaDebitPaymentMethodOptions type: object x-expandableFields: [] checkout_session_payment_method_options: description: '' properties: acss_debit: $ref: '#/components/schemas/checkout_acss_debit_payment_method_options' affirm: $ref: '#/components/schemas/checkout_affirm_payment_method_options' afterpay_clearpay: $ref: >- #/components/schemas/checkout_afterpay_clearpay_payment_method_options alipay: $ref: '#/components/schemas/checkout_alipay_payment_method_options' amazon_pay: $ref: '#/components/schemas/checkout_amazon_pay_payment_method_options' au_becs_debit: $ref: '#/components/schemas/checkout_au_becs_debit_payment_method_options' bacs_debit: $ref: '#/components/schemas/checkout_bacs_debit_payment_method_options' bancontact: $ref: '#/components/schemas/checkout_bancontact_payment_method_options' boleto: $ref: '#/components/schemas/checkout_boleto_payment_method_options' card: $ref: '#/components/schemas/checkout_card_payment_method_options' cashapp: $ref: '#/components/schemas/checkout_cashapp_payment_method_options' customer_balance: $ref: >- #/components/schemas/checkout_customer_balance_payment_method_options eps: $ref: '#/components/schemas/checkout_eps_payment_method_options' fpx: $ref: '#/components/schemas/checkout_fpx_payment_method_options' giropay: $ref: '#/components/schemas/checkout_giropay_payment_method_options' grabpay: $ref: '#/components/schemas/checkout_grab_pay_payment_method_options' ideal: $ref: '#/components/schemas/checkout_ideal_payment_method_options' klarna: $ref: '#/components/schemas/checkout_klarna_payment_method_options' konbini: $ref: '#/components/schemas/checkout_konbini_payment_method_options' link: $ref: '#/components/schemas/checkout_link_payment_method_options' mobilepay: $ref: '#/components/schemas/checkout_mobilepay_payment_method_options' oxxo: $ref: '#/components/schemas/checkout_oxxo_payment_method_options' p24: $ref: '#/components/schemas/checkout_p24_payment_method_options' paynow: $ref: '#/components/schemas/checkout_paynow_payment_method_options' paypal: $ref: '#/components/schemas/checkout_paypal_payment_method_options' pix: $ref: '#/components/schemas/checkout_pix_payment_method_options' revolut_pay: $ref: '#/components/schemas/checkout_revolut_pay_payment_method_options' sepa_debit: $ref: '#/components/schemas/checkout_sepa_debit_payment_method_options' sofort: $ref: '#/components/schemas/checkout_sofort_payment_method_options' swish: $ref: '#/components/schemas/checkout_swish_payment_method_options' us_bank_account: $ref: '#/components/schemas/checkout_us_bank_account_payment_method_options' title: CheckoutSessionPaymentMethodOptions type: object x-expandableFields: - acss_debit - affirm - afterpay_clearpay - alipay - amazon_pay - au_becs_debit - bacs_debit - bancontact - boleto - card - cashapp - customer_balance - eps - fpx - giropay - grabpay - ideal - klarna - konbini - link - mobilepay - oxxo - p24 - paynow - paypal - pix - revolut_pay - sepa_debit - sofort - swish - us_bank_account checkout_sofort_payment_method_options: description: '' properties: setup_future_usage: description: >- Indicates that you intend to make future payments with this PaymentIntent's payment method. Providing this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes. When processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication). enum: - none type: string title: CheckoutSofortPaymentMethodOptions type: object x-expandableFields: [] checkout_swish_payment_method_options: description: '' properties: reference: description: >- The order reference that will be displayed to customers in the Swish application. Defaults to the `id` of the Payment Intent. maxLength: 5000 nullable: true type: string title: CheckoutSwishPaymentMethodOptions type: object x-expandableFields: [] checkout_us_bank_account_payment_method_options: description: '' properties: financial_connections: $ref: '#/components/schemas/linked_account_options_us_bank_account' setup_future_usage: description: >- Indicates that you intend to make future payments with this PaymentIntent's payment method. Providing this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes. When processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication). enum: - none - off_session - on_session type: string verification_method: description: Bank account verification method. enum: - automatic - instant type: string x-stripeBypassValidation: true title: CheckoutUsBankAccountPaymentMethodOptions type: object x-expandableFields: - financial_connections climate.order: description: >- Orders represent your intent to purchase a particular Climate product. When you create an order, the payment is deducted from your merchant balance. properties: amount_fees: description: >- Total amount of [Frontier](https://frontierclimate.com/)'s service fees in the currency's smallest unit. type: integer amount_subtotal: description: Total amount of the carbon removal in the currency's smallest unit. type: integer amount_total: description: >- Total amount of the order including fees in the currency's smallest unit. type: integer beneficiary: $ref: '#/components/schemas/climate_removals_beneficiary' canceled_at: description: >- Time at which the order was canceled. Measured in seconds since the Unix epoch. format: unix-time nullable: true type: integer cancellation_reason: description: Reason for the cancellation of this order. enum: - expired - product_unavailable - requested nullable: true type: string x-stripeBypassValidation: true certificate: description: 'For delivered orders, a URL to a delivery certificate for the order.' maxLength: 5000 nullable: true type: string confirmed_at: description: >- Time at which the order was confirmed. Measured in seconds since the Unix epoch. format: unix-time nullable: true type: integer created: description: >- Time at which the object was created. Measured in seconds since the Unix epoch. format: unix-time type: integer currency: description: >- Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase, representing the currency for this order. maxLength: 5000 type: string delayed_at: description: >- Time at which the order's expected_delivery_year was delayed. Measured in seconds since the Unix epoch. format: unix-time nullable: true type: integer delivered_at: description: >- Time at which the order was delivered. Measured in seconds since the Unix epoch. format: unix-time nullable: true type: integer delivery_details: description: Details about the delivery of carbon removal for this order. items: $ref: '#/components/schemas/climate_removals_order_deliveries' type: array expected_delivery_year: description: The year this order is expected to be delivered. type: integer id: description: Unique identifier for the object. maxLength: 5000 type: string livemode: description: >- Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. type: boolean metadata: additionalProperties: maxLength: 500 type: string description: >- 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. type: object metric_tons: description: Quantity of carbon removal that is included in this order. format: decimal type: string object: description: >- String representing the object's type. Objects of the same type share the same value. enum: - climate.order type: string product: anyOf: - maxLength: 5000 type: string - $ref: '#/components/schemas/climate.product' description: Unique ID for the Climate `Product` this order is purchasing. x-expansionResources: oneOf: - $ref: '#/components/schemas/climate.product' product_substituted_at: description: >- Time at which the order's product was substituted for a different product. Measured in seconds since the Unix epoch. format: unix-time nullable: true type: integer status: description: The current status of this order. enum: - awaiting_funds - canceled - confirmed - delivered - open type: string required: - amount_fees - amount_subtotal - amount_total - created - currency - delivery_details - expected_delivery_year - id - livemode - metadata - metric_tons - object - product - status title: ClimateRemovalsOrders type: object x-expandableFields: - beneficiary - delivery_details - product x-resourceId: climate.order climate.product: description: >- A Climate product represents a type of carbon removal unit available for reservation. You can retrieve it to see the current price and availability. properties: created: description: >- Time at which the object was created. Measured in seconds since the Unix epoch. format: unix-time type: integer current_prices_per_metric_ton: additionalProperties: $ref: '#/components/schemas/climate_removals_products_price' description: >- Current prices for a metric ton of carbon removal in a currency's smallest unit. type: object delivery_year: description: The year in which the carbon removal is expected to be delivered. nullable: true type: integer id: description: >- Unique identifier for the object. For convenience, Climate product IDs are human-readable strings that start with `climsku_`. See [carbon removal inventory](https://stripe.com/docs/climate/orders/carbon-removal-inventory) for a list of available carbon removal products. maxLength: 5000 type: string livemode: description: >- Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. type: boolean metric_tons_available: description: The quantity of metric tons available for reservation. format: decimal type: string name: description: The Climate product's name. maxLength: 5000 type: string object: description: >- String representing the object's type. Objects of the same type share the same value. enum: - climate.product type: string suppliers: description: >- The carbon removal suppliers that fulfill orders for this Climate product. items: $ref: '#/components/schemas/climate.supplier' type: array required: - created - current_prices_per_metric_ton - id - livemode - metric_tons_available - name - object - suppliers title: ClimateRemovalsProducts type: object x-expandableFields: - current_prices_per_metric_ton - suppliers x-resourceId: climate.product climate.supplier: description: A supplier of carbon removal. properties: id: description: Unique identifier for the object. maxLength: 5000 type: string info_url: description: Link to a webpage to learn more about the supplier. maxLength: 5000 type: string livemode: description: >- Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. type: boolean locations: description: The locations in which this supplier operates. items: $ref: '#/components/schemas/climate_removals_location' type: array name: description: Name of this carbon removal supplier. maxLength: 5000 type: string object: description: >- String representing the object’s type. Objects of the same type share the same value. enum: - climate.supplier type: string removal_pathway: description: The scientific pathway used for carbon removal. enum: - biomass_carbon_removal_and_storage - direct_air_capture - enhanced_weathering type: string required: - id - info_url - livemode - locations - name - object - removal_pathway title: ClimateRemovalsSuppliers type: object x-expandableFields: - locations x-resourceId: climate.supplier climate_removals_beneficiary: description: '' properties: public_name: description: Publicly displayable name for the end beneficiary of carbon removal. maxLength: 5000 type: string required: - public_name title: ClimateRemovalsBeneficiary type: object x-expandableFields: [] climate_removals_location: description: '' properties: city: description: The city where the supplier is located. maxLength: 5000 nullable: true type: string country: description: >- Two-letter ISO code representing the country where the supplier is located. maxLength: 5000 type: string latitude: description: The geographic latitude where the supplier is located. nullable: true type: number longitude: description: The geographic longitude where the supplier is located. nullable: true type: number region: description: The state/county/province/region where the supplier is located. maxLength: 5000 nullable: true type: string required: - country title: ClimateRemovalsLocation type: object x-expandableFields: [] climate_removals_order_deliveries: description: The delivery of a specified quantity of carbon for an order. properties: delivered_at: description: >- Time at which the delivery occurred. Measured in seconds since the Unix epoch. format: unix-time type: integer location: anyOf: - $ref: '#/components/schemas/climate_removals_location' description: Specific location of this delivery. nullable: true metric_tons: description: Quantity of carbon removal supplied by this delivery. maxLength: 5000 type: string registry_url: description: >- Once retired, a URL to the registry entry for the tons from this delivery. maxLength: 5000 nullable: true type: string supplier: $ref: '#/components/schemas/climate.supplier' required: - delivered_at - metric_tons - supplier title: ClimateRemovalsOrderDeliveries type: object x-expandableFields: - location - supplier climate_removals_products_price: description: '' properties: amount_fees: description: >- Fees for one metric ton of carbon removal in the currency's smallest unit. type: integer amount_subtotal: description: >- Subtotal for one metric ton of carbon removal (excluding fees) in the currency's smallest unit. type: integer amount_total: description: >- Total for one metric ton of carbon removal (including fees) in the currency's smallest unit. type: integer required: - amount_fees - amount_subtotal - amount_total title: ClimateRemovalsProductsPrice type: object x-expandableFields: [] confirmation_token: description: >- ConfirmationTokens help transport client side data collected by Stripe JS over to your server for confirming a PaymentIntent or SetupIntent. If the confirmation is successful, values present on the ConfirmationToken are written onto the Intent. To learn more about how to use ConfirmationToken, visit the related guides: - [Finalize payments on the server](https://stripe.com/docs/payments/finalize-payments-on-the-server) - [Build two-step confirmation](https://stripe.com/docs/payments/build-a-two-step-confirmation). properties: created: description: >- Time at which the object was created. Measured in seconds since the Unix epoch. format: unix-time type: integer expires_at: description: >- Time at which this ConfirmationToken expires and can no longer be used to confirm a PaymentIntent or SetupIntent. This is set to null once this ConfirmationToken has been used. format: unix-time nullable: true type: integer id: description: Unique identifier for the object. maxLength: 5000 type: string livemode: description: >- Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. type: boolean mandate_data: anyOf: - $ref: '#/components/schemas/confirmation_tokens_resource_mandate_data' description: Data used for generating a Mandate. nullable: true object: description: >- String representing the object's type. Objects of the same type share the same value. enum: - confirmation_token type: string payment_intent: description: >- ID of the PaymentIntent that this ConfirmationToken was used to confirm, or null if this ConfirmationToken has not yet been used. maxLength: 5000 nullable: true type: string payment_method_preview: anyOf: - $ref: >- #/components/schemas/confirmation_tokens_resource_payment_method_preview description: >- Payment details collected by the Payment Element, used to create a PaymentMethod when a PaymentIntent or SetupIntent is confirmed with this ConfirmationToken. nullable: true return_url: description: Return URL used to confirm the Intent. maxLength: 5000 nullable: true type: string setup_future_usage: description: >- Indicates that you intend to make future payments with this ConfirmationToken's payment method. The presence of this property will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. enum: - off_session - on_session nullable: true type: string setup_intent: description: >- ID of the SetupIntent that this ConfirmationToken was used to confirm, or null if this ConfirmationToken has not yet been used. maxLength: 5000 nullable: true type: string shipping: anyOf: - $ref: '#/components/schemas/confirmation_tokens_resource_shipping' description: Shipping information collected on this ConfirmationToken. nullable: true use_stripe_sdk: description: >- Indicates whether the Stripe SDK is used to handle confirmation flow. Defaults to `true` on ConfirmationToken. type: boolean required: - created - id - livemode - object - use_stripe_sdk title: ConfirmationTokensResourceConfirmationToken type: object x-expandableFields: - mandate_data - payment_method_preview - shipping x-resourceId: confirmation_token confirmation_tokens_resource_mandate_data: description: Data used for generating a Mandate. properties: customer_acceptance: $ref: >- #/components/schemas/confirmation_tokens_resource_mandate_data_resource_customer_acceptance required: - customer_acceptance title: ConfirmationTokensResourceMandateData type: object x-expandableFields: - customer_acceptance confirmation_tokens_resource_mandate_data_resource_customer_acceptance: description: This hash contains details about the customer acceptance of the Mandate. properties: online: anyOf: - $ref: >- #/components/schemas/confirmation_tokens_resource_mandate_data_resource_customer_acceptance_resource_online description: >- If this is a Mandate accepted online, this hash contains details about the online acceptance. nullable: true type: description: >- The type of customer acceptance information included with the Mandate. maxLength: 5000 type: string required: - type title: ConfirmationTokensResourceMandateDataResourceCustomerAcceptance type: object x-expandableFields: - online confirmation_tokens_resource_mandate_data_resource_customer_acceptance_resource_online: description: This hash contains details about the online acceptance. properties: ip_address: description: The IP address from which the Mandate was accepted by the customer. maxLength: 5000 nullable: true type: string user_agent: description: >- The user agent of the browser from which the Mandate was accepted by the customer. maxLength: 5000 nullable: true type: string title: >- ConfirmationTokensResourceMandateDataResourceCustomerAcceptanceResourceOnline type: object x-expandableFields: [] confirmation_tokens_resource_payment_method_preview: description: Details of the PaymentMethod collected by Payment Element properties: acss_debit: $ref: '#/components/schemas/payment_method_acss_debit' affirm: $ref: '#/components/schemas/payment_method_affirm' afterpay_clearpay: $ref: '#/components/schemas/payment_method_afterpay_clearpay' alipay: $ref: '#/components/schemas/payment_flows_private_payment_methods_alipay' amazon_pay: $ref: '#/components/schemas/payment_method_amazon_pay' au_becs_debit: $ref: '#/components/schemas/payment_method_au_becs_debit' bacs_debit: $ref: '#/components/schemas/payment_method_bacs_debit' bancontact: $ref: '#/components/schemas/payment_method_bancontact' billing_details: $ref: '#/components/schemas/billing_details' blik: $ref: '#/components/schemas/payment_method_blik' boleto: $ref: '#/components/schemas/payment_method_boleto' card: $ref: '#/components/schemas/payment_method_card' card_present: $ref: '#/components/schemas/payment_method_card_present' cashapp: $ref: '#/components/schemas/payment_method_cashapp' customer_balance: $ref: '#/components/schemas/payment_method_customer_balance' eps: $ref: '#/components/schemas/payment_method_eps' fpx: $ref: '#/components/schemas/payment_method_fpx' giropay: $ref: '#/components/schemas/payment_method_giropay' grabpay: $ref: '#/components/schemas/payment_method_grabpay' ideal: $ref: '#/components/schemas/payment_method_ideal' interac_present: $ref: '#/components/schemas/payment_method_interac_present' klarna: $ref: '#/components/schemas/payment_method_klarna' konbini: $ref: '#/components/schemas/payment_method_konbini' link: $ref: '#/components/schemas/payment_method_link' mobilepay: $ref: '#/components/schemas/payment_method_mobilepay' oxxo: $ref: '#/components/schemas/payment_method_oxxo' p24: $ref: '#/components/schemas/payment_method_p24' paynow: $ref: '#/components/schemas/payment_method_paynow' paypal: $ref: '#/components/schemas/payment_method_paypal' pix: $ref: '#/components/schemas/payment_method_pix' promptpay: $ref: '#/components/schemas/payment_method_promptpay' revolut_pay: $ref: '#/components/schemas/payment_method_revolut_pay' sepa_debit: $ref: '#/components/schemas/payment_method_sepa_debit' sofort: $ref: '#/components/schemas/payment_method_sofort' swish: $ref: '#/components/schemas/payment_method_swish' type: description: >- 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. enum: - acss_debit - affirm - afterpay_clearpay - alipay - amazon_pay - au_becs_debit - bacs_debit - bancontact - blik - boleto - card - card_present - cashapp - customer_balance - eps - fpx - giropay - grabpay - ideal - interac_present - klarna - konbini - link - mobilepay - oxxo - p24 - paynow - paypal - pix - promptpay - revolut_pay - sepa_debit - sofort - swish - us_bank_account - wechat_pay - zip type: string x-stripeBypassValidation: true us_bank_account: $ref: '#/components/schemas/payment_method_us_bank_account' wechat_pay: $ref: '#/components/schemas/payment_method_wechat_pay' zip: $ref: '#/components/schemas/payment_method_zip' required: - billing_details - type title: ConfirmationTokensResourcePaymentMethodPreview type: object x-expandableFields: - acss_debit - affirm - afterpay_clearpay - alipay - amazon_pay - au_becs_debit - bacs_debit - bancontact - billing_details - blik - boleto - card - card_present - cashapp - customer_balance - eps - fpx - giropay - grabpay - ideal - interac_present - klarna - konbini - link - mobilepay - oxxo - p24 - paynow - paypal - pix - promptpay - revolut_pay - sepa_debit - sofort - swish - us_bank_account - wechat_pay - zip confirmation_tokens_resource_shipping: description: '' properties: address: $ref: '#/components/schemas/address' name: description: Recipient name. maxLength: 5000 type: string phone: description: Recipient phone (including extension). maxLength: 5000 nullable: true type: string required: - address - name title: ConfirmationTokensResourceShipping type: object x-expandableFields: - address connect_account_reference: description: '' properties: account: anyOf: - maxLength: 5000 type: string - $ref: '#/components/schemas/account' description: The connected account being referenced when `type` is `account`. x-expansionResources: oneOf: - $ref: '#/components/schemas/account' type: description: Type of the account referenced. enum: - account - self type: string required: - type title: ConnectAccountReference type: object x-expandableFields: - account connect_collection_transfer: description: '' properties: amount: description: 'Amount transferred, in cents (or local equivalent).' type: integer currency: description: >- 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). type: string destination: anyOf: - maxLength: 5000 type: string - $ref: '#/components/schemas/account' description: ID of the account that funds are being collected for. x-expansionResources: oneOf: - $ref: '#/components/schemas/account' id: description: Unique identifier for the object. maxLength: 5000 type: string livemode: description: >- Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. type: boolean object: description: >- String representing the object's type. Objects of the same type share the same value. enum: - connect_collection_transfer type: string required: - amount - currency - destination - id - livemode - object title: ConnectCollectionTransfer type: object x-expandableFields: - destination connect_embedded_account_config_claim: description: '' properties: enabled: description: Whether the embedded component is enabled. type: boolean features: $ref: '#/components/schemas/connect_embedded_account_features_claim' required: - enabled - features title: ConnectEmbeddedAccountConfigClaim type: object x-expandableFields: - features connect_embedded_account_features_claim: description: '' properties: external_account_collection: description: >- Whether to allow platforms to control bank account collection for their connected accounts. This feature can only be false for custom accounts (or accounts where the platform is compliance owner). Otherwise, bank account collection is determined by compliance requirements. type: boolean required: - external_account_collection title: ConnectEmbeddedAccountFeaturesClaim type: object x-expandableFields: [] connect_embedded_account_session_create_components: description: '' properties: account_management: $ref: '#/components/schemas/connect_embedded_account_config_claim' account_onboarding: $ref: '#/components/schemas/connect_embedded_account_config_claim' balances: $ref: '#/components/schemas/connect_embedded_payouts_config_claim' documents: $ref: '#/components/schemas/connect_embedded_base_config_claim' notification_banner: $ref: '#/components/schemas/connect_embedded_account_config_claim' payment_details: $ref: '#/components/schemas/connect_embedded_payments_config_claim' payments: $ref: '#/components/schemas/connect_embedded_payments_config_claim' payouts: $ref: '#/components/schemas/connect_embedded_payouts_config_claim' payouts_list: $ref: '#/components/schemas/connect_embedded_base_config_claim' required: - account_management - account_onboarding - balances - documents - notification_banner - payment_details - payments - payouts - payouts_list title: ConnectEmbeddedAccountSessionCreateComponents type: object x-expandableFields: - account_management - account_onboarding - balances - documents - notification_banner - payment_details - payments - payouts - payouts_list connect_embedded_base_config_claim: description: '' properties: enabled: description: Whether the embedded component is enabled. type: boolean features: $ref: '#/components/schemas/connect_embedded_base_features' required: - enabled - features title: ConnectEmbeddedBaseConfigClaim type: object x-expandableFields: - features connect_embedded_base_features: description: '' properties: {} title: ConnectEmbeddedBaseFeatures type: object x-expandableFields: [] connect_embedded_payments_config_claim: description: '' properties: enabled: description: Whether the embedded component is enabled. type: boolean features: $ref: '#/components/schemas/connect_embedded_payments_features' required: - enabled - features title: ConnectEmbeddedPaymentsConfigClaim type: object x-expandableFields: - features connect_embedded_payments_features: description: '' properties: capture_payments: description: >- Whether to allow capturing and cancelling payment intents. This is `true` by default. type: boolean destination_on_behalf_of_charge_management: description: >- Whether to allow connected accounts to manage destination charges that are created on behalf of them. This is `false` by default. type: boolean dispute_management: description: >- Whether to allow responding to disputes, including submitting evidence and accepting disputes. This is `true` by default. type: boolean refund_management: description: Whether to allow sending refunds. This is `true` by default. type: boolean required: - capture_payments - destination_on_behalf_of_charge_management - dispute_management - refund_management title: ConnectEmbeddedPaymentsFeatures type: object x-expandableFields: [] connect_embedded_payouts_config_claim: description: '' properties: enabled: description: Whether the embedded component is enabled. type: boolean features: $ref: '#/components/schemas/connect_embedded_payouts_features' required: - enabled - features title: ConnectEmbeddedPayoutsConfigClaim type: object x-expandableFields: - features connect_embedded_payouts_features: description: '' properties: edit_payout_schedule: description: >- Whether to allow payout schedule to be changed. Default `true` when Stripe owns Loss Liability, default `false` otherwise. type: boolean instant_payouts: description: >- Whether to allow creation of instant payouts. Default `true` when Stripe owns Loss Liability, default `false` otherwise. type: boolean standard_payouts: description: >- Whether to allow creation of standard payouts. Default `true` when Stripe owns Loss Liability, default `false` otherwise. type: boolean required: - edit_payout_schedule - instant_payouts - standard_payouts title: ConnectEmbeddedPayoutsFeatures type: object x-expandableFields: [] country_spec: description: >- Stripe needs to collect certain pieces of information about each account created. These requirements can differ depending on the account's country. The Country Specs API makes these rules available to your integration. You can also view the information from this API call as [an online guide](/docs/connect/required-verification-information). properties: default_currency: description: >- The default currency for this country. This applies to both payment methods and bank accounts. maxLength: 5000 type: string id: description: >- Unique identifier for the object. Represented as the ISO country code for this country. maxLength: 5000 type: string object: description: >- String representing the object's type. Objects of the same type share the same value. enum: - country_spec type: string supported_bank_account_currencies: additionalProperties: items: maxLength: 5000 type: string type: array description: >- Currencies that can be accepted in the specific country (for transfers). type: object supported_payment_currencies: description: >- Currencies that can be accepted in the specified country (for payments). items: maxLength: 5000 type: string type: array supported_payment_methods: description: >- Payment methods available in the specified country. You may need to enable some payment methods (e.g., [ACH](https://stripe.com/docs/ach)) on your account before they appear in this list. The `stripe` payment method refers to [charging through your platform](https://stripe.com/docs/connect/destination-charges). items: maxLength: 5000 type: string type: array supported_transfer_countries: description: Countries that can accept transfers from the specified country. items: maxLength: 5000 type: string type: array verification_fields: $ref: '#/components/schemas/country_spec_verification_fields' required: - default_currency - id - object - supported_bank_account_currencies - supported_payment_currencies - supported_payment_methods - supported_transfer_countries - verification_fields title: CountrySpec type: object x-expandableFields: - verification_fields x-resourceId: country_spec country_spec_verification_field_details: description: '' properties: additional: description: Additional fields which are only required for some users. items: maxLength: 5000 type: string type: array minimum: description: Fields which every account must eventually provide. items: maxLength: 5000 type: string type: array required: - additional - minimum title: CountrySpecVerificationFieldDetails type: object x-expandableFields: [] country_spec_verification_fields: description: '' properties: company: $ref: '#/components/schemas/country_spec_verification_field_details' individual: $ref: '#/components/schemas/country_spec_verification_field_details' required: - company - individual title: CountrySpecVerificationFields type: object x-expandableFields: - company - individual coupon: description: >- 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). properties: amount_off: description: >- Amount (in the `currency` specified) that will be taken off the subtotal of any invoices for this customer. nullable: true type: integer applies_to: $ref: '#/components/schemas/coupon_applies_to' created: description: >- Time at which the object was created. Measured in seconds since the Unix epoch. format: unix-time type: integer currency: description: >- 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. nullable: true type: string currency_options: additionalProperties: $ref: '#/components/schemas/coupon_currency_option' description: >- 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). type: object duration: description: >- One of `forever`, `once`, and `repeating`. Describes how long a customer who applies this coupon will get the discount. enum: - forever - once - repeating type: string x-stripeBypassValidation: true duration_in_months: description: >- If `duration` is `repeating`, the number of months the coupon applies. Null if coupon `duration` is `forever` or `once`. nullable: true type: integer id: description: Unique identifier for the object. maxLength: 5000 type: string livemode: description: >- Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. type: boolean max_redemptions: description: >- Maximum number of times this coupon can be redeemed, in total, across all customers, before it is no longer valid. nullable: true type: integer metadata: additionalProperties: maxLength: 500 type: string description: >- 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. nullable: true type: object name: description: >- Name of the coupon displayed to customers on for instance invoices or receipts. maxLength: 5000 nullable: true type: string object: description: >- String representing the object's type. Objects of the same type share the same value. enum: - coupon type: string percent_off: description: >- 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. nullable: true type: number redeem_by: description: Date after which the coupon can no longer be redeemed. format: unix-time nullable: true type: integer times_redeemed: description: Number of times this coupon has been applied to a customer. type: integer valid: description: >- Taking account of the above properties, whether this coupon can still be applied to a customer. type: boolean required: - created - duration - id - livemode - object - times_redeemed - valid title: Coupon type: object x-expandableFields: - applies_to - currency_options x-resourceId: coupon coupon_applies_to: description: '' properties: products: description: A list of product IDs this coupon applies to items: maxLength: 5000 type: string type: array required: - products title: CouponAppliesTo type: object x-expandableFields: [] coupon_currency_option: description: '' properties: amount_off: description: >- Amount (in the `currency` specified) that will be taken off the subtotal of any invoices for this customer. type: integer required: - amount_off title: CouponCurrencyOption type: object x-expandableFields: [] credit_note: description: >- Issue a credit note to adjust an invoice's amount after the invoice is finalized. Related guide: [Credit notes](https://stripe.com/docs/billing/invoices/credit-notes) properties: amount: description: >- The integer amount in cents (or local equivalent) representing the total amount of the credit note, including tax. type: integer amount_shipping: description: This is the sum of all the shipping amounts. type: integer created: description: >- Time at which the object was created. Measured in seconds since the Unix epoch. format: unix-time type: integer currency: description: >- 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). type: string customer: anyOf: - maxLength: 5000 type: string - $ref: '#/components/schemas/customer' - $ref: '#/components/schemas/deleted_customer' description: ID of the customer. x-expansionResources: oneOf: - $ref: '#/components/schemas/customer' - $ref: '#/components/schemas/deleted_customer' customer_balance_transaction: anyOf: - maxLength: 5000 type: string - $ref: '#/components/schemas/customer_balance_transaction' description: Customer balance transaction related to this credit note. nullable: true x-expansionResources: oneOf: - $ref: '#/components/schemas/customer_balance_transaction' discount_amount: description: >- The integer amount in cents (or local equivalent) representing the total amount of discount that was credited. type: integer discount_amounts: description: The aggregate amounts calculated per discount for all line items. items: $ref: '#/components/schemas/discounts_resource_discount_amount' type: array effective_at: description: >- The date when this credit note is in effect. Same as `created` unless overwritten. When defined, this value replaces the system-generated 'Date of issue' printed on the credit note PDF. format: unix-time nullable: true type: integer id: description: Unique identifier for the object. maxLength: 5000 type: string invoice: anyOf: - maxLength: 5000 type: string - $ref: '#/components/schemas/invoice' description: ID of the invoice. x-expansionResources: oneOf: - $ref: '#/components/schemas/invoice' lines: description: Line items that make up the credit note properties: data: description: Details about each object. items: $ref: '#/components/schemas/credit_note_line_item' type: array has_more: description: >- True if this list has another page of items after this one that can be fetched. type: boolean object: description: >- String representing the object's type. Objects of the same type share the same value. Always has the value `list`. enum: - list type: string url: description: The URL where this list can be accessed. maxLength: 5000 type: string required: - data - has_more - object - url title: CreditNoteLinesList type: object x-expandableFields: - data livemode: description: >- Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. type: boolean memo: description: Customer-facing text that appears on the credit note PDF. maxLength: 5000 nullable: true type: string metadata: additionalProperties: maxLength: 500 type: string description: >- 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. nullable: true type: object number: description: >- A unique number that identifies this particular credit note and appears on the PDF of the credit note and its associated invoice. maxLength: 5000 type: string object: description: >- String representing the object's type. Objects of the same type share the same value. enum: - credit_note type: string out_of_band_amount: description: Amount that was credited outside of Stripe. nullable: true type: integer pdf: description: The link to download the PDF of the credit note. maxLength: 5000 type: string reason: description: >- Reason for issuing this credit note, one of `duplicate`, `fraudulent`, `order_change`, or `product_unsatisfactory` enum: - duplicate - fraudulent - order_change - product_unsatisfactory nullable: true type: string refund: anyOf: - maxLength: 5000 type: string - $ref: '#/components/schemas/refund' description: Refund related to this credit note. nullable: true x-expansionResources: oneOf: - $ref: '#/components/schemas/refund' shipping_cost: anyOf: - $ref: '#/components/schemas/invoices_resource_shipping_cost' description: >- The details of the cost of shipping, including the ShippingRate applied to the invoice. nullable: true status: description: >- Status of this credit note, one of `issued` or `void`. Learn more about [voiding credit notes](https://stripe.com/docs/billing/invoices/credit-notes#voiding). enum: - issued - void type: string x-stripeBypassValidation: true subtotal: description: >- The integer amount in cents (or local equivalent) representing the amount of the credit note, excluding exclusive tax and invoice level discounts. type: integer subtotal_excluding_tax: description: >- The integer amount in cents (or local equivalent) representing the amount of the credit note, excluding all tax and invoice level discounts. nullable: true type: integer tax_amounts: description: The aggregate amounts calculated per tax rate for all line items. items: $ref: '#/components/schemas/credit_note_tax_amount' type: array total: description: >- The integer amount in cents (or local equivalent) representing the total amount of the credit note, including tax and all discount. type: integer total_excluding_tax: description: >- The integer amount in cents (or local equivalent) representing the total amount of the credit note, excluding tax, but including discounts. nullable: true type: integer type: description: >- Type of this credit note, one of `pre_payment` or `post_payment`. A `pre_payment` credit note means it was issued when the invoice was open. A `post_payment` credit note means it was issued when the invoice was paid. enum: - post_payment - pre_payment type: string voided_at: description: The time that the credit note was voided. format: unix-time nullable: true type: integer required: - amount - amount_shipping - created - currency - customer - discount_amount - discount_amounts - id - invoice - lines - livemode - number - object - pdf - status - subtotal - tax_amounts - total - type title: CreditNote type: object x-expandableFields: - customer - customer_balance_transaction - discount_amounts - invoice - lines - refund - shipping_cost - tax_amounts x-resourceId: credit_note credit_note_line_item: description: The credit note line item object properties: amount: description: >- The integer amount in cents (or local equivalent) representing the gross amount being credited for this line item, excluding (exclusive) tax and discounts. type: integer amount_excluding_tax: description: >- The integer amount in cents (or local equivalent) representing the amount being credited for this line item, excluding all tax and discounts. nullable: true type: integer description: description: Description of the item being credited. maxLength: 5000 nullable: true type: string discount_amount: description: >- The integer amount in cents (or local equivalent) representing the discount being credited for this line item. type: integer discount_amounts: description: The amount of discount calculated per discount for this line item items: $ref: '#/components/schemas/discounts_resource_discount_amount' type: array id: description: Unique identifier for the object. maxLength: 5000 type: string invoice_line_item: description: ID of the invoice line item being credited maxLength: 5000 type: string livemode: description: >- Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. type: boolean object: description: >- String representing the object's type. Objects of the same type share the same value. enum: - credit_note_line_item type: string quantity: description: The number of units of product being credited. nullable: true type: integer tax_amounts: description: The amount of tax calculated per tax rate for this line item items: $ref: '#/components/schemas/credit_note_tax_amount' type: array tax_rates: description: The tax rates which apply to the line item. items: $ref: '#/components/schemas/tax_rate' type: array type: description: >- The type of the credit note line item, one of `invoice_line_item` or `custom_line_item`. When the type is `invoice_line_item` there is an additional `invoice_line_item` property on the resource the value of which is the id of the credited line item on the invoice. enum: - custom_line_item - invoice_line_item type: string unit_amount: description: The cost of each unit of product being credited. nullable: true type: integer unit_amount_decimal: description: >- Same as `unit_amount`, but contains a decimal value with at most 12 decimal places. format: decimal nullable: true type: string unit_amount_excluding_tax: description: >- The amount in cents (or local equivalent) representing the unit amount being credited for this line item, excluding all tax and discounts. format: decimal nullable: true type: string required: - amount - discount_amount - discount_amounts - id - livemode - object - tax_amounts - tax_rates - type title: CreditNoteLineItem type: object x-expandableFields: - discount_amounts - tax_amounts - tax_rates x-resourceId: credit_note_line_item credit_note_tax_amount: description: '' properties: amount: description: 'The amount, in cents (or local equivalent), of the tax.' type: integer inclusive: description: Whether this tax amount is inclusive or exclusive. type: boolean tax_rate: anyOf: - maxLength: 5000 type: string - $ref: '#/components/schemas/tax_rate' description: The tax rate that was applied to get this tax amount. x-expansionResources: oneOf: - $ref: '#/components/schemas/tax_rate' taxability_reason: description: >- The reasoning behind this tax, for example, if the product is tax exempt. The possible values for this field may be extended as new tax rules are supported. enum: - customer_exempt - not_collecting - not_subject_to_tax - not_supported - portion_product_exempt - portion_reduced_rated - portion_standard_rated - product_exempt - product_exempt_holiday - proportionally_rated - reduced_rated - reverse_charge - standard_rated - taxable_basis_reduced - zero_rated nullable: true type: string x-stripeBypassValidation: true taxable_amount: description: >- The amount on which tax is calculated, in cents (or local equivalent). nullable: true type: integer required: - amount - inclusive - tax_rate title: CreditNoteTaxAmount type: object x-expandableFields: - tax_rate currency_option: description: '' properties: custom_unit_amount: anyOf: - $ref: '#/components/schemas/custom_unit_amount' description: >- When set, provides configuration for the amount to be adjusted by the customer during Checkout Sessions and Payment Links. nullable: true tax_behavior: description: >- Only required if a [default tax behavior](https://stripe.com/docs/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)) was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. Once specified as either `inclusive` or `exclusive`, it cannot be changed. enum: - exclusive - inclusive - unspecified nullable: true type: string tiers: description: >- Each element represents a pricing tier. This parameter requires `billing_scheme` to be set to `tiered`. See also the documentation for `billing_scheme`. items: $ref: '#/components/schemas/price_tier' type: array unit_amount: description: >- The unit amount in cents (or local equivalent) to be charged, represented as a whole integer if possible. Only set if `billing_scheme=per_unit`. nullable: true type: integer unit_amount_decimal: description: >- The unit amount in cents (or local equivalent) to be charged, represented as a decimal string with at most 12 decimal places. Only set if `billing_scheme=per_unit`. format: decimal nullable: true type: string title: CurrencyOption type: object x-expandableFields: - custom_unit_amount - tiers custom_unit_amount: description: '' properties: maximum: description: The maximum unit amount the customer can specify for this item. nullable: true type: integer minimum: description: >- The minimum unit amount the customer can specify for this item. Must be at least the minimum charge amount. nullable: true type: integer preset: description: The starting unit amount which can be updated by the customer. nullable: true type: integer title: CustomUnitAmount type: object x-expandableFields: [] customer: description: >- This object represents a customer of your business. Use it to create recurring charges and track payments that belong to the same customer. Related guide: [Save a card during payment](https://stripe.com/docs/payments/save-during-payment) properties: address: anyOf: - $ref: '#/components/schemas/address' description: The customer's address. nullable: true balance: description: >- 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. type: integer cash_balance: anyOf: - $ref: '#/components/schemas/cash_balance' description: >- The current funds being held by Stripe on behalf of the customer. You can apply these funds towards payment intents when the source is "cash_balance". The `settings[reconciliation_mode]` field describes if these funds apply to these payment intents manually or automatically. nullable: true created: description: >- Time at which the object was created. Measured in seconds since the Unix epoch. format: unix-time type: integer currency: description: >- Three-letter [ISO code for the currency](https://stripe.com/docs/currencies) the customer can be charged in for recurring billing purposes. maxLength: 5000 nullable: true type: string default_source: anyOf: - maxLength: 5000 type: string - $ref: '#/components/schemas/bank_account' - $ref: '#/components/schemas/card' - $ref: '#/components/schemas/source' description: >- 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. nullable: true x-expansionResources: oneOf: - $ref: '#/components/schemas/bank_account' - $ref: '#/components/schemas/card' - $ref: '#/components/schemas/source' x-stripeBypassValidation: true delinquent: description: >- 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`. nullable: true type: boolean description: description: >- An arbitrary string attached to the object. Often useful for displaying to users. maxLength: 5000 nullable: true type: string discount: anyOf: - $ref: '#/components/schemas/discount' description: >- Describes the current discount active on the customer, if there is one. nullable: true email: description: The customer's email address. maxLength: 5000 nullable: true type: string id: description: Unique identifier for the object. maxLength: 5000 type: string invoice_credit_balance: additionalProperties: type: integer description: >- 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. type: object invoice_prefix: description: The prefix for the customer used to generate unique invoice numbers. maxLength: 5000 nullable: true type: string invoice_settings: $ref: '#/components/schemas/invoice_setting_customer_setting' livemode: description: >- Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. type: boolean metadata: additionalProperties: maxLength: 500 type: string description: >- 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. type: object name: description: The customer's full name or business name. maxLength: 5000 nullable: true type: string next_invoice_sequence: description: >- The suffix of the customer's next invoice number (for example, 0001). type: integer object: description: >- String representing the object's type. Objects of the same type share the same value. enum: - customer type: string phone: description: The customer's phone number. maxLength: 5000 nullable: true type: string preferred_locales: description: 'The customer''s preferred locales (languages), ordered by preference.' items: maxLength: 5000 type: string nullable: true type: array shipping: anyOf: - $ref: '#/components/schemas/shipping' description: >- Mailing and shipping address for the customer. Appears on invoices emailed to this customer. nullable: true sources: description: 'The customer''s payment sources, if any.' properties: data: description: Details about each object. items: anyOf: - $ref: '#/components/schemas/bank_account' - $ref: '#/components/schemas/card' - $ref: '#/components/schemas/source' title: Polymorphic x-stripeBypassValidation: true type: array has_more: description: >- True if this list has another page of items after this one that can be fetched. type: boolean object: description: >- String representing the object's type. Objects of the same type share the same value. Always has the value `list`. enum: - list type: string url: description: The URL where this list can be accessed. maxLength: 5000 type: string required: - data - has_more - object - url title: ApmsSourcesSourceList type: object x-expandableFields: - data subscriptions: description: 'The customer''s current subscriptions, if any.' properties: data: description: Details about each object. items: $ref: '#/components/schemas/subscription' type: array has_more: description: >- True if this list has another page of items after this one that can be fetched. type: boolean object: description: >- String representing the object's type. Objects of the same type share the same value. Always has the value `list`. enum: - list type: string url: description: The URL where this list can be accessed. maxLength: 5000 type: string required: - data - has_more - object - url title: SubscriptionList type: object x-expandableFields: - data tax: $ref: '#/components/schemas/customer_tax' tax_exempt: description: >- 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"**. enum: - exempt - none - reverse nullable: true type: string tax_ids: description: The customer's tax IDs. properties: data: description: Details about each object. items: $ref: '#/components/schemas/tax_id' type: array has_more: description: >- True if this list has another page of items after this one that can be fetched. type: boolean object: description: >- String representing the object's type. Objects of the same type share the same value. Always has the value `list`. enum: - list type: string url: description: The URL where this list can be accessed. maxLength: 5000 type: string required: - data - has_more - object - url title: TaxIDsList type: object x-expandableFields: - data test_clock: anyOf: - maxLength: 5000 type: string - $ref: '#/components/schemas/test_helpers.test_clock' description: ID of the test clock that this customer belongs to. nullable: true x-expansionResources: oneOf: - $ref: '#/components/schemas/test_helpers.test_clock' required: - created - id - livemode - object title: Customer type: object x-expandableFields: - address - cash_balance - default_source - discount - invoice_settings - shipping - sources - subscriptions - tax - tax_ids - test_clock x-resourceId: customer customer_acceptance: description: '' properties: accepted_at: description: The time that the customer accepts the mandate. format: unix-time nullable: true type: integer offline: $ref: '#/components/schemas/offline_acceptance' online: $ref: '#/components/schemas/online_acceptance' type: description: >- The mandate includes the type of customer acceptance information, such as: `online` or `offline`. enum: - offline - online type: string required: - type title: customer_acceptance type: object x-expandableFields: - offline - online customer_balance_customer_balance_settings: description: '' properties: reconciliation_mode: description: >- The configuration for how funds that land in the customer cash balance are reconciled. enum: - automatic - manual type: string using_merchant_default: description: >- A flag to indicate if reconciliation mode returned is the user's default or is specific to this customer cash balance type: boolean required: - reconciliation_mode - using_merchant_default title: CustomerBalanceCustomerBalanceSettings type: object x-expandableFields: [] customer_balance_resource_cash_balance_transaction_resource_adjusted_for_overdraft: description: '' properties: balance_transaction: anyOf: - maxLength: 5000 type: string - $ref: '#/components/schemas/balance_transaction' description: >- The [Balance Transaction](https://stripe.com/docs/api/balance_transactions/object) that corresponds to funds taken out of your Stripe balance. x-expansionResources: oneOf: - $ref: '#/components/schemas/balance_transaction' linked_transaction: anyOf: - maxLength: 5000 type: string - $ref: '#/components/schemas/customer_cash_balance_transaction' description: >- The [Cash Balance Transaction](https://stripe.com/docs/api/cash_balance_transactions/object) that brought the customer balance negative, triggering the clawback of funds. x-expansionResources: oneOf: - $ref: '#/components/schemas/customer_cash_balance_transaction' required: - balance_transaction - linked_transaction title: >- CustomerBalanceResourceCashBalanceTransactionResourceAdjustedForOverdraft type: object x-expandableFields: - balance_transaction - linked_transaction customer_balance_resource_cash_balance_transaction_resource_applied_to_payment_transaction: description: '' properties: payment_intent: anyOf: - maxLength: 5000 type: string - $ref: '#/components/schemas/payment_intent' description: >- The [Payment Intent](https://stripe.com/docs/api/payment_intents/object) that funds were applied to. x-expansionResources: oneOf: - $ref: '#/components/schemas/payment_intent' required: - payment_intent title: >- CustomerBalanceResourceCashBalanceTransactionResourceAppliedToPaymentTransaction type: object x-expandableFields: - payment_intent customer_balance_resource_cash_balance_transaction_resource_funded_transaction: description: '' properties: bank_transfer: $ref: >- #/components/schemas/customer_balance_resource_cash_balance_transaction_resource_funded_transaction_resource_bank_transfer required: - bank_transfer title: CustomerBalanceResourceCashBalanceTransactionResourceFundedTransaction type: object x-expandableFields: - bank_transfer customer_balance_resource_cash_balance_transaction_resource_funded_transaction_resource_bank_transfer: description: '' properties: eu_bank_transfer: $ref: >- #/components/schemas/customer_balance_resource_cash_balance_transaction_resource_funded_transaction_resource_bank_transfer_resource_eu_bank_transfer gb_bank_transfer: $ref: >- #/components/schemas/customer_balance_resource_cash_balance_transaction_resource_funded_transaction_resource_bank_transfer_resource_gb_bank_transfer jp_bank_transfer: $ref: >- #/components/schemas/customer_balance_resource_cash_balance_transaction_resource_funded_transaction_resource_bank_transfer_resource_jp_bank_transfer reference: description: The user-supplied reference field on the bank transfer. maxLength: 5000 nullable: true type: string type: description: >- The funding method type used to fund the customer balance. Permitted values include: `eu_bank_transfer`, `gb_bank_transfer`, `jp_bank_transfer`, `mx_bank_transfer`, or `us_bank_transfer`. enum: - eu_bank_transfer - gb_bank_transfer - jp_bank_transfer - mx_bank_transfer - us_bank_transfer type: string x-stripeBypassValidation: true us_bank_transfer: $ref: >- #/components/schemas/customer_balance_resource_cash_balance_transaction_resource_funded_transaction_resource_bank_transfer_resource_us_bank_transfer required: - type title: >- CustomerBalanceResourceCashBalanceTransactionResourceFundedTransactionResourceBankTransfer type: object x-expandableFields: - eu_bank_transfer - gb_bank_transfer - jp_bank_transfer - us_bank_transfer customer_balance_resource_cash_balance_transaction_resource_funded_transaction_resource_bank_transfer_resource_eu_bank_transfer: description: '' properties: bic: description: The BIC of the bank of the sender of the funding. maxLength: 5000 nullable: true type: string iban_last4: description: The last 4 digits of the IBAN of the sender of the funding. maxLength: 5000 nullable: true type: string sender_name: description: 'The full name of the sender, as supplied by the sending bank.' maxLength: 5000 nullable: true type: string title: >- CustomerBalanceResourceCashBalanceTransactionResourceFundedTransactionResourceBankTransferResourceEuBankTransfer type: object x-expandableFields: [] customer_balance_resource_cash_balance_transaction_resource_funded_transaction_resource_bank_transfer_resource_gb_bank_transfer: description: '' properties: account_number_last4: description: >- The last 4 digits of the account number of the sender of the funding. maxLength: 5000 nullable: true type: string sender_name: description: 'The full name of the sender, as supplied by the sending bank.' maxLength: 5000 nullable: true type: string sort_code: description: The sort code of the bank of the sender of the funding maxLength: 5000 nullable: true type: string title: >- CustomerBalanceResourceCashBalanceTransactionResourceFundedTransactionResourceBankTransferResourceGbBankTransfer type: object x-expandableFields: [] customer_balance_resource_cash_balance_transaction_resource_funded_transaction_resource_bank_transfer_resource_jp_bank_transfer: description: '' properties: sender_bank: description: The name of the bank of the sender of the funding. maxLength: 5000 nullable: true type: string sender_branch: description: The name of the bank branch of the sender of the funding. maxLength: 5000 nullable: true type: string sender_name: description: 'The full name of the sender, as supplied by the sending bank.' maxLength: 5000 nullable: true type: string title: >- CustomerBalanceResourceCashBalanceTransactionResourceFundedTransactionResourceBankTransferResourceJpBankTransfer type: object x-expandableFields: [] customer_balance_resource_cash_balance_transaction_resource_funded_transaction_resource_bank_transfer_resource_us_bank_transfer: description: '' properties: network: description: The banking network used for this funding. enum: - ach - domestic_wire_us - swift type: string sender_name: description: 'The full name of the sender, as supplied by the sending bank.' maxLength: 5000 nullable: true type: string title: >- CustomerBalanceResourceCashBalanceTransactionResourceFundedTransactionResourceBankTransferResourceUsBankTransfer type: object x-expandableFields: [] customer_balance_resource_cash_balance_transaction_resource_refunded_from_payment_transaction: description: '' properties: refund: anyOf: - maxLength: 5000 type: string - $ref: '#/components/schemas/refund' description: >- The [Refund](https://stripe.com/docs/api/refunds/object) that moved these funds into the customer's cash balance. x-expansionResources: oneOf: - $ref: '#/components/schemas/refund' required: - refund title: >- CustomerBalanceResourceCashBalanceTransactionResourceRefundedFromPaymentTransaction type: object x-expandableFields: - refund customer_balance_resource_cash_balance_transaction_resource_transferred_to_balance: description: '' properties: balance_transaction: anyOf: - maxLength: 5000 type: string - $ref: '#/components/schemas/balance_transaction' description: >- The [Balance Transaction](https://stripe.com/docs/api/balance_transactions/object) that corresponds to funds transferred to your Stripe balance. x-expansionResources: oneOf: - $ref: '#/components/schemas/balance_transaction' required: - balance_transaction title: >- CustomerBalanceResourceCashBalanceTransactionResourceTransferredToBalance type: object x-expandableFields: - balance_transaction customer_balance_resource_cash_balance_transaction_resource_unapplied_from_payment_transaction: description: '' properties: payment_intent: anyOf: - maxLength: 5000 type: string - $ref: '#/components/schemas/payment_intent' description: >- The [Payment Intent](https://stripe.com/docs/api/payment_intents/object) that funds were unapplied from. x-expansionResources: oneOf: - $ref: '#/components/schemas/payment_intent' required: - payment_intent title: >- CustomerBalanceResourceCashBalanceTransactionResourceUnappliedFromPaymentTransaction type: object x-expandableFields: - payment_intent customer_balance_transaction: description: >- Each customer has a [Balance](https://stripe.com/docs/api/customers/object#customer_object-balance) value, which denotes a debit or credit that's automatically applied to their next invoice upon finalization. You may modify the value directly by using the [update customer API](https://stripe.com/docs/api/customers/update), or by creating a Customer Balance Transaction, which increments or decrements the customer's `balance` by the specified `amount`. Related guide: [Customer balance](https://stripe.com/docs/billing/customer/balance) properties: amount: description: >- The amount of the transaction. A negative value is a credit for the customer's balance, and a positive value is a debit to the customer's `balance`. type: integer created: description: >- Time at which the object was created. Measured in seconds since the Unix epoch. format: unix-time type: integer credit_note: anyOf: - maxLength: 5000 type: string - $ref: '#/components/schemas/credit_note' description: The ID of the credit note (if any) related to the transaction. nullable: true x-expansionResources: oneOf: - $ref: '#/components/schemas/credit_note' currency: description: >- 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). type: string customer: anyOf: - maxLength: 5000 type: string - $ref: '#/components/schemas/customer' description: The ID of the customer the transaction belongs to. x-expansionResources: oneOf: - $ref: '#/components/schemas/customer' description: description: >- An arbitrary string attached to the object. Often useful for displaying to users. maxLength: 5000 nullable: true type: string ending_balance: description: >- The customer's `balance` after the transaction was applied. A negative value decreases the amount due on the customer's next invoice. A positive value increases the amount due on the customer's next invoice. type: integer id: description: Unique identifier for the object. maxLength: 5000 type: string invoice: anyOf: - maxLength: 5000 type: string - $ref: '#/components/schemas/invoice' description: The ID of the invoice (if any) related to the transaction. nullable: true x-expansionResources: oneOf: - $ref: '#/components/schemas/invoice' livemode: description: >- Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. type: boolean metadata: additionalProperties: maxLength: 500 type: string description: >- 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. nullable: true type: object object: description: >- String representing the object's type. Objects of the same type share the same value. enum: - customer_balance_transaction type: string type: description: >- Transaction type: `adjustment`, `applied_to_invoice`, `credit_note`, `initial`, `invoice_overpaid`, `invoice_too_large`, `invoice_too_small`, `unspent_receiver_credit`, or `unapplied_from_invoice`. See the [Customer Balance page](https://stripe.com/docs/billing/customer/balance#types) to learn more about transaction types. enum: - adjustment - applied_to_invoice - credit_note - initial - invoice_overpaid - invoice_too_large - invoice_too_small - migration - unapplied_from_invoice - unspent_receiver_credit type: string x-stripeBypassValidation: true required: - amount - created - currency - customer - ending_balance - id - livemode - object - type title: CustomerBalanceTransaction type: object x-expandableFields: - credit_note - customer - invoice x-resourceId: customer_balance_transaction customer_cash_balance_transaction: description: >- Customers with certain payments enabled have a cash balance, representing funds that were paid by the customer to a merchant, but have not yet been allocated to a payment. Cash Balance Transactions represent when funds are moved into or out of this balance. This includes funding by the customer, allocation to payments, and refunds to the customer. properties: adjusted_for_overdraft: $ref: >- #/components/schemas/customer_balance_resource_cash_balance_transaction_resource_adjusted_for_overdraft applied_to_payment: $ref: >- #/components/schemas/customer_balance_resource_cash_balance_transaction_resource_applied_to_payment_transaction created: description: >- Time at which the object was created. Measured in seconds since the Unix epoch. format: unix-time type: integer currency: description: >- 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). maxLength: 5000 type: string customer: anyOf: - maxLength: 5000 type: string - $ref: '#/components/schemas/customer' description: >- The customer whose available cash balance changed as a result of this transaction. x-expansionResources: oneOf: - $ref: '#/components/schemas/customer' ending_balance: description: >- The total available cash balance for the specified currency after this transaction was applied. Represented in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). type: integer funded: $ref: >- #/components/schemas/customer_balance_resource_cash_balance_transaction_resource_funded_transaction id: description: Unique identifier for the object. maxLength: 5000 type: string livemode: description: >- Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. type: boolean net_amount: description: >- The amount by which the cash balance changed, represented in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). A positive value represents funds being added to the cash balance, a negative value represents funds being removed from the cash balance. type: integer object: description: >- String representing the object's type. Objects of the same type share the same value. enum: - customer_cash_balance_transaction type: string refunded_from_payment: $ref: >- #/components/schemas/customer_balance_resource_cash_balance_transaction_resource_refunded_from_payment_transaction transferred_to_balance: $ref: >- #/components/schemas/customer_balance_resource_cash_balance_transaction_resource_transferred_to_balance type: description: >- The type of the cash balance transaction. New types may be added in future. See [Customer Balance](https://stripe.com/docs/payments/customer-balance#types) to learn more about these types. enum: - adjusted_for_overdraft - applied_to_payment - funded - funding_reversed - refunded_from_payment - return_canceled - return_initiated - transferred_to_balance - unapplied_from_payment type: string unapplied_from_payment: $ref: >- #/components/schemas/customer_balance_resource_cash_balance_transaction_resource_unapplied_from_payment_transaction required: - created - currency - customer - ending_balance - id - livemode - net_amount - object - type title: CustomerCashBalanceTransaction type: object x-expandableFields: - adjusted_for_overdraft - applied_to_payment - customer - funded - refunded_from_payment - transferred_to_balance - unapplied_from_payment x-resourceId: customer_cash_balance_transaction customer_session: description: >- A customer session allows you to grant client access to Stripe's frontend SDKs (like StripeJs) control over a customer. properties: client_secret: description: >- The client secret of this customer session. Used on the client to set up secure access to the given `customer`. The client secret can be used to provide access to `customer` from your frontend. It should not be stored, logged, or exposed to anyone other than the relevant customer. Make sure that you have TLS enabled on any page that includes the client secret. maxLength: 5000 type: string components: $ref: '#/components/schemas/customer_session_resource_components' created: description: >- Time at which the object was created. Measured in seconds since the Unix epoch. format: unix-time type: integer customer: anyOf: - maxLength: 5000 type: string - $ref: '#/components/schemas/customer' description: The customer the customer session was created for. x-expansionResources: oneOf: - $ref: '#/components/schemas/customer' expires_at: description: The timestamp at which this customer session will expire. format: unix-time type: integer livemode: description: >- Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. type: boolean object: description: >- String representing the object's type. Objects of the same type share the same value. enum: - customer_session type: string required: - client_secret - created - customer - expires_at - livemode - object title: CustomerSessionResourceCustomerSession type: object x-expandableFields: - components - customer x-resourceId: customer_session customer_session_resource_components: description: Configuration for the components supported by this customer session. properties: buy_button: $ref: >- #/components/schemas/customer_session_resource_components_resource_buy_button pricing_table: $ref: >- #/components/schemas/customer_session_resource_components_resource_pricing_table required: - buy_button - pricing_table title: CustomerSessionResourceComponents type: object x-expandableFields: - buy_button - pricing_table customer_session_resource_components_resource_buy_button: description: This hash contains whether the buy button is enabled. properties: enabled: description: Whether the buy button is enabled. type: boolean required: - enabled title: CustomerSessionResourceComponentsResourceBuyButton type: object x-expandableFields: [] customer_session_resource_components_resource_pricing_table: description: This hash contains whether the pricing table is enabled. properties: enabled: description: Whether the pricing table is enabled. type: boolean required: - enabled title: CustomerSessionResourceComponentsResourcePricingTable type: object x-expandableFields: [] customer_tax: description: '' properties: automatic_tax: description: >- Surfaces if automatic tax computation is possible given the current customer location information. enum: - failed - not_collecting - supported - unrecognized_location type: string ip_address: description: >- A recent IP address of the customer used for tax reporting and tax location inference. maxLength: 5000 nullable: true type: string location: anyOf: - $ref: '#/components/schemas/customer_tax_location' description: The customer's location as identified by Stripe Tax. nullable: true required: - automatic_tax title: CustomerTax type: object x-expandableFields: - location customer_tax_location: description: '' properties: country: description: The customer's country as identified by Stripe Tax. maxLength: 5000 type: string source: description: The data source used to infer the customer's location. enum: - billing_address - ip_address - payment_method - shipping_destination type: string state: description: >- The customer's state, county, province, or region as identified by Stripe Tax. maxLength: 5000 nullable: true type: string required: - country - source title: CustomerTaxLocation type: object x-expandableFields: [] deleted_account: description: '' properties: deleted: description: Always true for a deleted object enum: - true type: boolean id: description: Unique identifier for the object. maxLength: 5000 type: string object: description: >- String representing the object's type. Objects of the same type share the same value. enum: - account type: string required: - deleted - id - object title: DeletedAccount type: object x-expandableFields: [] x-resourceId: deleted_account deleted_apple_pay_domain: description: '' properties: deleted: description: Always true for a deleted object enum: - true type: boolean id: description: Unique identifier for the object. maxLength: 5000 type: string object: description: >- String representing the object's type. Objects of the same type share the same value. enum: - apple_pay_domain type: string required: - deleted - id - object title: DeletedApplePayDomain type: object x-expandableFields: [] x-resourceId: deleted_apple_pay_domain deleted_application: description: '' properties: deleted: description: Always true for a deleted object enum: - true type: boolean id: description: Unique identifier for the object. maxLength: 5000 type: string name: description: The name of the application. maxLength: 5000 nullable: true type: string object: description: >- String representing the object's type. Objects of the same type share the same value. enum: - application type: string required: - deleted - id - object title: DeletedApplication type: object x-expandableFields: [] deleted_bank_account: description: '' properties: currency: description: >- Three-letter [ISO code for the currency](https://stripe.com/docs/payouts) paid out to the bank account. maxLength: 5000 nullable: true type: string deleted: description: Always true for a deleted object enum: - true type: boolean id: description: Unique identifier for the object. maxLength: 5000 type: string object: description: >- String representing the object's type. Objects of the same type share the same value. enum: - bank_account type: string required: - deleted - id - object title: DeletedBankAccount type: object x-expandableFields: [] deleted_card: description: '' properties: currency: description: >- Three-letter [ISO code for the currency](https://stripe.com/docs/payouts) paid out to the bank account. maxLength: 5000 nullable: true type: string deleted: description: Always true for a deleted object enum: - true type: boolean id: description: Unique identifier for the object. maxLength: 5000 type: string object: description: >- String representing the object's type. Objects of the same type share the same value. enum: - card type: string required: - deleted - id - object title: DeletedCard type: object x-expandableFields: [] deleted_coupon: description: '' properties: deleted: description: Always true for a deleted object enum: - true type: boolean id: description: Unique identifier for the object. maxLength: 5000 type: string object: description: >- String representing the object's type. Objects of the same type share the same value. enum: - coupon type: string required: - deleted - id - object title: DeletedCoupon type: object x-expandableFields: [] x-resourceId: deleted_coupon deleted_customer: description: '' properties: deleted: description: Always true for a deleted object enum: - true type: boolean id: description: Unique identifier for the object. maxLength: 5000 type: string object: description: >- String representing the object's type. Objects of the same type share the same value. enum: - customer type: string required: - deleted - id - object title: DeletedCustomer type: object x-expandableFields: [] x-resourceId: deleted_customer deleted_discount: description: '' properties: checkout_session: description: >- 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. maxLength: 5000 nullable: true type: string coupon: $ref: '#/components/schemas/coupon' customer: anyOf: - maxLength: 5000 type: string - $ref: '#/components/schemas/customer' - $ref: '#/components/schemas/deleted_customer' description: The ID of the customer associated with this discount. nullable: true x-expansionResources: oneOf: - $ref: '#/components/schemas/customer' - $ref: '#/components/schemas/deleted_customer' deleted: description: Always true for a deleted object enum: - true type: boolean id: description: >- 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. maxLength: 5000 type: string invoice: description: >- The invoice that the discount's coupon was applied to, if it was applied directly to a particular invoice. maxLength: 5000 nullable: true type: string invoice_item: description: >- 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. maxLength: 5000 nullable: true type: string object: description: >- String representing the object's type. Objects of the same type share the same value. enum: - discount type: string promotion_code: anyOf: - maxLength: 5000 type: string - $ref: '#/components/schemas/promotion_code' description: The promotion code applied to create this discount. nullable: true x-expansionResources: oneOf: - $ref: '#/components/schemas/promotion_code' start: description: Date that the coupon was applied. format: unix-time type: integer subscription: description: >- The subscription that this coupon is applied to, if it is applied to a particular subscription. maxLength: 5000 nullable: true type: string subscription_item: description: >- The subscription item that this coupon is applied to, if it is applied to a particular subscription item. maxLength: 5000 nullable: true type: string required: - coupon - deleted - id - object - start title: DeletedDiscount type: object x-expandableFields: - coupon - customer - promotion_code x-resourceId: deleted_discount deleted_external_account: anyOf: - $ref: '#/components/schemas/deleted_bank_account' - $ref: '#/components/schemas/deleted_card' title: Polymorphic x-resourceId: deleted_external_account x-stripeBypassValidation: true deleted_invoice: description: '' properties: deleted: description: Always true for a deleted object enum: - true type: boolean id: description: Unique identifier for the object. maxLength: 5000 type: string object: description: >- String representing the object's type. Objects of the same type share the same value. enum: - invoice type: string required: - deleted - id - object title: DeletedInvoice type: object x-expandableFields: [] x-resourceId: deleted_invoice deleted_invoiceitem: description: '' properties: deleted: description: Always true for a deleted object enum: - true type: boolean id: description: Unique identifier for the object. maxLength: 5000 type: string object: description: >- String representing the object's type. Objects of the same type share the same value. enum: - invoiceitem type: string required: - deleted - id - object title: DeletedInvoiceItem type: object x-expandableFields: [] x-resourceId: deleted_invoiceitem deleted_payment_source: anyOf: - $ref: '#/components/schemas/deleted_bank_account' - $ref: '#/components/schemas/deleted_card' title: Polymorphic x-resourceId: deleted_payment_source x-stripeBypassValidation: true deleted_person: description: '' properties: deleted: description: Always true for a deleted object enum: - true type: boolean id: description: Unique identifier for the object. maxLength: 5000 type: string object: description: >- String representing the object's type. Objects of the same type share the same value. enum: - person type: string required: - deleted - id - object title: DeletedPerson type: object x-expandableFields: [] x-resourceId: deleted_person deleted_plan: description: '' properties: deleted: description: Always true for a deleted object enum: - true type: boolean id: description: Unique identifier for the object. maxLength: 5000 type: string object: description: >- String representing the object's type. Objects of the same type share the same value. enum: - plan type: string required: - deleted - id - object title: DeletedPlan type: object x-expandableFields: [] x-resourceId: deleted_plan deleted_price: description: '' properties: deleted: description: Always true for a deleted object enum: - true type: boolean id: description: Unique identifier for the object. maxLength: 5000 type: string object: description: >- String representing the object's type. Objects of the same type share the same value. enum: - price type: string required: - deleted - id - object title: DeletedPrice type: object x-expandableFields: [] deleted_product: description: '' properties: deleted: description: Always true for a deleted object enum: - true type: boolean id: description: Unique identifier for the object. maxLength: 5000 type: string object: description: >- String representing the object's type. Objects of the same type share the same value. enum: - product type: string required: - deleted - id - object title: DeletedProduct type: object x-expandableFields: [] x-resourceId: deleted_product deleted_product_feature: description: '' properties: deleted: description: Always true for a deleted object enum: - true type: boolean id: description: Unique identifier for the object. maxLength: 5000 type: string object: description: >- String representing the object's type. Objects of the same type share the same value. enum: - product_feature type: string required: - deleted - id - object title: DeletedProductFeature type: object x-expandableFields: [] x-resourceId: deleted_product_feature deleted_radar.value_list: description: '' properties: deleted: description: Always true for a deleted object enum: - true type: boolean id: description: Unique identifier for the object. maxLength: 5000 type: string object: description: >- String representing the object's type. Objects of the same type share the same value. enum: - radar.value_list type: string required: - deleted - id - object title: RadarListDeletedList type: object x-expandableFields: [] x-resourceId: deleted_radar.value_list deleted_radar.value_list_item: description: '' properties: deleted: description: Always true for a deleted object enum: - true type: boolean id: description: Unique identifier for the object. maxLength: 5000 type: string object: description: >- String representing the object's type. Objects of the same type share the same value. enum: - radar.value_list_item type: string required: - deleted - id - object title: RadarListDeletedListItem type: object x-expandableFields: [] x-resourceId: deleted_radar.value_list_item deleted_subscription_item: description: '' properties: deleted: description: Always true for a deleted object enum: - true type: boolean id: description: Unique identifier for the object. maxLength: 5000 type: string object: description: >- String representing the object's type. Objects of the same type share the same value. enum: - subscription_item type: string required: - deleted - id - object title: DeletedSubscriptionItem type: object x-expandableFields: [] x-resourceId: deleted_subscription_item deleted_tax_id: description: '' properties: deleted: description: Always true for a deleted object enum: - true type: boolean id: description: Unique identifier for the object. maxLength: 5000 type: string object: description: >- String representing the object's type. Objects of the same type share the same value. enum: - tax_id type: string required: - deleted - id - object title: deleted_tax_id type: object x-expandableFields: [] x-resourceId: deleted_tax_id deleted_terminal.configuration: description: '' properties: deleted: description: Always true for a deleted object enum: - true type: boolean id: description: Unique identifier for the object. maxLength: 5000 type: string object: description: >- String representing the object's type. Objects of the same type share the same value. enum: - terminal.configuration type: string required: - deleted - id - object title: TerminalConfigurationDeletedConfiguration type: object x-expandableFields: [] x-resourceId: deleted_terminal.configuration deleted_terminal.location: description: '' properties: deleted: description: Always true for a deleted object enum: - true type: boolean id: description: Unique identifier for the object. maxLength: 5000 type: string object: description: >- String representing the object's type. Objects of the same type share the same value. enum: - terminal.location type: string required: - deleted - id - object title: TerminalLocationDeletedLocation type: object x-expandableFields: [] x-resourceId: deleted_terminal.location deleted_terminal.reader: description: '' properties: deleted: description: Always true for a deleted object enum: - true type: boolean id: description: Unique identifier for the object. maxLength: 5000 type: string object: description: >- String representing the object's type. Objects of the same type share the same value. enum: - terminal.reader type: string required: - deleted - id - object title: TerminalReaderDeletedReader type: object x-expandableFields: [] x-resourceId: deleted_terminal.reader deleted_test_helpers.test_clock: description: '' properties: deleted: description: Always true for a deleted object enum: - true type: boolean id: description: Unique identifier for the object. maxLength: 5000 type: string object: description: >- String representing the object's type. Objects of the same type share the same value. enum: - test_helpers.test_clock type: string required: - deleted - id - object title: DeletedTestClock type: object x-expandableFields: [] x-resourceId: deleted_test_helpers.test_clock deleted_webhook_endpoint: description: '' properties: deleted: description: Always true for a deleted object enum: - true type: boolean id: description: Unique identifier for the object. maxLength: 5000 type: string object: description: >- String representing the object's type. Objects of the same type share the same value. enum: - webhook_endpoint type: string required: - deleted - id - object title: NotificationWebhookEndpointDeleted type: object x-expandableFields: [] x-resourceId: deleted_webhook_endpoint destination_details_unimplemented: description: '' properties: {} title: destination_details_unimplemented type: object x-expandableFields: [] discount: description: >- 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) properties: checkout_session: description: >- 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. maxLength: 5000 nullable: true type: string coupon: $ref: '#/components/schemas/coupon' customer: anyOf: - maxLength: 5000 type: string - $ref: '#/components/schemas/customer' - $ref: '#/components/schemas/deleted_customer' description: The ID of the customer associated with this discount. nullable: true x-expansionResources: oneOf: - $ref: '#/components/schemas/customer' - $ref: '#/components/schemas/deleted_customer' end: description: >- 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. format: unix-time nullable: true type: integer id: description: >- 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. maxLength: 5000 type: string invoice: description: >- The invoice that the discount's coupon was applied to, if it was applied directly to a particular invoice. maxLength: 5000 nullable: true type: string invoice_item: description: >- 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. maxLength: 5000 nullable: true type: string object: description: >- String representing the object's type. Objects of the same type share the same value. enum: - discount type: string promotion_code: anyOf: - maxLength: 5000 type: string - $ref: '#/components/schemas/promotion_code' description: The promotion code applied to create this discount. nullable: true x-expansionResources: oneOf: - $ref: '#/components/schemas/promotion_code' start: description: Date that the coupon was applied. format: unix-time type: integer subscription: description: >- The subscription that this coupon is applied to, if it is applied to a particular subscription. maxLength: 5000 nullable: true type: string subscription_item: description: >- The subscription item that this coupon is applied to, if it is applied to a particular subscription item. maxLength: 5000 nullable: true type: string required: - coupon - id - object - start title: Discount type: object x-expandableFields: - coupon - customer - promotion_code x-resourceId: discount discounts_resource_discount_amount: description: '' properties: amount: description: 'The amount, in cents (or local equivalent), of the discount.' type: integer discount: anyOf: - maxLength: 5000 type: string - $ref: '#/components/schemas/discount' - $ref: '#/components/schemas/deleted_discount' description: The discount that was applied to get this discount amount. x-expansionResources: oneOf: - $ref: '#/components/schemas/discount' - $ref: '#/components/schemas/deleted_discount' required: - amount - discount title: DiscountsResourceDiscountAmount type: object x-expandableFields: - discount discounts_resource_stackable_discount: description: '' properties: coupon: anyOf: - maxLength: 5000 type: string - $ref: '#/components/schemas/coupon' description: ID of the coupon to create a new discount for. nullable: true x-expansionResources: oneOf: - $ref: '#/components/schemas/coupon' discount: anyOf: - maxLength: 5000 type: string - $ref: '#/components/schemas/discount' description: >- ID of an existing discount on the object (or one of its ancestors) to reuse. nullable: true x-expansionResources: oneOf: - $ref: '#/components/schemas/discount' promotion_code: anyOf: - maxLength: 5000 type: string - $ref: '#/components/schemas/promotion_code' description: ID of the promotion code to create a new discount for. nullable: true x-expansionResources: oneOf: - $ref: '#/components/schemas/promotion_code' title: DiscountsResourceStackableDiscount type: object x-expandableFields: - coupon - discount - promotion_code dispute: description: >- A dispute occurs when a customer questions your charge with their card issuer. When this happens, you have the opportunity to respond to the dispute with evidence that shows that the charge is legitimate. Related guide: [Disputes and fraud](https://stripe.com/docs/disputes) properties: amount: description: >- Disputed amount. Usually the amount of the charge, but it can differ (usually because of currency fluctuation or because only part of the order is disputed). type: integer balance_transactions: description: >- List of zero, one, or two balance transactions that show funds withdrawn and reinstated to your Stripe account as a result of this dispute. items: $ref: '#/components/schemas/balance_transaction' type: array charge: anyOf: - maxLength: 5000 type: string - $ref: '#/components/schemas/charge' description: ID of the charge that's disputed. x-expansionResources: oneOf: - $ref: '#/components/schemas/charge' created: description: >- Time at which the object was created. Measured in seconds since the Unix epoch. format: unix-time type: integer currency: description: >- 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). type: string evidence: $ref: '#/components/schemas/dispute_evidence' evidence_details: $ref: '#/components/schemas/dispute_evidence_details' id: description: Unique identifier for the object. maxLength: 5000 type: string is_charge_refundable: description: >- If true, it's still possible to refund the disputed payment. After the payment has been fully refunded, no further funds are withdrawn from your Stripe account as a result of this dispute. type: boolean livemode: description: >- Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. type: boolean metadata: additionalProperties: maxLength: 500 type: string description: >- 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. type: object object: description: >- String representing the object's type. Objects of the same type share the same value. enum: - dispute type: string payment_intent: anyOf: - maxLength: 5000 type: string - $ref: '#/components/schemas/payment_intent' description: ID of the PaymentIntent that's disputed. nullable: true x-expansionResources: oneOf: - $ref: '#/components/schemas/payment_intent' payment_method_details: $ref: '#/components/schemas/dispute_payment_method_details' reason: description: >- Reason given by cardholder for dispute. Possible values are `bank_cannot_process`, `check_returned`, `credit_not_processed`, `customer_initiated`, `debit_not_authorized`, `duplicate`, `fraudulent`, `general`, `incorrect_account_details`, `insufficient_funds`, `product_not_received`, `product_unacceptable`, `subscription_canceled`, or `unrecognized`. Learn more about [dispute reasons](https://stripe.com/docs/disputes/categories). maxLength: 5000 type: string status: description: >- Current status of dispute. Possible values are `warning_needs_response`, `warning_under_review`, `warning_closed`, `needs_response`, `under_review`, `won`, or `lost`. enum: - lost - needs_response - under_review - warning_closed - warning_needs_response - warning_under_review - won type: string required: - amount - balance_transactions - charge - created - currency - evidence - evidence_details - id - is_charge_refundable - livemode - metadata - object - reason - status title: Dispute type: object x-expandableFields: - balance_transactions - charge - evidence - evidence_details - payment_intent - payment_method_details x-resourceId: dispute dispute_evidence: description: '' properties: access_activity_log: description: >- Any server or activity logs showing proof that the customer accessed or downloaded the purchased digital product. This information should include IP addresses, corresponding timestamps, and any detailed recorded activity. maxLength: 150000 nullable: true type: string billing_address: description: The billing address provided by the customer. maxLength: 5000 nullable: true type: string cancellation_policy: anyOf: - maxLength: 5000 type: string - $ref: '#/components/schemas/file' description: >- (ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Your subscription cancellation policy, as shown to the customer. nullable: true x-expansionResources: oneOf: - $ref: '#/components/schemas/file' cancellation_policy_disclosure: description: >- An explanation of how and when the customer was shown your refund policy prior to purchase. maxLength: 150000 nullable: true type: string cancellation_rebuttal: description: >- A justification for why the customer's subscription was not canceled. maxLength: 150000 nullable: true type: string customer_communication: anyOf: - maxLength: 5000 type: string - $ref: '#/components/schemas/file' description: >- (ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Any communication with the customer that you feel is relevant to your case. Examples include emails proving that the customer received the product or service, or demonstrating their use of or satisfaction with the product or service. nullable: true x-expansionResources: oneOf: - $ref: '#/components/schemas/file' customer_email_address: description: The email address of the customer. maxLength: 5000 nullable: true type: string customer_name: description: The name of the customer. maxLength: 5000 nullable: true type: string customer_purchase_ip: description: The IP address that the customer used when making the purchase. maxLength: 5000 nullable: true type: string customer_signature: anyOf: - maxLength: 5000 type: string - $ref: '#/components/schemas/file' description: >- (ID of a [file upload](https://stripe.com/docs/guides/file-upload)) A relevant document or contract showing the customer's signature. nullable: true x-expansionResources: oneOf: - $ref: '#/components/schemas/file' duplicate_charge_documentation: anyOf: - maxLength: 5000 type: string - $ref: '#/components/schemas/file' description: >- (ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Documentation for the prior charge that can uniquely identify the charge, such as a receipt, shipping label, work order, etc. This document should be paired with a similar document from the disputed payment that proves the two payments are separate. nullable: true x-expansionResources: oneOf: - $ref: '#/components/schemas/file' duplicate_charge_explanation: description: >- An explanation of the difference between the disputed charge versus the prior charge that appears to be a duplicate. maxLength: 150000 nullable: true type: string duplicate_charge_id: description: >- The Stripe ID for the prior charge which appears to be a duplicate of the disputed charge. maxLength: 5000 nullable: true type: string product_description: description: A description of the product or service that was sold. maxLength: 150000 nullable: true type: string receipt: anyOf: - maxLength: 5000 type: string - $ref: '#/components/schemas/file' description: >- (ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Any receipt or message sent to the customer notifying them of the charge. nullable: true x-expansionResources: oneOf: - $ref: '#/components/schemas/file' refund_policy: anyOf: - maxLength: 5000 type: string - $ref: '#/components/schemas/file' description: >- (ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Your refund policy, as shown to the customer. nullable: true x-expansionResources: oneOf: - $ref: '#/components/schemas/file' refund_policy_disclosure: description: >- Documentation demonstrating that the customer was shown your refund policy prior to purchase. maxLength: 150000 nullable: true type: string refund_refusal_explanation: description: A justification for why the customer is not entitled to a refund. maxLength: 150000 nullable: true type: string service_date: description: >- The date on which the customer received or began receiving the purchased service, in a clear human-readable format. maxLength: 5000 nullable: true type: string service_documentation: anyOf: - maxLength: 5000 type: string - $ref: '#/components/schemas/file' description: >- (ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Documentation showing proof that a service was provided to the customer. This could include a copy of a signed contract, work order, or other form of written agreement. nullable: true x-expansionResources: oneOf: - $ref: '#/components/schemas/file' shipping_address: description: >- The address to which a physical product was shipped. You should try to include as complete address information as possible. maxLength: 5000 nullable: true type: string shipping_carrier: description: >- The delivery service that shipped a physical product, such as Fedex, UPS, USPS, etc. If multiple carriers were used for this purchase, please separate them with commas. maxLength: 5000 nullable: true type: string shipping_date: description: >- The date on which a physical product began its route to the shipping address, in a clear human-readable format. maxLength: 5000 nullable: true type: string shipping_documentation: anyOf: - maxLength: 5000 type: string - $ref: '#/components/schemas/file' description: >- (ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Documentation showing proof that a product was shipped to the customer at the same address the customer provided to you. This could include a copy of the shipment receipt, shipping label, etc. It should show the customer's full shipping address, if possible. nullable: true x-expansionResources: oneOf: - $ref: '#/components/schemas/file' shipping_tracking_number: description: >- 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. maxLength: 5000 nullable: true type: string uncategorized_file: anyOf: - maxLength: 5000 type: string - $ref: '#/components/schemas/file' description: >- (ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Any additional evidence or statements. nullable: true x-expansionResources: oneOf: - $ref: '#/components/schemas/file' uncategorized_text: description: Any additional evidence or statements. maxLength: 150000 nullable: true type: string title: DisputeEvidence type: object x-expandableFields: - cancellation_policy - customer_communication - customer_signature - duplicate_charge_documentation - receipt - refund_policy - service_documentation - shipping_documentation - uncategorized_file dispute_evidence_details: description: '' properties: due_by: description: >- Date by which evidence must be submitted in order to successfully challenge dispute. Will be 0 if the customer's bank or credit card company doesn't allow a response for this particular dispute. format: unix-time nullable: true type: integer has_evidence: description: Whether evidence has been staged for this dispute. type: boolean past_due: description: >- Whether the last evidence submission was submitted past the due date. Defaults to `false` if no evidence submissions have occurred. If `true`, then delivery of the latest evidence is *not* guaranteed. type: boolean submission_count: description: >- The number of times evidence has been submitted. Typically, you may only submit evidence once. type: integer required: - has_evidence - past_due - submission_count title: DisputeEvidenceDetails type: object x-expandableFields: [] dispute_payment_method_details: description: '' properties: card: $ref: '#/components/schemas/dispute_payment_method_details_card' type: description: Payment method type. enum: - card type: string x-stripeBypassValidation: true required: - type title: DisputePaymentMethodDetails type: object x-expandableFields: - card dispute_payment_method_details_card: description: '' properties: brand: description: >- Card brand. Can be `amex`, `diners`, `discover`, `eftpos_au`, `jcb`, `mastercard`, `unionpay`, `visa`, or `unknown`. maxLength: 5000 type: string network_reason_code: description: >- The card network's specific dispute reason code, which maps to one of Stripe's primary dispute categories to simplify response guidance. The [Network code map](https://stripe.com/docs/disputes/categories#network-code-map) lists all available dispute reason codes by network. maxLength: 5000 nullable: true type: string required: - brand title: DisputePaymentMethodDetailsCard type: object x-expandableFields: [] email_sent: description: '' properties: email_sent_at: description: The timestamp when the email was sent. format: unix-time type: integer email_sent_to: description: The recipient's email address. maxLength: 5000 type: string required: - email_sent_at - email_sent_to title: EmailSent type: object x-expandableFields: [] entitlements.active_entitlement: description: An active entitlement describes access to a feature for a customer. properties: feature: description: The feature that the customer is entitled to. maxLength: 5000 type: string id: description: Unique identifier for the object. maxLength: 5000 type: string livemode: description: >- Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. type: boolean lookup_key: description: >- A unique key you provide as your own system identifier. This may be up to 80 characters. maxLength: 5000 type: string object: description: >- String representing the object's type. Objects of the same type share the same value. enum: - entitlements.active_entitlement type: string required: - feature - id - livemode - lookup_key - object title: ActiveEntitlement type: object x-expandableFields: [] x-resourceId: entitlements.active_entitlement entitlements.feature: description: >- A feature represents a monetizable ability or functionality in your system. Features can be assigned to products, and when those products are purchased, Stripe will create an entitlement to the feature for the purchasing customer. properties: active: description: >- Inactive features cannot be attached to new products and will not be returned from the features list endpoint. type: boolean id: description: Unique identifier for the object. maxLength: 5000 type: string livemode: description: >- Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. type: boolean lookup_key: description: >- A unique key you provide as your own system identifier. This may be up to 80 characters. maxLength: 5000 type: string metadata: additionalProperties: maxLength: 500 type: string description: >- Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format. type: object name: description: >- The feature's name, for your own purpose, not meant to be displayable to the customer. maxLength: 80 type: string object: description: >- String representing the object's type. Objects of the same type share the same value. enum: - entitlements.feature type: string required: - active - id - livemode - lookup_key - metadata - name - object title: Feature type: object x-expandableFields: [] x-resourceId: entitlements.feature ephemeral_key: description: '' properties: created: description: >- Time at which the object was created. Measured in seconds since the Unix epoch. format: unix-time type: integer expires: description: >- Time at which the key will expire. Measured in seconds since the Unix epoch. format: unix-time type: integer id: description: Unique identifier for the object. maxLength: 5000 type: string livemode: description: >- Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. type: boolean object: description: >- String representing the object's type. Objects of the same type share the same value. enum: - ephemeral_key type: string secret: description: >- The key's secret. You can use this value to make authorized requests to the Stripe API. maxLength: 5000 type: string required: - created - expires - id - livemode - object title: EphemeralKey type: object x-expandableFields: [] x-resourceId: ephemeral_key error: description: An error response from the Stripe API properties: error: $ref: '#/components/schemas/api_errors' required: - error type: object event: description: >- Events are our way of letting you know when something interesting happens in your account. When an interesting event occurs, we create a new `Event` object. For example, when a charge succeeds, we create a `charge.succeeded` event, and when an invoice payment attempt fails, we create an `invoice.payment_failed` event. Certain API requests might create multiple events. For example, if you create a new subscription for a customer, you receive both a `customer.subscription.created` event and a `charge.succeeded` event. Events occur when the state of another API resource changes. The event's data field embeds the resource's state at the time of the change. For example, a `charge.succeeded` event contains a charge, and an `invoice.payment_failed` event contains an invoice. As with other API resources, you can use endpoints to retrieve an [individual event](https://stripe.com/docs/api#retrieve_event) or a [list of events](https://stripe.com/docs/api#list_events) from the API. We also have a separate [webhooks](http://en.wikipedia.org/wiki/Webhook) system for sending the `Event` objects directly to an endpoint on your server. You can manage webhooks in your [account settings](https://dashboard.stripe.com/account/webhooks). Learn how to [listen for events](https://stripe.com/docs/webhooks) so that your integration can automatically trigger reactions. When using [Connect](https://stripe.com/docs/connect), you can also receive event notifications that occur in connected accounts. For these events, there's an additional `account` attribute in the received `Event` object. We only guarantee access to events through the [Retrieve Event API](https://stripe.com/docs/api#retrieve_event) for 30 days. properties: account: description: The connected account that originates the event. maxLength: 5000 type: string api_version: description: >- The Stripe API version used to render `data`. This property is populated only for events on or after October 31, 2014. maxLength: 5000 nullable: true type: string created: description: >- Time at which the object was created. Measured in seconds since the Unix epoch. format: unix-time type: integer data: $ref: '#/components/schemas/notification_event_data' id: description: Unique identifier for the object. maxLength: 5000 type: string livemode: description: >- Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. type: boolean object: description: >- String representing the object's type. Objects of the same type share the same value. enum: - event type: string pending_webhooks: description: >- Number of webhooks that haven't been successfully delivered (for example, to return a 20x response) to the URLs you specify. type: integer request: anyOf: - $ref: '#/components/schemas/notification_event_request' description: Information on the API request that triggers the event. nullable: true type: description: >- Description of the event (for example, `invoice.created` or `charge.refunded`). maxLength: 5000 type: string required: - created - data - id - livemode - object - pending_webhooks - type title: NotificationEvent type: object x-expandableFields: - data - request x-resourceId: event exchange_rate: description: >- `ExchangeRate` objects allow you to determine the rates that Stripe is currently using to convert from one currency to another. Since this number is variable throughout the day, there are various reasons why you might want to know the current rate (for example, to dynamically price an item for a user with a default payment in a foreign currency). Please refer to our [Exchange Rates API](https://stripe.com/docs/fx-rates) guide for more details. *[Note: this integration path is supported but no longer recommended]* Additionally, you can guarantee that a charge is made with an exchange rate that you expect is current. To do so, you must pass in the exchange_rate to charges endpoints. If the value is no longer up to date, the charge won't go through. Please refer to our [Using with charges](https://stripe.com/docs/exchange-rates) guide for more details. -----   *This Exchange Rates API is a Beta Service and is subject to Stripe's terms of service. You may use the API solely for the purpose of transacting on Stripe. For example, the API may be queried in order to:* - *localize prices for processing payments on Stripe* - *reconcile Stripe transactions* - *determine how much money to send to a connected account* - *determine app fees to charge a connected account* *Using this Exchange Rates API beta for any purpose other than to transact on Stripe is strictly prohibited and constitutes a violation of Stripe's terms of service.* properties: id: description: >- Unique identifier for the object. Represented as the three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html) in lowercase. maxLength: 5000 type: string object: description: >- String representing the object's type. Objects of the same type share the same value. enum: - exchange_rate type: string rates: additionalProperties: type: number description: >- Hash where the keys are supported currencies and the values are the exchange rate at which the base id currency converts to the key currency. type: object required: - id - object - rates title: ExchangeRate type: object x-expandableFields: [] x-resourceId: exchange_rate external_account: anyOf: - $ref: '#/components/schemas/bank_account' - $ref: '#/components/schemas/card' title: Polymorphic x-resourceId: external_account x-stripeBypassValidation: true external_account_requirements: description: '' properties: currently_due: description: >- Fields that need to be collected to keep the external account enabled. If not collected by `current_deadline`, these fields appear in `past_due` as well, and the account is disabled. items: maxLength: 5000 type: string nullable: true type: array errors: description: >- Fields that are `currently_due` and need to be collected again because validation or verification failed. items: $ref: '#/components/schemas/account_requirements_error' nullable: true type: array past_due: description: >- Fields that weren't collected by `current_deadline`. These fields need to be collected to enable the external account. items: maxLength: 5000 type: string nullable: true type: array pending_verification: description: >- 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. items: maxLength: 5000 type: string nullable: true type: array title: ExternalAccountRequirements type: object x-expandableFields: - errors fee: description: '' properties: amount: description: 'Amount of the fee, in cents.' type: integer application: description: ID of the Connect application that earned the fee. maxLength: 5000 nullable: true type: string currency: description: >- 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). type: string description: description: >- An arbitrary string attached to the object. Often useful for displaying to users. maxLength: 5000 nullable: true type: string type: description: >- Type of the fee, one of: `application_fee`, `payment_method_passthrough_fee`, `stripe_fee` or `tax`. maxLength: 5000 type: string required: - amount - currency - type title: Fee type: object x-expandableFields: [] fee_refund: description: >- `Application Fee Refund` objects allow you to refund an application fee that has previously been created but not yet refunded. Funds will be refunded to the Stripe account from which the fee was originally collected. Related guide: [Refunding application fees](https://stripe.com/docs/connect/destination-charges#refunding-app-fee) properties: amount: description: 'Amount, in cents (or local equivalent).' type: integer balance_transaction: anyOf: - maxLength: 5000 type: string - $ref: '#/components/schemas/balance_transaction' description: >- Balance transaction that describes the impact on your account balance. nullable: true x-expansionResources: oneOf: - $ref: '#/components/schemas/balance_transaction' created: description: >- Time at which the object was created. Measured in seconds since the Unix epoch. format: unix-time type: integer currency: description: >- 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). type: string fee: anyOf: - maxLength: 5000 type: string - $ref: '#/components/schemas/application_fee' description: ID of the application fee that was refunded. x-expansionResources: oneOf: - $ref: '#/components/schemas/application_fee' id: description: Unique identifier for the object. maxLength: 5000 type: string metadata: additionalProperties: maxLength: 500 type: string description: >- 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. nullable: true type: object object: description: >- String representing the object's type. Objects of the same type share the same value. enum: - fee_refund type: string required: - amount - created - currency - fee - id - object title: FeeRefund type: object x-expandableFields: - balance_transaction - fee x-resourceId: fee_refund file: description: >- This object represents files hosted on Stripe's servers. You can upload files with the [create file](https://stripe.com/docs/api#create_file) request (for example, when uploading dispute evidence). Stripe also creates files independently (for example, the results of a [Sigma scheduled query](#scheduled_queries)). Related guide: [File upload guide](https://stripe.com/docs/file-upload) properties: created: description: >- Time at which the object was created. Measured in seconds since the Unix epoch. format: unix-time type: integer expires_at: description: The file expires and isn't available at this time in epoch seconds. format: unix-time nullable: true type: integer filename: description: The suitable name for saving the file to a filesystem. maxLength: 5000 nullable: true type: string id: description: Unique identifier for the object. maxLength: 5000 type: string links: description: >- A list of [file links](https://stripe.com/docs/api#file_links) that point at this file. nullable: true properties: data: description: Details about each object. items: $ref: '#/components/schemas/file_link' type: array has_more: description: >- True if this list has another page of items after this one that can be fetched. type: boolean object: description: >- String representing the object's type. Objects of the same type share the same value. Always has the value `list`. enum: - list type: string url: description: The URL where this list can be accessed. maxLength: 5000 pattern: ^/v1/file_links type: string required: - data - has_more - object - url title: FileResourceFileLinkList type: object x-expandableFields: - data object: description: >- String representing the object's type. Objects of the same type share the same value. enum: - file type: string purpose: description: >- The [purpose](https://stripe.com/docs/file-upload#uploading-a-file) of the uploaded file. enum: - account_requirement - additional_verification - business_icon - business_logo - customer_signature - dispute_evidence - document_provider_identity_document - finance_report_run - identity_document - identity_document_downloadable - pci_document - selfie - sigma_scheduled_query - tax_document_user_upload - terminal_reader_splashscreen type: string x-stripeBypassValidation: true size: description: The size of the file object in bytes. type: integer title: description: A suitable title for the document. maxLength: 5000 nullable: true type: string type: description: 'The returned file type (for example, `csv`, `pdf`, `jpg`, or `png`).' maxLength: 5000 nullable: true type: string url: description: Use your live secret API key to download the file from this URL. maxLength: 5000 nullable: true type: string required: - created - id - object - purpose - size title: File type: object x-expandableFields: - links x-resourceId: file file_link: description: |- To share the contents of a `File` object with non-Stripe users, you can create a `FileLink`. `FileLink`s contain a URL that you can use to retrieve the contents of the file without authentication. properties: created: description: >- Time at which the object was created. Measured in seconds since the Unix epoch. format: unix-time type: integer expired: description: Returns if the link is already expired. type: boolean expires_at: description: Time that the link expires. format: unix-time nullable: true type: integer file: anyOf: - maxLength: 5000 type: string - $ref: '#/components/schemas/file' description: The file object this link points to. x-expansionResources: oneOf: - $ref: '#/components/schemas/file' id: description: Unique identifier for the object. maxLength: 5000 type: string livemode: description: >- Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. type: boolean metadata: additionalProperties: maxLength: 500 type: string description: >- 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. type: object object: description: >- String representing the object's type. Objects of the same type share the same value. enum: - file_link type: string url: description: The publicly accessible URL to download the file. maxLength: 5000 nullable: true type: string required: - created - expired - file - id - livemode - metadata - object title: FileLink type: object x-expandableFields: - file x-resourceId: file_link financial_connections.account: description: >- A Financial Connections Account represents an account that exists outside of Stripe, to which you have been granted some degree of access. properties: account_holder: anyOf: - $ref: '#/components/schemas/bank_connections_resource_accountholder' description: The account holder that this account belongs to. nullable: true balance: anyOf: - $ref: '#/components/schemas/bank_connections_resource_balance' description: The most recent information about the account's balance. nullable: true balance_refresh: anyOf: - $ref: '#/components/schemas/bank_connections_resource_balance_refresh' description: The state of the most recent attempt to refresh the account balance. nullable: true category: description: >- The type of the account. Account category is further divided in `subcategory`. enum: - cash - credit - investment - other type: string created: description: >- Time at which the object was created. Measured in seconds since the Unix epoch. format: unix-time type: integer display_name: description: >- A human-readable name that has been assigned to this account, either by the account holder or by the institution. maxLength: 5000 nullable: true type: string id: description: Unique identifier for the object. maxLength: 5000 type: string institution_name: description: The name of the institution that holds this account. maxLength: 5000 type: string last4: description: >- The last 4 digits of the account number. If present, this will be 4 numeric characters. maxLength: 5000 nullable: true type: string livemode: description: >- Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. type: boolean object: description: >- String representing the object's type. Objects of the same type share the same value. enum: - financial_connections.account type: string ownership: anyOf: - maxLength: 5000 type: string - $ref: '#/components/schemas/financial_connections.account_ownership' description: The most recent information about the account's owners. nullable: true x-expansionResources: oneOf: - $ref: '#/components/schemas/financial_connections.account_ownership' ownership_refresh: anyOf: - $ref: '#/components/schemas/bank_connections_resource_ownership_refresh' description: The state of the most recent attempt to refresh the account owners. nullable: true permissions: description: The list of permissions granted by this account. items: enum: - balances - ownership - payment_method - transactions type: string nullable: true type: array status: description: The status of the link to the account. enum: - active - disconnected - inactive type: string subcategory: description: |- If `category` is `cash`, one of: - `checking` - `savings` - `other` If `category` is `credit`, one of: - `mortgage` - `line_of_credit` - `credit_card` - `other` If `category` is `investment` or `other`, this will be `other`. enum: - checking - credit_card - line_of_credit - mortgage - other - savings type: string subscriptions: description: The list of data refresh subscriptions requested on this account. items: enum: - transactions type: string x-stripeBypassValidation: true nullable: true type: array supported_payment_method_types: description: >- The [PaymentMethod type](https://stripe.com/docs/api/payment_methods/object#payment_method_object-type)(s) that can be created from this account. items: enum: - link - us_bank_account type: string type: array transaction_refresh: anyOf: - $ref: >- #/components/schemas/bank_connections_resource_transaction_refresh description: >- The state of the most recent attempt to refresh the account transactions. nullable: true required: - category - created - id - institution_name - livemode - object - status - subcategory - supported_payment_method_types title: BankConnectionsResourceLinkedAccount type: object x-expandableFields: - account_holder - balance - balance_refresh - ownership - ownership_refresh - transaction_refresh x-resourceId: financial_connections.account financial_connections.account_owner: description: Describes an owner of an account. properties: email: description: The email address of the owner. maxLength: 5000 nullable: true type: string id: description: Unique identifier for the object. maxLength: 5000 type: string name: description: The full name of the owner. maxLength: 5000 type: string object: description: >- String representing the object's type. Objects of the same type share the same value. enum: - financial_connections.account_owner type: string ownership: description: The ownership object that this owner belongs to. maxLength: 5000 type: string phone: description: The raw phone number of the owner. maxLength: 5000 nullable: true type: string raw_address: description: The raw physical address of the owner. maxLength: 5000 nullable: true type: string refreshed_at: description: The timestamp of the refresh that updated this owner. format: unix-time nullable: true type: integer required: - id - name - object - ownership title: BankConnectionsResourceOwner type: object x-expandableFields: [] x-resourceId: financial_connections.account_owner financial_connections.account_ownership: description: >- Describes a snapshot of the owners of an account at a particular point in time. properties: created: description: >- Time at which the object was created. Measured in seconds since the Unix epoch. format: unix-time type: integer id: description: Unique identifier for the object. maxLength: 5000 type: string object: description: >- String representing the object's type. Objects of the same type share the same value. enum: - financial_connections.account_ownership type: string owners: description: A paginated list of owners for this account. properties: data: description: Details about each object. items: $ref: '#/components/schemas/financial_connections.account_owner' type: array has_more: description: >- True if this list has another page of items after this one that can be fetched. type: boolean object: description: >- String representing the object's type. Objects of the same type share the same value. Always has the value `list`. enum: - list type: string url: description: The URL where this list can be accessed. maxLength: 5000 type: string required: - data - has_more - object - url title: BankConnectionsResourceOwnerList type: object x-expandableFields: - data required: - created - id - object - owners title: BankConnectionsResourceOwnership type: object x-expandableFields: - owners financial_connections.session: description: >- A Financial Connections Session is the secure way to programmatically launch the client-side Stripe.js modal that lets your users link their accounts. properties: account_holder: anyOf: - $ref: '#/components/schemas/bank_connections_resource_accountholder' description: The account holder for whom accounts are collected in this session. nullable: true accounts: description: The accounts that were collected as part of this Session. properties: data: description: Details about each object. items: $ref: '#/components/schemas/financial_connections.account' type: array has_more: description: >- True if this list has another page of items after this one that can be fetched. type: boolean object: description: >- String representing the object's type. Objects of the same type share the same value. Always has the value `list`. enum: - list type: string url: description: The URL where this list can be accessed. maxLength: 5000 pattern: ^/v1/financial_connections/accounts type: string required: - data - has_more - object - url title: BankConnectionsResourceLinkedAccountList type: object x-expandableFields: - data client_secret: description: >- A value that will be passed to the client to launch the authentication flow. maxLength: 5000 type: string filters: $ref: >- #/components/schemas/bank_connections_resource_link_account_session_filters id: description: Unique identifier for the object. maxLength: 5000 type: string livemode: description: >- Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. type: boolean object: description: >- String representing the object's type. Objects of the same type share the same value. enum: - financial_connections.session type: string permissions: description: Permissions requested for accounts collected during this session. items: enum: - balances - ownership - payment_method - transactions type: string x-stripeBypassValidation: true type: array prefetch: description: Data features requested to be retrieved upon account creation. items: enum: - balances - ownership - transactions type: string x-stripeBypassValidation: true nullable: true type: array return_url: description: >- For webview integrations only. Upon completing OAuth login in the native browser, the user will be redirected to this URL to return to your app. maxLength: 5000 type: string required: - accounts - client_secret - id - livemode - object - permissions title: BankConnectionsResourceLinkAccountSession type: object x-expandableFields: - account_holder - accounts - filters x-resourceId: financial_connections.session financial_connections.transaction: description: >- A Transaction represents a real transaction that affects a Financial Connections Account balance. properties: account: description: >- The ID of the Financial Connections Account this transaction belongs to. maxLength: 5000 type: string amount: description: 'The amount of this transaction, in cents (or local equivalent).' type: integer currency: description: >- 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). maxLength: 5000 type: string description: description: The description of this transaction. maxLength: 5000 type: string id: description: Unique identifier for the object. maxLength: 5000 type: string livemode: description: >- Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. type: boolean object: description: >- String representing the object's type. Objects of the same type share the same value. enum: - financial_connections.transaction type: string status: description: The status of the transaction. enum: - pending - posted - void type: string status_transitions: $ref: >- #/components/schemas/bank_connections_resource_transaction_resource_status_transitions transacted_at: description: >- Time at which the transaction was transacted. Measured in seconds since the Unix epoch. format: unix-time type: integer transaction_refresh: description: >- The token of the transaction refresh that last updated or created this transaction. maxLength: 5000 type: string updated: description: >- Time at which the object was last updated. Measured in seconds since the Unix epoch. format: unix-time type: integer required: - account - amount - currency - description - id - livemode - object - status - status_transitions - transacted_at - transaction_refresh - updated title: BankConnectionsResourceTransaction type: object x-expandableFields: - status_transitions x-resourceId: financial_connections.transaction financial_reporting_finance_report_run_run_parameters: description: '' properties: columns: description: The set of output columns requested for inclusion in the report run. items: maxLength: 5000 type: string type: array connected_account: description: Connected account ID by which to filter the report run. maxLength: 5000 type: string currency: description: Currency of objects to be included in the report run. type: string interval_end: description: >- Ending timestamp of data to be included in the report run. Can be any UTC timestamp between 1 second after the user specified `interval_start` and 1 second before this report's last `data_available_end` value. format: unix-time type: integer interval_start: description: >- Starting timestamp of data to be included in the report run. Can be any UTC timestamp between 1 second after this report's `data_available_start` and 1 second before the user specified `interval_end` value. format: unix-time type: integer payout: description: Payout ID by which to filter the report run. maxLength: 5000 type: string reporting_category: description: Category of balance transactions to be included in the report run. maxLength: 5000 type: string timezone: description: >- Defaults to `Etc/UTC`. The output timezone for all timestamps in the report. A list of possible time zone values is maintained at the [IANA Time Zone Database](http://www.iana.org/time-zones). Has no effect on `interval_start` or `interval_end`. maxLength: 5000 type: string title: FinancialReportingFinanceReportRunRunParameters type: object x-expandableFields: [] forwarded_request_context: description: Metadata about the forwarded request. properties: destination_duration: description: >- The time it took in milliseconds for the destination endpoint to respond. type: integer destination_ip_address: description: The IP address of the destination. maxLength: 5000 type: string required: - destination_duration - destination_ip_address title: ForwardedRequestContext type: object x-expandableFields: [] forwarded_request_details: description: Details about the request forwarded to the destination endpoint. properties: body: description: The body payload to send to the destination endpoint. maxLength: 5000 type: string headers: description: >- The headers to include in the forwarded request. Can be omitted if no additional headers (excluding Stripe-generated ones such as the Content-Type header) should be included. items: $ref: '#/components/schemas/forwarded_request_header' type: array http_method: description: The HTTP method used to call the destination endpoint. enum: - POST type: string required: - body - headers - http_method title: ForwardedRequestDetails type: object x-expandableFields: - headers forwarded_request_header: description: Header data. properties: name: description: The header name. maxLength: 5000 type: string value: description: The header value. maxLength: 5000 type: string required: - name - value title: ForwardedRequestHeader type: object x-expandableFields: [] forwarded_response_details: description: Details about the response from the destination endpoint. properties: body: description: The response body from the destination endpoint to Stripe. maxLength: 5000 type: string headers: description: HTTP headers that the destination endpoint returned. items: $ref: '#/components/schemas/forwarded_request_header' type: array status: description: The HTTP status code that the destination endpoint returned. type: integer required: - body - headers - status title: ForwardedResponseDetails type: object x-expandableFields: - headers forwarding.request: description: >- Instructs Stripe to make a request on your behalf using the destination URL. The destination URL is activated by Stripe at the time of onboarding. Stripe verifies requests with your credentials provided during onboarding, and injects card details from the payment_method into the request. Stripe redacts all sensitive fields and headers, including authentication credentials and card numbers, before storing the request and response data in the forwarding Request object, which are subject to a 30-day retention period. You can provide a Stripe idempotency key to make sure that requests with the same key result in only one outbound request. The Stripe idempotency key provided should be unique and different from any idempotency keys provided on the underlying third-party request. Forwarding Requests are synchronous requests that return a response or time out according to Stripe’s limits. Related guide: [Forward card details to third-party API endpoints](https://docs.stripe.com/payments/forwarding). properties: created: description: >- Time at which the object was created. Measured in seconds since the Unix epoch. format: unix-time type: integer id: description: Unique identifier for the object. maxLength: 5000 type: string livemode: description: >- Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. type: boolean object: description: >- String representing the object's type. Objects of the same type share the same value. enum: - forwarding.request type: string payment_method: description: >- The PaymentMethod to insert into the forwarded request. Forwarding previously consumed PaymentMethods is allowed. maxLength: 5000 type: string replacements: description: The field kinds to be replaced in the forwarded request. items: enum: - card_cvc - card_expiry - card_number - cardholder_name type: string type: array request_context: anyOf: - $ref: '#/components/schemas/forwarded_request_context' description: >- Context about the request from Stripe's servers to the destination endpoint. nullable: true request_details: anyOf: - $ref: '#/components/schemas/forwarded_request_details' description: >- The request that was sent to the destination endpoint. We redact any sensitive fields. nullable: true response_details: anyOf: - $ref: '#/components/schemas/forwarded_response_details' description: >- The response that the destination endpoint returned to us. We redact any sensitive fields. nullable: true url: description: >- The destination URL for the forwarded request. Must be supported by the config. maxLength: 5000 nullable: true type: string required: - created - id - livemode - object - payment_method - replacements title: ForwardingRequest type: object x-expandableFields: - request_context - request_details - response_details x-resourceId: forwarding.request funding_instructions: description: >- Each customer has a [`balance`](https://stripe.com/docs/api/customers/object#customer_object-balance) that is automatically applied to future invoices and payments using the `customer_balance` payment method. Customers can fund this balance by initiating a bank transfer to any account in the `financial_addresses` field. Related guide: [Customer balance funding instructions](https://stripe.com/docs/payments/customer-balance/funding-instructions) properties: bank_transfer: $ref: '#/components/schemas/funding_instructions_bank_transfer' currency: description: >- 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). maxLength: 5000 type: string funding_type: description: The `funding_type` of the returned instructions enum: - bank_transfer type: string livemode: description: >- Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. type: boolean object: description: >- String representing the object's type. Objects of the same type share the same value. enum: - funding_instructions type: string required: - bank_transfer - currency - funding_type - livemode - object title: CustomerBalanceFundingInstructionsCustomerBalanceFundingInstructions type: object x-expandableFields: - bank_transfer x-resourceId: funding_instructions funding_instructions_bank_transfer: description: '' properties: country: description: The country of the bank account to fund maxLength: 5000 type: string financial_addresses: description: >- A list of financial addresses that can be used to fund a particular balance items: $ref: >- #/components/schemas/funding_instructions_bank_transfer_financial_address type: array type: description: The bank_transfer type enum: - eu_bank_transfer - jp_bank_transfer type: string x-stripeBypassValidation: true required: - country - financial_addresses - type title: FundingInstructionsBankTransfer type: object x-expandableFields: - financial_addresses funding_instructions_bank_transfer_aba_record: description: ABA Records contain U.S. bank account details per the ABA format. properties: account_number: description: The ABA account number maxLength: 5000 type: string bank_name: description: The bank name maxLength: 5000 type: string routing_number: description: The ABA routing number maxLength: 5000 type: string required: - account_number - bank_name - routing_number title: FundingInstructionsBankTransferABARecord type: object x-expandableFields: [] funding_instructions_bank_transfer_financial_address: description: >- FinancialAddresses contain identifying information that resolves to a FinancialAccount. properties: aba: $ref: '#/components/schemas/funding_instructions_bank_transfer_aba_record' iban: $ref: '#/components/schemas/funding_instructions_bank_transfer_iban_record' sort_code: $ref: >- #/components/schemas/funding_instructions_bank_transfer_sort_code_record spei: $ref: '#/components/schemas/funding_instructions_bank_transfer_spei_record' supported_networks: description: The payment networks supported by this FinancialAddress items: enum: - ach - bacs - domestic_wire_us - fps - sepa - spei - swift - zengin type: string x-stripeBypassValidation: true type: array swift: $ref: '#/components/schemas/funding_instructions_bank_transfer_swift_record' type: description: The type of financial address enum: - aba - iban - sort_code - spei - swift - zengin type: string x-stripeBypassValidation: true zengin: $ref: >- #/components/schemas/funding_instructions_bank_transfer_zengin_record required: - type title: FundingInstructionsBankTransferFinancialAddress type: object x-expandableFields: - aba - iban - sort_code - spei - swift - zengin funding_instructions_bank_transfer_iban_record: description: Iban Records contain E.U. bank account details per the SEPA format. properties: account_holder_name: description: The name of the person or business that owns the bank account maxLength: 5000 type: string bic: description: The BIC/SWIFT code of the account. maxLength: 5000 type: string country: description: >- Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)). maxLength: 5000 type: string iban: description: The IBAN of the account. maxLength: 5000 type: string required: - account_holder_name - bic - country - iban title: FundingInstructionsBankTransferIbanRecord type: object x-expandableFields: [] funding_instructions_bank_transfer_sort_code_record: description: >- Sort Code Records contain U.K. bank account details per the sort code format. properties: account_holder_name: description: The name of the person or business that owns the bank account maxLength: 5000 type: string account_number: description: The account number maxLength: 5000 type: string sort_code: description: The six-digit sort code maxLength: 5000 type: string required: - account_holder_name - account_number - sort_code title: FundingInstructionsBankTransferSortCodeRecord type: object x-expandableFields: [] funding_instructions_bank_transfer_spei_record: description: SPEI Records contain Mexico bank account details per the SPEI format. properties: bank_code: description: The three-digit bank code maxLength: 5000 type: string bank_name: description: The short banking institution name maxLength: 5000 type: string clabe: description: The CLABE number maxLength: 5000 type: string required: - bank_code - bank_name - clabe title: FundingInstructionsBankTransferSpeiRecord type: object x-expandableFields: [] funding_instructions_bank_transfer_swift_record: description: SWIFT Records contain U.S. bank account details per the SWIFT format. properties: account_number: description: The account number maxLength: 5000 type: string bank_name: description: The bank name maxLength: 5000 type: string swift_code: description: The SWIFT code maxLength: 5000 type: string required: - account_number - bank_name - swift_code title: FundingInstructionsBankTransferSwiftRecord type: object x-expandableFields: [] funding_instructions_bank_transfer_zengin_record: description: Zengin Records contain Japan bank account details per the Zengin format. properties: account_holder_name: description: The account holder name maxLength: 5000 nullable: true type: string account_number: description: The account number maxLength: 5000 nullable: true type: string account_type: description: 'The bank account type. In Japan, this can only be `futsu` or `toza`.' maxLength: 5000 nullable: true type: string bank_code: description: The bank code of the account maxLength: 5000 nullable: true type: string bank_name: description: The bank name of the account maxLength: 5000 nullable: true type: string branch_code: description: The branch code of the account maxLength: 5000 nullable: true type: string branch_name: description: The branch name of the account maxLength: 5000 nullable: true type: string title: FundingInstructionsBankTransferZenginRecord type: object x-expandableFields: [] gelato_data_document_report_date_of_birth: description: Point in Time properties: day: description: Numerical day between 1 and 31. nullable: true type: integer month: description: Numerical month between 1 and 12. nullable: true type: integer year: description: The four-digit year. nullable: true type: integer title: GelatoDataDocumentReportDateOfBirth type: object x-expandableFields: [] gelato_data_document_report_expiration_date: description: Point in Time properties: day: description: Numerical day between 1 and 31. nullable: true type: integer month: description: Numerical month between 1 and 12. nullable: true type: integer year: description: The four-digit year. nullable: true type: integer title: GelatoDataDocumentReportExpirationDate type: object x-expandableFields: [] gelato_data_document_report_issued_date: description: Point in Time properties: day: description: Numerical day between 1 and 31. nullable: true type: integer month: description: Numerical month between 1 and 12. nullable: true type: integer year: description: The four-digit year. nullable: true type: integer title: GelatoDataDocumentReportIssuedDate type: object x-expandableFields: [] gelato_data_id_number_report_date: description: Point in Time properties: day: description: Numerical day between 1 and 31. nullable: true type: integer month: description: Numerical month between 1 and 12. nullable: true type: integer year: description: The four-digit year. nullable: true type: integer title: GelatoDataIdNumberReportDate type: object x-expandableFields: [] gelato_data_verified_outputs_date: description: Point in Time properties: day: description: Numerical day between 1 and 31. nullable: true type: integer month: description: Numerical month between 1 and 12. nullable: true type: integer year: description: The four-digit year. nullable: true type: integer title: GelatoDataVerifiedOutputsDate type: object x-expandableFields: [] gelato_document_report: description: Result from a document check properties: address: anyOf: - $ref: '#/components/schemas/address' description: Address as it appears in the document. nullable: true dob: anyOf: - $ref: '#/components/schemas/gelato_data_document_report_date_of_birth' description: Date of birth as it appears in the document. nullable: true error: anyOf: - $ref: '#/components/schemas/gelato_document_report_error' description: >- Details on the verification error. Present when status is `unverified`. nullable: true expiration_date: anyOf: - $ref: '#/components/schemas/gelato_data_document_report_expiration_date' description: Expiration date of the document. nullable: true files: description: >- Array of [File](https://stripe.com/docs/api/files) ids containing images for this document. items: maxLength: 5000 type: string nullable: true type: array first_name: description: First name as it appears in the document. maxLength: 5000 nullable: true type: string issued_date: anyOf: - $ref: '#/components/schemas/gelato_data_document_report_issued_date' description: Issued date of the document. nullable: true issuing_country: description: Issuing country of the document. maxLength: 5000 nullable: true type: string last_name: description: Last name as it appears in the document. maxLength: 5000 nullable: true type: string number: description: Document ID number. maxLength: 5000 nullable: true type: string status: description: Status of this `document` check. enum: - unverified - verified type: string x-stripeBypassValidation: true type: description: Type of the document. enum: - driving_license - id_card - passport nullable: true type: string required: - status title: GelatoDocumentReport type: object x-expandableFields: - address - dob - error - expiration_date - issued_date gelato_document_report_error: description: '' properties: code: description: >- A short machine-readable string giving the reason for the verification failure. enum: - document_expired - document_type_not_supported - document_unverified_other nullable: true type: string x-stripeBypassValidation: true reason: description: >- A human-readable message giving the reason for the failure. These messages can be shown to your users. maxLength: 5000 nullable: true type: string title: GelatoDocumentReportError type: object x-expandableFields: [] gelato_email_report: description: Result from a email check properties: email: description: Email to be verified. maxLength: 5000 nullable: true type: string error: anyOf: - $ref: '#/components/schemas/gelato_email_report_error' description: >- Details on the verification error. Present when status is `unverified`. nullable: true status: description: Status of this `email` check. enum: - unverified - verified type: string x-stripeBypassValidation: true required: - status title: GelatoEmailReport type: object x-expandableFields: - error gelato_email_report_error: description: '' properties: code: description: >- A short machine-readable string giving the reason for the verification failure. enum: - email_unverified_other - email_verification_declined nullable: true type: string reason: description: >- A human-readable message giving the reason for the failure. These messages can be shown to your users. maxLength: 5000 nullable: true type: string title: GelatoEmailReportError type: object x-expandableFields: [] gelato_id_number_report: description: Result from an id_number check properties: dob: anyOf: - $ref: '#/components/schemas/gelato_data_id_number_report_date' description: Date of birth. nullable: true error: anyOf: - $ref: '#/components/schemas/gelato_id_number_report_error' description: >- Details on the verification error. Present when status is `unverified`. nullable: true first_name: description: First name. maxLength: 5000 nullable: true type: string id_number: description: >- ID number. When `id_number_type` is `us_ssn`, only the last 4 digits are present. maxLength: 5000 nullable: true type: string id_number_type: description: Type of ID number. enum: - br_cpf - sg_nric - us_ssn nullable: true type: string last_name: description: Last name. maxLength: 5000 nullable: true type: string status: description: Status of this `id_number` check. enum: - unverified - verified type: string x-stripeBypassValidation: true required: - status title: GelatoIdNumberReport type: object x-expandableFields: - dob - error gelato_id_number_report_error: description: '' properties: code: description: >- A short machine-readable string giving the reason for the verification failure. enum: - id_number_insufficient_document_data - id_number_mismatch - id_number_unverified_other nullable: true type: string reason: description: >- A human-readable message giving the reason for the failure. These messages can be shown to your users. maxLength: 5000 nullable: true type: string title: GelatoIdNumberReportError type: object x-expandableFields: [] gelato_phone_report: description: Result from a phone check properties: error: anyOf: - $ref: '#/components/schemas/gelato_phone_report_error' description: >- Details on the verification error. Present when status is `unverified`. nullable: true phone: description: Phone to be verified. maxLength: 5000 nullable: true type: string status: description: Status of this `phone` check. enum: - unverified - verified type: string x-stripeBypassValidation: true required: - status title: GelatoPhoneReport type: object x-expandableFields: - error gelato_phone_report_error: description: '' properties: code: description: >- A short machine-readable string giving the reason for the verification failure. enum: - phone_unverified_other - phone_verification_declined nullable: true type: string reason: description: >- A human-readable message giving the reason for the failure. These messages can be shown to your users. maxLength: 5000 nullable: true type: string title: GelatoPhoneReportError type: object x-expandableFields: [] gelato_provided_details: description: '' properties: email: description: Email of user being verified maxLength: 5000 type: string phone: description: Phone number of user being verified maxLength: 5000 type: string title: GelatoProvidedDetails type: object x-expandableFields: [] gelato_report_document_options: description: '' properties: allowed_types: description: >- Array of strings of allowed identity document types. If the provided identity document isn’t one of the allowed types, the verification check will fail with a document_type_not_allowed error code. items: enum: - driving_license - id_card - passport type: string type: array require_id_number: description: >- Collect an ID number and perform an [ID number check](https://stripe.com/docs/identity/verification-checks?type=id-number) with the document’s extracted name and date of birth. type: boolean require_live_capture: description: >- Disable image uploads, identity document images have to be captured using the device’s camera. type: boolean require_matching_selfie: description: >- Capture a face image and perform a [selfie check](https://stripe.com/docs/identity/verification-checks?type=selfie) comparing a photo ID and a picture of your user’s face. [Learn more](https://stripe.com/docs/identity/selfie). type: boolean title: GelatoReportDocumentOptions type: object x-expandableFields: [] gelato_report_id_number_options: description: '' properties: {} title: GelatoReportIdNumberOptions type: object x-expandableFields: [] gelato_selfie_report: description: Result from a selfie check properties: document: description: >- ID of the [File](https://stripe.com/docs/api/files) holding the image of the identity document used in this check. maxLength: 5000 nullable: true type: string error: anyOf: - $ref: '#/components/schemas/gelato_selfie_report_error' description: >- Details on the verification error. Present when status is `unverified`. nullable: true selfie: description: >- ID of the [File](https://stripe.com/docs/api/files) holding the image of the selfie used in this check. maxLength: 5000 nullable: true type: string status: description: Status of this `selfie` check. enum: - unverified - verified type: string x-stripeBypassValidation: true required: - status title: GelatoSelfieReport type: object x-expandableFields: - error gelato_selfie_report_error: description: '' properties: code: description: >- A short machine-readable string giving the reason for the verification failure. enum: - selfie_document_missing_photo - selfie_face_mismatch - selfie_manipulated - selfie_unverified_other nullable: true type: string reason: description: >- A human-readable message giving the reason for the failure. These messages can be shown to your users. maxLength: 5000 nullable: true type: string title: GelatoSelfieReportError type: object x-expandableFields: [] gelato_session_document_options: description: '' properties: allowed_types: description: >- Array of strings of allowed identity document types. If the provided identity document isn’t one of the allowed types, the verification check will fail with a document_type_not_allowed error code. items: enum: - driving_license - id_card - passport type: string type: array require_id_number: description: >- Collect an ID number and perform an [ID number check](https://stripe.com/docs/identity/verification-checks?type=id-number) with the document’s extracted name and date of birth. type: boolean require_live_capture: description: >- Disable image uploads, identity document images have to be captured using the device’s camera. type: boolean require_matching_selfie: description: >- Capture a face image and perform a [selfie check](https://stripe.com/docs/identity/verification-checks?type=selfie) comparing a photo ID and a picture of your user’s face. [Learn more](https://stripe.com/docs/identity/selfie). type: boolean title: GelatoSessionDocumentOptions type: object x-expandableFields: [] gelato_session_email_options: description: '' properties: require_verification: description: Request one time password verification of `provided_details.email`. type: boolean title: GelatoSessionEmailOptions type: object x-expandableFields: [] gelato_session_id_number_options: description: '' properties: {} title: GelatoSessionIdNumberOptions type: object x-expandableFields: [] gelato_session_last_error: description: Shows last VerificationSession error properties: code: description: >- A short machine-readable string giving the reason for the verification or user-session failure. enum: - abandoned - consent_declined - country_not_supported - device_not_supported - document_expired - document_type_not_supported - document_unverified_other - email_unverified_other - email_verification_declined - id_number_insufficient_document_data - id_number_mismatch - id_number_unverified_other - phone_unverified_other - phone_verification_declined - selfie_document_missing_photo - selfie_face_mismatch - selfie_manipulated - selfie_unverified_other - under_supported_age nullable: true type: string x-stripeBypassValidation: true reason: description: >- A message that explains the reason for verification or user-session failure. maxLength: 5000 nullable: true type: string title: GelatoSessionLastError type: object x-expandableFields: [] gelato_session_phone_options: description: '' properties: require_verification: description: Request one time password verification of `provided_details.phone`. type: boolean title: GelatoSessionPhoneOptions type: object x-expandableFields: [] gelato_verification_report_options: description: '' properties: document: $ref: '#/components/schemas/gelato_report_document_options' id_number: $ref: '#/components/schemas/gelato_report_id_number_options' title: GelatoVerificationReportOptions type: object x-expandableFields: - document - id_number gelato_verification_session_options: description: '' properties: document: $ref: '#/components/schemas/gelato_session_document_options' email: $ref: '#/components/schemas/gelato_session_email_options' id_number: $ref: '#/components/schemas/gelato_session_id_number_options' phone: $ref: '#/components/schemas/gelato_session_phone_options' title: GelatoVerificationSessionOptions type: object x-expandableFields: - document - email - id_number - phone gelato_verified_outputs: description: '' properties: address: anyOf: - $ref: '#/components/schemas/address' description: The user's verified address. nullable: true dob: anyOf: - $ref: '#/components/schemas/gelato_data_verified_outputs_date' description: The user’s verified date of birth. nullable: true email: description: The user's verified email address maxLength: 5000 nullable: true type: string first_name: description: The user's verified first name. maxLength: 5000 nullable: true type: string id_number: description: The user's verified id number. maxLength: 5000 nullable: true type: string id_number_type: description: The user's verified id number type. enum: - br_cpf - sg_nric - us_ssn nullable: true type: string last_name: description: The user's verified last name. maxLength: 5000 nullable: true type: string phone: description: The user's verified phone number maxLength: 5000 nullable: true type: string title: GelatoVerifiedOutputs type: object x-expandableFields: - address - dob identity.verification_report: description: >- A VerificationReport is the result of an attempt to collect and verify data from a user. The collection of verification checks performed is determined from the `type` and `options` parameters used. You can find the result of each verification check performed in the appropriate sub-resource: `document`, `id_number`, `selfie`. Each VerificationReport contains a copy of any data collected by the user as well as reference IDs which can be used to access collected images through the [FileUpload](https://stripe.com/docs/api/files) API. To configure and create VerificationReports, use the [VerificationSession](https://stripe.com/docs/api/identity/verification_sessions) API. Related guides: [Accessing verification results](https://stripe.com/docs/identity/verification-sessions#results). properties: client_reference_id: description: >- A string to reference this user. This can be a customer ID, a session ID, or similar, and can be used to reconcile this verification with your internal systems. maxLength: 5000 nullable: true type: string created: description: >- Time at which the object was created. Measured in seconds since the Unix epoch. format: unix-time type: integer document: $ref: '#/components/schemas/gelato_document_report' email: $ref: '#/components/schemas/gelato_email_report' id: description: Unique identifier for the object. maxLength: 5000 type: string id_number: $ref: '#/components/schemas/gelato_id_number_report' livemode: description: >- Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. type: boolean object: description: >- String representing the object's type. Objects of the same type share the same value. enum: - identity.verification_report type: string options: $ref: '#/components/schemas/gelato_verification_report_options' phone: $ref: '#/components/schemas/gelato_phone_report' selfie: $ref: '#/components/schemas/gelato_selfie_report' type: description: Type of report. enum: - document - id_number - verification_flow type: string x-stripeBypassValidation: true verification_flow: description: The configuration token of a Verification Flow from the dashboard. maxLength: 5000 type: string verification_session: description: ID of the VerificationSession that created this report. maxLength: 5000 nullable: true type: string required: - created - id - livemode - object - type title: GelatoVerificationReport type: object x-expandableFields: - document - email - id_number - options - phone - selfie x-resourceId: identity.verification_report identity.verification_session: description: >- A VerificationSession guides you through the process of collecting and verifying the identities of your users. It contains details about the type of verification, such as what [verification check](/docs/identity/verification-checks) to perform. Only create one VerificationSession for each verification in your system. A VerificationSession transitions through [multiple statuses](/docs/identity/how-sessions-work) throughout its lifetime as it progresses through the verification flow. The VerificationSession contains the user's verified data after verification checks are complete. Related guide: [The Verification Sessions API](https://stripe.com/docs/identity/verification-sessions) properties: client_reference_id: description: >- A string to reference this user. This can be a customer ID, a session ID, or similar, and can be used to reconcile this verification with your internal systems. maxLength: 5000 nullable: true type: string client_secret: description: >- The short-lived client secret used by Stripe.js to [show a verification modal](https://stripe.com/docs/js/identity/modal) inside your app. This client secret expires after 24 hours and can only be used once. Don’t store it, log it, embed it in a URL, or expose it to anyone other than the user. Make sure that you have TLS enabled on any page that includes the client secret. Refer to our docs on [passing the client secret to the frontend](https://stripe.com/docs/identity/verification-sessions#client-secret) to learn more. maxLength: 5000 nullable: true type: string created: description: >- Time at which the object was created. Measured in seconds since the Unix epoch. format: unix-time type: integer id: description: Unique identifier for the object. maxLength: 5000 type: string last_error: anyOf: - $ref: '#/components/schemas/gelato_session_last_error' description: >- If present, this property tells you the last error encountered when processing the verification. nullable: true last_verification_report: anyOf: - maxLength: 5000 type: string - $ref: '#/components/schemas/identity.verification_report' description: >- ID of the most recent VerificationReport. [Learn more about accessing detailed verification results.](https://stripe.com/docs/identity/verification-sessions#results) nullable: true x-expansionResources: oneOf: - $ref: '#/components/schemas/identity.verification_report' livemode: description: >- Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. type: boolean metadata: additionalProperties: maxLength: 500 type: string description: >- 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. type: object object: description: >- String representing the object's type. Objects of the same type share the same value. enum: - identity.verification_session type: string options: anyOf: - $ref: '#/components/schemas/gelato_verification_session_options' description: A set of options for the session’s verification checks. nullable: true provided_details: anyOf: - $ref: '#/components/schemas/gelato_provided_details' description: >- Details provided about the user being verified. These details may be shown to the user. nullable: true redaction: anyOf: - $ref: '#/components/schemas/verification_session_redaction' description: >- Redaction status of this VerificationSession. If the VerificationSession is not redacted, this field will be null. nullable: true status: description: >- Status of this VerificationSession. [Learn more about the lifecycle of sessions](https://stripe.com/docs/identity/how-sessions-work). enum: - canceled - processing - requires_input - verified type: string type: description: >- The type of [verification check](https://stripe.com/docs/identity/verification-checks) to be performed. enum: - document - id_number - verification_flow type: string x-stripeBypassValidation: true url: description: >- The short-lived URL that you use to redirect a user to Stripe to submit their identity information. This URL expires after 48 hours and can only be used once. Don’t store it, log it, send it in emails or expose it to anyone other than the user. Refer to our docs on [verifying identity documents](https://stripe.com/docs/identity/verify-identity-documents?platform=web&type=redirect) to learn how to redirect users to Stripe. maxLength: 5000 nullable: true type: string verification_flow: description: The configuration token of a Verification Flow from the dashboard. maxLength: 5000 type: string verified_outputs: anyOf: - $ref: '#/components/schemas/gelato_verified_outputs' description: The user’s verified data. nullable: true required: - created - id - livemode - metadata - object - status - type title: GelatoVerificationSession type: object x-expandableFields: - last_error - last_verification_report - options - provided_details - redaction - verified_outputs x-resourceId: identity.verification_session inbound_transfers: description: '' properties: billing_details: $ref: '#/components/schemas/treasury_shared_resource_billing_details' type: description: The type of the payment method used in the InboundTransfer. enum: - us_bank_account type: string x-stripeBypassValidation: true us_bank_account: $ref: >- #/components/schemas/inbound_transfers_payment_method_details_us_bank_account required: - billing_details - type title: InboundTransfers type: object x-expandableFields: - billing_details - us_bank_account inbound_transfers_payment_method_details_us_bank_account: description: '' properties: account_holder_type: description: 'Account holder type: individual or company.' enum: - company - individual nullable: true type: string account_type: description: 'Account type: checkings or savings. Defaults to checking if omitted.' enum: - checking - savings nullable: true type: string bank_name: description: Name of the bank associated with the bank account. maxLength: 5000 nullable: true type: string fingerprint: description: >- Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same. maxLength: 5000 nullable: true type: string last4: description: Last four digits of the bank account number. maxLength: 5000 nullable: true type: string mandate: anyOf: - maxLength: 5000 type: string - $ref: '#/components/schemas/mandate' description: ID of the mandate used to make this payment. x-expansionResources: oneOf: - $ref: '#/components/schemas/mandate' network: description: >- The network rails used. See the [docs](https://stripe.com/docs/treasury/money-movement/timelines) to learn more about money movement timelines for each network type. enum: - ach type: string routing_number: description: Routing number of the bank account. maxLength: 5000 nullable: true type: string required: - network title: inbound_transfers_payment_method_details_us_bank_account type: object x-expandableFields: - mandate internal_card: description: '' properties: brand: description: Brand of the card used in the transaction maxLength: 5000 nullable: true type: string country: description: Two-letter ISO code representing the country of the card maxLength: 5000 nullable: true type: string exp_month: description: Two digit number representing the card's expiration month nullable: true type: integer exp_year: description: Two digit number representing the card's expiration year nullable: true type: integer last4: description: The last 4 digits of the card maxLength: 5000 nullable: true type: string title: internal_card type: object x-expandableFields: [] invoice: description: >- 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) properties: account_country: description: >- The country of the business associated with this invoice, most often the business creating the invoice. maxLength: 5000 nullable: true type: string account_name: description: >- The public name of the business associated with this invoice, most often the business creating the invoice. maxLength: 5000 nullable: true type: string account_tax_ids: description: >- The account tax IDs associated with the invoice. Only editable when the invoice is a draft. items: anyOf: - maxLength: 5000 type: string - $ref: '#/components/schemas/tax_id' - $ref: '#/components/schemas/deleted_tax_id' x-expansionResources: oneOf: - $ref: '#/components/schemas/tax_id' - $ref: '#/components/schemas/deleted_tax_id' nullable: true type: array amount_due: description: >- 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`. type: integer amount_paid: description: 'The amount, in cents (or local equivalent), that was paid.' type: integer amount_remaining: description: >- The difference between amount_due and amount_paid, in cents (or local equivalent). type: integer amount_shipping: description: This is the sum of all the shipping amounts. type: integer application: anyOf: - maxLength: 5000 type: string - $ref: '#/components/schemas/application' - $ref: '#/components/schemas/deleted_application' description: ID of the Connect Application that created the invoice. nullable: true x-expansionResources: oneOf: - $ref: '#/components/schemas/application' - $ref: '#/components/schemas/deleted_application' application_fee_amount: description: >- 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. nullable: true type: integer attempt_count: description: >- 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. type: integer attempted: description: >- 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. type: boolean auto_advance: description: >- 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. type: boolean automatic_tax: $ref: '#/components/schemas/automatic_tax' billing_reason: description: >- 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. enum: - automatic_pending_invoice_item_invoice - manual - quote_accept - subscription - subscription_create - subscription_cycle - subscription_threshold - subscription_update - upcoming nullable: true type: string charge: anyOf: - maxLength: 5000 type: string - $ref: '#/components/schemas/charge' description: 'ID of the latest charge generated for this invoice, if any.' nullable: true x-expansionResources: oneOf: - $ref: '#/components/schemas/charge' collection_method: description: >- 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. enum: - charge_automatically - send_invoice type: string created: description: >- Time at which the object was created. Measured in seconds since the Unix epoch. format: unix-time type: integer currency: description: >- 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). type: string custom_fields: description: Custom fields displayed on the invoice. items: $ref: '#/components/schemas/invoice_setting_custom_field' nullable: true type: array customer: anyOf: - maxLength: 5000 type: string - $ref: '#/components/schemas/customer' - $ref: '#/components/schemas/deleted_customer' description: The ID of the customer who will be billed. nullable: true x-expansionResources: oneOf: - $ref: '#/components/schemas/customer' - $ref: '#/components/schemas/deleted_customer' customer_address: anyOf: - $ref: '#/components/schemas/address' description: >- The customer's address. Until the invoice is finalized, this field will equal `customer.address`. Once the invoice is finalized, this field will no longer be updated. nullable: true customer_email: description: >- 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. maxLength: 5000 nullable: true type: string customer_name: description: >- 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. maxLength: 5000 nullable: true type: string customer_phone: description: >- 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. maxLength: 5000 nullable: true type: string customer_shipping: anyOf: - $ref: '#/components/schemas/shipping' description: >- The customer's shipping information. Until the invoice is finalized, this field will equal `customer.shipping`. Once the invoice is finalized, this field will no longer be updated. nullable: true customer_tax_exempt: description: >- 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. enum: - exempt - none - reverse nullable: true type: string customer_tax_ids: description: >- 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. items: $ref: '#/components/schemas/invoices_resource_invoice_tax_id' nullable: true type: array default_payment_method: anyOf: - maxLength: 5000 type: string - $ref: '#/components/schemas/payment_method' description: >- 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. nullable: true x-expansionResources: oneOf: - $ref: '#/components/schemas/payment_method' default_source: anyOf: - maxLength: 5000 type: string - $ref: '#/components/schemas/bank_account' - $ref: '#/components/schemas/card' - $ref: '#/components/schemas/source' description: >- 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. nullable: true x-expansionResources: oneOf: - $ref: '#/components/schemas/bank_account' - $ref: '#/components/schemas/card' - $ref: '#/components/schemas/source' x-stripeBypassValidation: true default_tax_rates: description: 'The tax rates applied to this invoice, if any.' items: $ref: '#/components/schemas/tax_rate' type: array description: description: >- An arbitrary string attached to the object. Often useful for displaying to users. Referenced as 'memo' in the Dashboard. maxLength: 5000 nullable: true type: string discount: anyOf: - $ref: '#/components/schemas/discount' description: >- Describes the current discount applied to this invoice, if there is one. Not populated if there are multiple discounts. nullable: true discounts: description: >- The discounts applied to the invoice. Line item discounts are applied before invoice discounts. Use `expand[]=discounts` to expand each discount. items: anyOf: - maxLength: 5000 type: string - $ref: '#/components/schemas/discount' - $ref: '#/components/schemas/deleted_discount' x-expansionResources: oneOf: - $ref: '#/components/schemas/discount' - $ref: '#/components/schemas/deleted_discount' type: array due_date: description: >- The date on which payment for this invoice is due. This value will be `null` for invoices where `collection_method=charge_automatically`. format: unix-time nullable: true type: integer effective_at: description: >- 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. format: unix-time nullable: true type: integer ending_balance: description: >- 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. nullable: true type: integer footer: description: Footer displayed on the invoice. maxLength: 5000 nullable: true type: string from_invoice: anyOf: - $ref: '#/components/schemas/invoices_resource_from_invoice' description: >- Details of the invoice that was cloned. See the [revision documentation](https://stripe.com/docs/invoicing/invoice-revisions) for more details. nullable: true hosted_invoice_url: description: >- 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. maxLength: 5000 nullable: true type: string id: description: >- 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. maxLength: 5000 type: string invoice_pdf: description: >- The link to download the PDF for the invoice. If the invoice has not been finalized yet, this will be null. maxLength: 5000 nullable: true type: string issuer: $ref: '#/components/schemas/connect_account_reference' last_finalization_error: anyOf: - $ref: '#/components/schemas/api_errors' description: >- The error encountered during the previous attempt to finalize the invoice. This field is cleared when the invoice is successfully finalized. nullable: true latest_revision: anyOf: - maxLength: 5000 type: string - $ref: '#/components/schemas/invoice' description: The ID of the most recent non-draft revision of this invoice nullable: true x-expansionResources: oneOf: - $ref: '#/components/schemas/invoice' lines: description: >- 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. properties: data: description: Details about each object. items: $ref: '#/components/schemas/line_item' type: array has_more: description: >- True if this list has another page of items after this one that can be fetched. type: boolean object: description: >- String representing the object's type. Objects of the same type share the same value. Always has the value `list`. enum: - list type: string url: description: The URL where this list can be accessed. maxLength: 5000 type: string required: - data - has_more - object - url title: InvoiceLinesList type: object x-expandableFields: - data livemode: description: >- Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. type: boolean metadata: additionalProperties: maxLength: 500 type: string description: >- 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. nullable: true type: object next_payment_attempt: description: >- The time at which payment will next be attempted. This value will be `null` for invoices where `collection_method=send_invoice`. format: unix-time nullable: true type: integer number: description: >- 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. maxLength: 5000 nullable: true type: string object: description: >- String representing the object's type. Objects of the same type share the same value. enum: - invoice type: string on_behalf_of: anyOf: - maxLength: 5000 type: string - $ref: '#/components/schemas/account' description: >- 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. nullable: true x-expansionResources: oneOf: - $ref: '#/components/schemas/account' paid: description: >- 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. type: boolean paid_out_of_band: description: >- Returns true if the invoice was manually marked paid, returns false if the invoice hasn't been paid yet or was paid on Stripe. type: boolean payment_intent: anyOf: - maxLength: 5000 type: string - $ref: '#/components/schemas/payment_intent' description: >- 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. nullable: true x-expansionResources: oneOf: - $ref: '#/components/schemas/payment_intent' payment_settings: $ref: '#/components/schemas/invoices_payment_settings' period_end: description: >- End of the usage period during which invoice items were added to this invoice. format: unix-time type: integer period_start: description: >- Start of the usage period during which invoice items were added to this invoice. format: unix-time type: integer post_payment_credit_notes_amount: description: >- Total amount of all post-payment credit notes issued for this invoice. type: integer pre_payment_credit_notes_amount: description: >- Total amount of all pre-payment credit notes issued for this invoice. type: integer quote: anyOf: - maxLength: 5000 type: string - $ref: '#/components/schemas/quote' description: The quote this invoice was generated from. nullable: true x-expansionResources: oneOf: - $ref: '#/components/schemas/quote' receipt_number: description: >- This is the transaction number that appears on email receipts sent for this invoice. maxLength: 5000 nullable: true type: string rendering: anyOf: - $ref: '#/components/schemas/invoices_resource_invoice_rendering' description: >- The rendering-related settings that control how the invoice is displayed on customer-facing surfaces such as PDF and Hosted Invoice Page. nullable: true shipping_cost: anyOf: - $ref: '#/components/schemas/invoices_resource_shipping_cost' description: >- The details of the cost of shipping, including the ShippingRate applied on the invoice. nullable: true shipping_details: anyOf: - $ref: '#/components/schemas/shipping' description: >- Shipping details for the invoice. The Invoice PDF will use the `shipping_details` value if it is set, otherwise the PDF will render the shipping address from the customer. nullable: true starting_balance: description: >- 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. type: integer statement_descriptor: description: >- Extra information about an invoice for the customer's credit card statement. maxLength: 5000 nullable: true type: string status: description: >- The status of the invoice, one of `draft`, `open`, `paid`, `uncollectible`, or `void`. [Learn more](https://stripe.com/docs/billing/invoices/workflow#workflow-overview) enum: - draft - open - paid - uncollectible - void nullable: true type: string x-stripeBypassValidation: true status_transitions: $ref: '#/components/schemas/invoices_resource_status_transitions' subscription: anyOf: - maxLength: 5000 type: string - $ref: '#/components/schemas/subscription' description: 'The subscription that this invoice was prepared for, if any.' nullable: true x-expansionResources: oneOf: - $ref: '#/components/schemas/subscription' subscription_details: anyOf: - $ref: '#/components/schemas/subscription_details_data' description: Details about the subscription that created this invoice. nullable: true subscription_proration_date: description: >- Only set for upcoming invoices that preview prorations. The time used to calculate prorations. type: integer subtotal: description: >- 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 type: integer subtotal_excluding_tax: description: >- 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 nullable: true type: integer tax: description: >- The amount of tax on this invoice. This is the sum of all the tax amounts on this invoice. nullable: true type: integer test_clock: anyOf: - maxLength: 5000 type: string - $ref: '#/components/schemas/test_helpers.test_clock' description: ID of the test clock this invoice belongs to. nullable: true x-expansionResources: oneOf: - $ref: '#/components/schemas/test_helpers.test_clock' threshold_reason: $ref: '#/components/schemas/invoice_threshold_reason' total: description: Total after discounts and taxes. type: integer total_discount_amounts: description: The aggregate amounts calculated per discount across all line items. items: $ref: '#/components/schemas/discounts_resource_discount_amount' nullable: true type: array total_excluding_tax: description: >- The integer amount in cents (or local equivalent) representing the total amount of the invoice including all discounts but excluding all tax. nullable: true type: integer total_tax_amounts: description: The aggregate amounts calculated per tax rate for all line items. items: $ref: '#/components/schemas/invoice_tax_amount' type: array transfer_data: anyOf: - $ref: '#/components/schemas/invoice_transfer_data' description: >- The account (if any) the payment will be attributed to for tax reporting, and where funds from the payment will be transferred to for the invoice. nullable: true webhooks_delivered_at: description: >- 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. format: unix-time nullable: true type: integer required: - amount_due - amount_paid - amount_remaining - amount_shipping - attempt_count - attempted - automatic_tax - collection_method - created - currency - default_tax_rates - discounts - issuer - lines - livemode - object - paid - paid_out_of_band - payment_settings - period_end - period_start - post_payment_credit_notes_amount - pre_payment_credit_notes_amount - starting_balance - status_transitions - subtotal - total - total_tax_amounts title: Invoice type: object x-expandableFields: - account_tax_ids - application - automatic_tax - charge - custom_fields - customer - customer_address - customer_shipping - customer_tax_ids - default_payment_method - default_source - default_tax_rates - discount - discounts - from_invoice - issuer - last_finalization_error - latest_revision - lines - on_behalf_of - payment_intent - payment_settings - quote - rendering - shipping_cost - shipping_details - status_transitions - subscription - subscription_details - test_clock - threshold_reason - total_discount_amounts - total_tax_amounts - transfer_data x-resourceId: invoice invoice_installments_card: description: '' properties: enabled: description: Whether Installments are enabled for this Invoice. nullable: true type: boolean title: invoice_installments_card type: object x-expandableFields: [] invoice_item_threshold_reason: description: '' properties: line_item_ids: description: The IDs of the line items that triggered the threshold invoice. items: maxLength: 5000 type: string type: array usage_gte: description: The quantity threshold boundary that applied to the given line item. type: integer required: - line_item_ids - usage_gte title: InvoiceItemThresholdReason type: object x-expandableFields: [] invoice_line_item_period: description: '' properties: end: description: >- The end of the period, which must be greater than or equal to the start. This value is inclusive. format: unix-time type: integer start: description: The start of the period. This value is inclusive. format: unix-time type: integer required: - end - start title: InvoiceLineItemPeriod type: object x-expandableFields: [] invoice_mandate_options_card: description: '' properties: amount: description: Amount to be charged for future payments. nullable: true type: integer amount_type: description: >- One of `fixed` or `maximum`. If `fixed`, the `amount` param refers to the exact amount to be charged in future payments. If `maximum`, the amount charged can be up to the value passed for the `amount` param. enum: - fixed - maximum nullable: true type: string description: description: >- A description of the mandate or subscription that is meant to be displayed to the customer. maxLength: 200 nullable: true type: string title: invoice_mandate_options_card type: object x-expandableFields: [] invoice_payment_method_options_acss_debit: description: '' properties: mandate_options: $ref: >- #/components/schemas/invoice_payment_method_options_acss_debit_mandate_options verification_method: description: Bank account verification method. enum: - automatic - instant - microdeposits type: string x-stripeBypassValidation: true title: invoice_payment_method_options_acss_debit type: object x-expandableFields: - mandate_options invoice_payment_method_options_acss_debit_mandate_options: description: '' properties: transaction_type: description: Transaction type of the mandate. enum: - business - personal nullable: true type: string title: invoice_payment_method_options_acss_debit_mandate_options type: object x-expandableFields: [] invoice_payment_method_options_bancontact: description: '' properties: preferred_language: description: >- Preferred language of the Bancontact authorization page that the customer is redirected to. enum: - de - en - fr - nl type: string required: - preferred_language title: invoice_payment_method_options_bancontact type: object x-expandableFields: [] invoice_payment_method_options_card: description: '' properties: installments: $ref: '#/components/schemas/invoice_installments_card' request_three_d_secure: description: >- We strongly recommend that you rely on our SCA Engine to automatically prompt your customers for authentication based on risk level and [other requirements](https://stripe.com/docs/strong-customer-authentication). However, if you wish to request 3D Secure based on logic from your own fraud engine, provide this option. Read our guide on [manually requesting 3D Secure](https://stripe.com/docs/payments/3d-secure/authentication-flow#manual-three-ds) for more information on how this configuration interacts with Radar and our SCA Engine. enum: - any - automatic - challenge nullable: true type: string title: invoice_payment_method_options_card type: object x-expandableFields: - installments invoice_payment_method_options_customer_balance: description: '' properties: bank_transfer: $ref: >- #/components/schemas/invoice_payment_method_options_customer_balance_bank_transfer funding_type: description: >- The funding method type to be used when there are not enough funds in the customer balance. Permitted values include: `bank_transfer`. enum: - bank_transfer nullable: true type: string title: invoice_payment_method_options_customer_balance type: object x-expandableFields: - bank_transfer invoice_payment_method_options_customer_balance_bank_transfer: description: '' properties: eu_bank_transfer: $ref: >- #/components/schemas/invoice_payment_method_options_customer_balance_bank_transfer_eu_bank_transfer type: description: >- The bank transfer type that can be used for funding. Permitted values include: `eu_bank_transfer`, `gb_bank_transfer`, `jp_bank_transfer`, `mx_bank_transfer`, or `us_bank_transfer`. nullable: true type: string title: invoice_payment_method_options_customer_balance_bank_transfer type: object x-expandableFields: - eu_bank_transfer invoice_payment_method_options_customer_balance_bank_transfer_eu_bank_transfer: description: '' properties: country: description: >- The desired country code of the bank account information. Permitted values include: `BE`, `DE`, `ES`, `FR`, `IE`, or `NL`. enum: - BE - DE - ES - FR - IE - NL type: string required: - country title: >- invoice_payment_method_options_customer_balance_bank_transfer_eu_bank_transfer type: object x-expandableFields: [] invoice_payment_method_options_konbini: description: '' properties: {} title: invoice_payment_method_options_konbini type: object x-expandableFields: [] invoice_payment_method_options_sepa_debit: description: '' properties: {} title: invoice_payment_method_options_sepa_debit type: object x-expandableFields: [] invoice_payment_method_options_us_bank_account: description: '' properties: financial_connections: $ref: >- #/components/schemas/invoice_payment_method_options_us_bank_account_linked_account_options verification_method: description: Bank account verification method. enum: - automatic - instant - microdeposits type: string x-stripeBypassValidation: true title: invoice_payment_method_options_us_bank_account type: object x-expandableFields: - financial_connections invoice_payment_method_options_us_bank_account_linked_account_options: description: '' properties: permissions: description: >- The list of permissions to request. The `payment_method` permission must be included. items: enum: - balances - ownership - payment_method - transactions type: string type: array prefetch: description: Data features requested to be retrieved upon account creation. items: enum: - balances - ownership - transactions type: string x-stripeBypassValidation: true nullable: true type: array title: invoice_payment_method_options_us_bank_account_linked_account_options type: object x-expandableFields: [] invoice_rendering_pdf: description: '' properties: page_size: description: >- Page size of invoice pdf. Options include a4, letter, and auto. If set to auto, page size will be switched to a4 or letter based on customer locale. enum: - a4 - auto - letter nullable: true type: string title: InvoiceRenderingPdf type: object x-expandableFields: [] invoice_setting_custom_field: description: '' properties: name: description: The name of the custom field. maxLength: 5000 type: string value: description: The value of the custom field. maxLength: 5000 type: string required: - name - value title: InvoiceSettingCustomField type: object x-expandableFields: [] invoice_setting_customer_rendering_options: description: '' properties: amount_tax_display: description: >- How line-item prices and amounts will be displayed with respect to tax on invoice PDFs. maxLength: 5000 nullable: true type: string title: InvoiceSettingCustomerRenderingOptions type: object x-expandableFields: [] invoice_setting_customer_setting: description: '' properties: custom_fields: description: Default custom fields to be displayed on invoices for this customer. items: $ref: '#/components/schemas/invoice_setting_custom_field' nullable: true type: array default_payment_method: anyOf: - maxLength: 5000 type: string - $ref: '#/components/schemas/payment_method' description: >- 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. nullable: true x-expansionResources: oneOf: - $ref: '#/components/schemas/payment_method' footer: description: Default footer to be displayed on invoices for this customer. maxLength: 5000 nullable: true type: string rendering_options: anyOf: - $ref: '#/components/schemas/invoice_setting_customer_rendering_options' description: Default options for invoice PDF rendering for this customer. nullable: true title: InvoiceSettingCustomerSetting type: object x-expandableFields: - custom_fields - default_payment_method - rendering_options invoice_setting_quote_setting: description: '' properties: days_until_due: description: >- Number of days within which a customer must pay invoices generated by this quote. This value will be `null` for quotes where `collection_method=charge_automatically`. nullable: true type: integer issuer: $ref: '#/components/schemas/connect_account_reference' required: - issuer title: InvoiceSettingQuoteSetting type: object x-expandableFields: - issuer invoice_setting_rendering_options: description: '' properties: amount_tax_display: description: >- How line-item prices and amounts will be displayed with respect to tax on invoice PDFs. maxLength: 5000 nullable: true type: string title: InvoiceSettingRenderingOptions type: object x-expandableFields: [] invoice_setting_subscription_schedule_phase_setting: description: '' properties: account_tax_ids: description: >- The account tax IDs associated with this phase of the subscription schedule. Will be set on invoices generated by this phase of the subscription schedule. items: anyOf: - maxLength: 5000 type: string - $ref: '#/components/schemas/tax_id' - $ref: '#/components/schemas/deleted_tax_id' x-expansionResources: oneOf: - $ref: '#/components/schemas/tax_id' - $ref: '#/components/schemas/deleted_tax_id' nullable: true type: array days_until_due: description: >- Number of days within which a customer must pay invoices generated by this subscription schedule. This value will be `null` for subscription schedules where `billing=charge_automatically`. nullable: true type: integer issuer: anyOf: - $ref: '#/components/schemas/connect_account_reference' description: >- The connected account that issues the invoice. The invoice is presented with the branding and support information of the specified account. nullable: true title: InvoiceSettingSubscriptionSchedulePhaseSetting type: object x-expandableFields: - account_tax_ids - issuer invoice_setting_subscription_schedule_setting: description: '' properties: account_tax_ids: description: >- The account tax IDs associated with the subscription schedule. Will be set on invoices generated by the subscription schedule. items: anyOf: - maxLength: 5000 type: string - $ref: '#/components/schemas/tax_id' - $ref: '#/components/schemas/deleted_tax_id' x-expansionResources: oneOf: - $ref: '#/components/schemas/tax_id' - $ref: '#/components/schemas/deleted_tax_id' nullable: true type: array days_until_due: description: >- Number of days within which a customer must pay invoices generated by this subscription schedule. This value will be `null` for subscription schedules where `billing=charge_automatically`. nullable: true type: integer issuer: $ref: '#/components/schemas/connect_account_reference' required: - issuer title: InvoiceSettingSubscriptionScheduleSetting type: object x-expandableFields: - account_tax_ids - issuer invoice_tax_amount: description: '' properties: amount: description: 'The amount, in cents (or local equivalent), of the tax.' type: integer inclusive: description: Whether this tax amount is inclusive or exclusive. type: boolean tax_rate: anyOf: - maxLength: 5000 type: string - $ref: '#/components/schemas/tax_rate' description: The tax rate that was applied to get this tax amount. x-expansionResources: oneOf: - $ref: '#/components/schemas/tax_rate' taxability_reason: description: >- The reasoning behind this tax, for example, if the product is tax exempt. The possible values for this field may be extended as new tax rules are supported. enum: - customer_exempt - not_collecting - not_subject_to_tax - not_supported - portion_product_exempt - portion_reduced_rated - portion_standard_rated - product_exempt - product_exempt_holiday - proportionally_rated - reduced_rated - reverse_charge - standard_rated - taxable_basis_reduced - zero_rated nullable: true type: string x-stripeBypassValidation: true taxable_amount: description: >- The amount on which tax is calculated, in cents (or local equivalent). nullable: true type: integer required: - amount - inclusive - tax_rate title: InvoiceTaxAmount type: object x-expandableFields: - tax_rate invoice_threshold_reason: description: '' properties: amount_gte: description: >- The total invoice amount threshold boundary if it triggered the threshold invoice. nullable: true type: integer item_reasons: description: Indicates which line items triggered a threshold invoice. items: $ref: '#/components/schemas/invoice_item_threshold_reason' type: array required: - item_reasons title: InvoiceThresholdReason type: object x-expandableFields: - item_reasons invoice_transfer_data: description: '' properties: amount: description: >- The amount in cents (or local equivalent) that will be transferred to the destination account when the invoice is paid. By default, the entire amount is transferred to the destination. nullable: true type: integer destination: anyOf: - maxLength: 5000 type: string - $ref: '#/components/schemas/account' description: >- The account where funds from the payment will be transferred to upon payment success. x-expansionResources: oneOf: - $ref: '#/components/schemas/account' required: - destination title: InvoiceTransferData type: object x-expandableFields: - destination invoiceitem: description: >- Invoice Items represent the component lines of an [invoice](https://stripe.com/docs/api/invoices). An invoice item is added to an invoice by creating or updating it with an `invoice` field, at which point it will be included as [an invoice line item](https://stripe.com/docs/api/invoices/line_item) within [invoice.lines](https://stripe.com/docs/api/invoices/object#invoice_object-lines). Invoice Items can be created before you are ready to actually send the invoice. This can be particularly useful when combined with a [subscription](https://stripe.com/docs/api/subscriptions). Sometimes you want to add a charge or credit to a customer, but actually charge or credit the customer’s card only at the end of a regular billing cycle. This is useful for combining several charges (to minimize per-transaction fees), or for having Stripe tabulate your usage-based billing totals. Related guides: [Integrate with the Invoicing API](https://stripe.com/docs/invoicing/integration), [Subscription Invoices](https://stripe.com/docs/billing/invoices/subscription#adding-upcoming-invoice-items). properties: amount: description: >- Amount (in the `currency` specified) of the invoice item. This should always be equal to `unit_amount * quantity`. type: integer currency: description: >- 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). type: string customer: anyOf: - maxLength: 5000 type: string - $ref: '#/components/schemas/customer' - $ref: '#/components/schemas/deleted_customer' description: >- The ID of the customer who will be billed when this invoice item is billed. x-expansionResources: oneOf: - $ref: '#/components/schemas/customer' - $ref: '#/components/schemas/deleted_customer' date: description: >- Time at which the object was created. Measured in seconds since the Unix epoch. format: unix-time type: integer description: description: >- An arbitrary string attached to the object. Often useful for displaying to users. maxLength: 5000 nullable: true type: string discountable: description: >- If true, discounts will apply to this invoice item. Always false for prorations. type: boolean discounts: description: >- The discounts which apply to the invoice item. Item discounts are applied before invoice discounts. Use `expand[]=discounts` to expand each discount. items: anyOf: - maxLength: 5000 type: string - $ref: '#/components/schemas/discount' x-expansionResources: oneOf: - $ref: '#/components/schemas/discount' nullable: true type: array id: description: Unique identifier for the object. maxLength: 5000 type: string invoice: anyOf: - maxLength: 5000 type: string - $ref: '#/components/schemas/invoice' description: The ID of the invoice this invoice item belongs to. nullable: true x-expansionResources: oneOf: - $ref: '#/components/schemas/invoice' livemode: description: >- Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. type: boolean metadata: additionalProperties: maxLength: 500 type: string description: >- 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. nullable: true type: object object: description: >- String representing the object's type. Objects of the same type share the same value. enum: - invoiceitem type: string period: $ref: '#/components/schemas/invoice_line_item_period' price: anyOf: - $ref: '#/components/schemas/price' description: The price of the invoice item. nullable: true proration: description: >- Whether the invoice item was created automatically as a proration adjustment when the customer switched plans. type: boolean quantity: description: >- Quantity of units for the invoice item. If the invoice item is a proration, the quantity of the subscription that the proration was computed for. type: integer subscription: anyOf: - maxLength: 5000 type: string - $ref: '#/components/schemas/subscription' description: >- The subscription that this invoice item has been created for, if any. nullable: true x-expansionResources: oneOf: - $ref: '#/components/schemas/subscription' subscription_item: description: >- The subscription item that this invoice item has been created for, if any. maxLength: 5000 type: string tax_rates: description: >- The tax rates which apply to the invoice item. When set, the `default_tax_rates` on the invoice do not apply to this invoice item. items: $ref: '#/components/schemas/tax_rate' nullable: true type: array test_clock: anyOf: - maxLength: 5000 type: string - $ref: '#/components/schemas/test_helpers.test_clock' description: ID of the test clock this invoice item belongs to. nullable: true x-expansionResources: oneOf: - $ref: '#/components/schemas/test_helpers.test_clock' unit_amount: description: Unit amount (in the `currency` specified) of the invoice item. nullable: true type: integer unit_amount_decimal: description: >- Same as `unit_amount`, but contains a decimal value with at most 12 decimal places. format: decimal nullable: true type: string required: - amount - currency - customer - date - discountable - id - livemode - object - period - proration - quantity title: InvoiceItem type: object x-expandableFields: - customer - discounts - invoice - period - price - subscription - tax_rates - test_clock x-resourceId: invoiceitem invoices_payment_method_options: description: '' properties: acss_debit: anyOf: - $ref: '#/components/schemas/invoice_payment_method_options_acss_debit' description: >- If paying by `acss_debit`, this sub-hash contains details about the Canadian pre-authorized debit payment method options to pass to the invoice’s PaymentIntent. nullable: true bancontact: anyOf: - $ref: '#/components/schemas/invoice_payment_method_options_bancontact' description: >- If paying by `bancontact`, this sub-hash contains details about the Bancontact payment method options to pass to the invoice’s PaymentIntent. nullable: true card: anyOf: - $ref: '#/components/schemas/invoice_payment_method_options_card' description: >- If paying by `card`, this sub-hash contains details about the Card payment method options to pass to the invoice’s PaymentIntent. nullable: true customer_balance: anyOf: - $ref: >- #/components/schemas/invoice_payment_method_options_customer_balance description: >- If paying by `customer_balance`, this sub-hash contains details about the Bank transfer payment method options to pass to the invoice’s PaymentIntent. nullable: true konbini: anyOf: - $ref: '#/components/schemas/invoice_payment_method_options_konbini' description: >- If paying by `konbini`, this sub-hash contains details about the Konbini payment method options to pass to the invoice’s PaymentIntent. nullable: true sepa_debit: anyOf: - $ref: '#/components/schemas/invoice_payment_method_options_sepa_debit' description: >- If paying by `sepa_debit`, this sub-hash contains details about the SEPA Direct Debit payment method options to pass to the invoice’s PaymentIntent. nullable: true us_bank_account: anyOf: - $ref: >- #/components/schemas/invoice_payment_method_options_us_bank_account description: >- If paying by `us_bank_account`, this sub-hash contains details about the ACH direct debit payment method options to pass to the invoice’s PaymentIntent. nullable: true title: InvoicesPaymentMethodOptions type: object x-expandableFields: - acss_debit - bancontact - card - customer_balance - konbini - sepa_debit - us_bank_account invoices_payment_settings: description: '' properties: default_mandate: description: >- ID of the mandate to be used for this invoice. It must correspond to the payment method used to pay the invoice, including the invoice's default_payment_method or default_source, if set. maxLength: 5000 nullable: true type: string payment_method_options: anyOf: - $ref: '#/components/schemas/invoices_payment_method_options' description: >- Payment-method-specific configuration to provide to the invoice’s PaymentIntent. nullable: true payment_method_types: description: >- The list of payment method types (e.g. card) to provide to the invoice’s PaymentIntent. If not set, Stripe attempts to automatically determine the types to use by looking at the invoice’s default payment method, the subscription’s default payment method, the customer’s default payment method, and your [invoice template settings](https://dashboard.stripe.com/settings/billing/invoice). items: enum: - ach_credit_transfer - ach_debit - acss_debit - au_becs_debit - bacs_debit - bancontact - boleto - card - cashapp - customer_balance - eps - fpx - giropay - grabpay - ideal - konbini - link - p24 - paynow - paypal - promptpay - sepa_debit - sofort - us_bank_account - wechat_pay type: string x-stripeBypassValidation: true nullable: true type: array title: InvoicesPaymentSettings type: object x-expandableFields: - payment_method_options invoices_resource_from_invoice: description: '' properties: action: description: The relation between this invoice and the cloned invoice maxLength: 5000 type: string invoice: anyOf: - maxLength: 5000 type: string - $ref: '#/components/schemas/invoice' description: The invoice that was cloned. x-expansionResources: oneOf: - $ref: '#/components/schemas/invoice' required: - action - invoice title: InvoicesResourceFromInvoice type: object x-expandableFields: - invoice invoices_resource_invoice_rendering: description: '' properties: amount_tax_display: description: >- How line-item prices and amounts will be displayed with respect to tax on invoice PDFs. maxLength: 5000 nullable: true type: string pdf: anyOf: - $ref: '#/components/schemas/invoice_rendering_pdf' description: Invoice pdf rendering options nullable: true title: InvoicesResourceInvoiceRendering type: object x-expandableFields: - pdf invoices_resource_invoice_tax_id: description: '' properties: type: description: >- The type of the tax ID, one of `ad_nrt`, `ar_cuit`, `eu_vat`, `bo_tin`, `br_cnpj`, `br_cpf`, `cn_tin`, `co_nit`, `cr_tin`, `do_rcn`, `ec_ruc`, `eu_oss_vat`, `pe_ruc`, `ro_tin`, `rs_pib`, `sv_nit`, `uy_ruc`, `ve_rif`, `vn_tin`, `gb_vat`, `nz_gst`, `au_abn`, `au_arn`, `in_gst`, `no_vat`, `no_voec`, `za_vat`, `ch_vat`, `mx_rfc`, `sg_uen`, `ru_inn`, `ru_kpp`, `ca_bn`, `hk_br`, `es_cif`, `tw_vat`, `th_vat`, `jp_cn`, `jp_rn`, `jp_trn`, `li_uid`, `my_itn`, `us_ein`, `kr_brn`, `ca_qst`, `ca_gst_hst`, `ca_pst_bc`, `ca_pst_mb`, `ca_pst_sk`, `my_sst`, `sg_gst`, `ae_trn`, `cl_tin`, `sa_vat`, `id_npwp`, `my_frp`, `il_vat`, `ge_vat`, `ua_vat`, `is_vat`, `bg_uic`, `hu_tin`, `si_tin`, `ke_pin`, `tr_tin`, `eg_tin`, `ph_tin`, `bh_vat`, `kz_bin`, `ng_tin`, `om_vat`, or `unknown` enum: - ad_nrt - ae_trn - ar_cuit - au_abn - au_arn - bg_uic - bh_vat - bo_tin - br_cnpj - br_cpf - ca_bn - ca_gst_hst - ca_pst_bc - ca_pst_mb - ca_pst_sk - ca_qst - ch_vat - cl_tin - cn_tin - co_nit - cr_tin - do_rcn - ec_ruc - eg_tin - es_cif - eu_oss_vat - eu_vat - gb_vat - ge_vat - hk_br - hu_tin - id_npwp - il_vat - in_gst - is_vat - jp_cn - jp_rn - jp_trn - ke_pin - kr_brn - kz_bin - li_uid - mx_rfc - my_frp - my_itn - my_sst - ng_tin - no_vat - no_voec - nz_gst - om_vat - pe_ruc - ph_tin - ro_tin - rs_pib - ru_inn - ru_kpp - sa_vat - sg_gst - sg_uen - si_tin - sv_nit - th_vat - tr_tin - tw_vat - ua_vat - unknown - us_ein - uy_ruc - ve_rif - vn_tin - za_vat type: string value: description: The value of the tax ID. maxLength: 5000 nullable: true type: string required: - type title: InvoicesResourceInvoiceTaxID type: object x-expandableFields: [] invoices_resource_line_items_credited_items: description: '' properties: invoice: description: Invoice containing the credited invoice line items maxLength: 5000 type: string invoice_line_items: description: Credited invoice line items items: maxLength: 5000 type: string type: array required: - invoice - invoice_line_items title: InvoicesResourceLineItemsCreditedItems type: object x-expandableFields: [] invoices_resource_line_items_proration_details: description: '' properties: credited_items: anyOf: - $ref: '#/components/schemas/invoices_resource_line_items_credited_items' description: >- For a credit proration `line_item`, the original debit line_items to which the credit proration applies. nullable: true title: InvoicesResourceLineItemsProrationDetails type: object x-expandableFields: - credited_items invoices_resource_shipping_cost: description: '' properties: amount_subtotal: description: Total shipping cost before any taxes are applied. type: integer amount_tax: description: >- Total tax amount applied due to shipping costs. If no tax was applied, defaults to 0. type: integer amount_total: description: Total shipping cost after taxes are applied. type: integer shipping_rate: anyOf: - maxLength: 5000 type: string - $ref: '#/components/schemas/shipping_rate' description: The ID of the ShippingRate for this invoice. nullable: true x-expansionResources: oneOf: - $ref: '#/components/schemas/shipping_rate' taxes: description: The taxes applied to the shipping rate. items: $ref: '#/components/schemas/line_items_tax_amount' type: array required: - amount_subtotal - amount_tax - amount_total title: InvoicesResourceShippingCost type: object x-expandableFields: - shipping_rate - taxes invoices_resource_status_transitions: description: '' properties: finalized_at: description: The time that the invoice draft was finalized. format: unix-time nullable: true type: integer marked_uncollectible_at: description: The time that the invoice was marked uncollectible. format: unix-time nullable: true type: integer paid_at: description: The time that the invoice was paid. format: unix-time nullable: true type: integer voided_at: description: The time that the invoice was voided. format: unix-time nullable: true type: integer title: InvoicesResourceStatusTransitions type: object x-expandableFields: [] issuing.authorization: description: >- When an [issued card](https://stripe.com/docs/issuing) is used to make a purchase, an Issuing `Authorization` object is created. [Authorizations](https://stripe.com/docs/issuing/purchases/authorizations) must be approved for the purchase to be completed successfully. Related guide: [Issued card authorizations](https://stripe.com/docs/issuing/purchases/authorizations) properties: amount: description: >- The total amount that was authorized or rejected. This amount is in `currency` and in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). `amount` should be the same as `merchant_amount`, unless `currency` and `merchant_currency` are different. type: integer amount_details: anyOf: - $ref: '#/components/schemas/issuing_authorization_amount_details' description: >- Detailed breakdown of amount components. These amounts are denominated in `currency` and in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). nullable: true approved: description: Whether the authorization has been approved. type: boolean authorization_method: description: How the card details were provided. enum: - chip - contactless - keyed_in - online - swipe type: string balance_transactions: description: List of balance transactions associated with this authorization. items: $ref: '#/components/schemas/balance_transaction' type: array card: $ref: '#/components/schemas/issuing.card' cardholder: anyOf: - maxLength: 5000 type: string - $ref: '#/components/schemas/issuing.cardholder' description: The cardholder to whom this authorization belongs. nullable: true x-expansionResources: oneOf: - $ref: '#/components/schemas/issuing.cardholder' created: description: >- Time at which the object was created. Measured in seconds since the Unix epoch. format: unix-time type: integer currency: description: >- The currency of the cardholder. This currency can be different from the currency presented at authorization and the `merchant_currency` field on this authorization. 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). type: string id: description: Unique identifier for the object. maxLength: 5000 type: string livemode: description: >- Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. type: boolean merchant_amount: description: >- The total amount that was authorized or rejected. This amount is in the `merchant_currency` and in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). `merchant_amount` should be the same as `amount`, unless `merchant_currency` and `currency` are different. type: integer merchant_currency: description: >- The local currency that was presented to the cardholder for the authorization. This currency can be different from the cardholder currency and the `currency` field on this authorization. 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). type: string merchant_data: $ref: '#/components/schemas/issuing_authorization_merchant_data' metadata: additionalProperties: maxLength: 500 type: string description: >- 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. type: object network_data: anyOf: - $ref: '#/components/schemas/issuing_authorization_network_data' description: >- Details about the authorization, such as identifiers, set by the card network. nullable: true object: description: >- String representing the object's type. Objects of the same type share the same value. enum: - issuing.authorization type: string pending_request: anyOf: - $ref: '#/components/schemas/issuing_authorization_pending_request' description: >- The pending authorization request. This field will only be non-null during an `issuing_authorization.request` webhook. nullable: true request_history: description: >- History of every time a `pending_request` authorization was approved/declined, either by you directly or by Stripe (e.g. based on your spending_controls). If the merchant changes the authorization by performing an incremental authorization, you can look at this field to see the previous requests for the authorization. This field can be helpful in determining why a given authorization was approved/declined. items: $ref: '#/components/schemas/issuing_authorization_request' type: array status: description: The current status of the authorization in its lifecycle. enum: - closed - pending - reversed type: string token: anyOf: - maxLength: 5000 type: string - $ref: '#/components/schemas/issuing.token' description: >- [Token](https://stripe.com/docs/api/issuing/tokens/object) object used for this authorization. If a network token was not used for this authorization, this field will be null. nullable: true x-expansionResources: oneOf: - $ref: '#/components/schemas/issuing.token' transactions: description: >- List of [transactions](https://stripe.com/docs/api/issuing/transactions) associated with this authorization. items: $ref: '#/components/schemas/issuing.transaction' type: array treasury: anyOf: - $ref: '#/components/schemas/issuing_authorization_treasury' description: >- [Treasury](https://stripe.com/docs/api/treasury) details related to this authorization if it was created on a [FinancialAccount](https://stripe.com/docs/api/treasury/financial_accounts). nullable: true verification_data: $ref: '#/components/schemas/issuing_authorization_verification_data' wallet: description: >- The digital wallet used for this transaction. One of `apple_pay`, `google_pay`, or `samsung_pay`. Will populate as `null` when no digital wallet was utilized. maxLength: 5000 nullable: true type: string required: - amount - approved - authorization_method - balance_transactions - card - created - currency - id - livemode - merchant_amount - merchant_currency - merchant_data - metadata - object - request_history - status - transactions - verification_data title: IssuingAuthorization type: object x-expandableFields: - amount_details - balance_transactions - card - cardholder - merchant_data - network_data - pending_request - request_history - token - transactions - treasury - verification_data x-resourceId: issuing.authorization issuing.card: description: >- You can [create physical or virtual cards](https://stripe.com/docs/issuing/cards) that are issued to cardholders. properties: brand: description: The brand of the card. maxLength: 5000 type: string cancellation_reason: description: The reason why the card was canceled. enum: - design_rejected - lost - stolen nullable: true type: string x-stripeBypassValidation: true cardholder: $ref: '#/components/schemas/issuing.cardholder' created: description: >- Time at which the object was created. Measured in seconds since the Unix epoch. format: unix-time type: integer currency: description: >- Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Supported currencies are `usd` in the US, `eur` in the EU, and `gbp` in the UK. type: string cvc: description: >- The card's CVC. For security reasons, this is only available for virtual cards, and will be omitted unless you explicitly request it with [the `expand` parameter](https://stripe.com/docs/api/expanding_objects). Additionally, it's only available via the ["Retrieve a card" endpoint](https://stripe.com/docs/api/issuing/cards/retrieve), not via "List all cards" or any other endpoint. maxLength: 5000 type: string exp_month: description: The expiration month of the card. type: integer exp_year: description: The expiration year of the card. type: integer financial_account: description: The financial account this card is attached to. maxLength: 5000 nullable: true type: string id: description: Unique identifier for the object. maxLength: 5000 type: string last4: description: The last 4 digits of the card number. maxLength: 5000 type: string livemode: description: >- Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. type: boolean metadata: additionalProperties: maxLength: 500 type: string description: >- 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. type: object number: description: >- The full unredacted card number. For security reasons, this is only available for virtual cards, and will be omitted unless you explicitly request it with [the `expand` parameter](https://stripe.com/docs/api/expanding_objects). Additionally, it's only available via the ["Retrieve a card" endpoint](https://stripe.com/docs/api/issuing/cards/retrieve), not via "List all cards" or any other endpoint. maxLength: 5000 type: string object: description: >- String representing the object's type. Objects of the same type share the same value. enum: - issuing.card type: string personalization_design: anyOf: - maxLength: 5000 type: string - $ref: '#/components/schemas/issuing.personalization_design' description: The personalization design object belonging to this card. nullable: true x-expansionResources: oneOf: - $ref: '#/components/schemas/issuing.personalization_design' replaced_by: anyOf: - maxLength: 5000 type: string - $ref: '#/components/schemas/issuing.card' description: 'The latest card that replaces this card, if any.' nullable: true x-expansionResources: oneOf: - $ref: '#/components/schemas/issuing.card' replacement_for: anyOf: - maxLength: 5000 type: string - $ref: '#/components/schemas/issuing.card' description: 'The card this card replaces, if any.' nullable: true x-expansionResources: oneOf: - $ref: '#/components/schemas/issuing.card' replacement_reason: description: The reason why the previous card needed to be replaced. enum: - damaged - expired - lost - stolen nullable: true type: string x-stripeBypassValidation: true shipping: anyOf: - $ref: '#/components/schemas/issuing_card_shipping' description: Where and how the card will be shipped. nullable: true spending_controls: $ref: '#/components/schemas/issuing_card_authorization_controls' status: description: >- Whether authorizations can be approved on this card. May be blocked from activating cards depending on past-due Cardholder requirements. Defaults to `inactive`. enum: - active - canceled - inactive type: string x-stripeBypassValidation: true type: description: The type of the card. enum: - physical - virtual type: string wallets: anyOf: - $ref: '#/components/schemas/issuing_card_wallets' description: >- Information relating to digital wallets (like Apple Pay and Google Pay). nullable: true required: - brand - cardholder - created - currency - exp_month - exp_year - id - last4 - livemode - metadata - object - spending_controls - status - type title: IssuingCard type: object x-expandableFields: - cardholder - personalization_design - replaced_by - replacement_for - shipping - spending_controls - wallets x-resourceId: issuing.card issuing.cardholder: description: >- An Issuing `Cardholder` object represents an individual or business entity who is [issued](https://stripe.com/docs/issuing) cards. Related guide: [How to create a cardholder](https://stripe.com/docs/issuing/cards#create-cardholder) properties: billing: $ref: '#/components/schemas/issuing_cardholder_address' company: anyOf: - $ref: '#/components/schemas/issuing_cardholder_company' description: Additional information about a `company` cardholder. nullable: true created: description: >- Time at which the object was created. Measured in seconds since the Unix epoch. format: unix-time type: integer email: description: The cardholder's email address. maxLength: 5000 nullable: true type: string id: description: Unique identifier for the object. maxLength: 5000 type: string individual: anyOf: - $ref: '#/components/schemas/issuing_cardholder_individual' description: Additional information about an `individual` cardholder. nullable: true livemode: description: >- Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. type: boolean metadata: additionalProperties: maxLength: 500 type: string description: >- 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. type: object name: description: The cardholder's name. This will be printed on cards issued to them. maxLength: 5000 type: string object: description: >- String representing the object's type. Objects of the same type share the same value. enum: - issuing.cardholder type: string phone_number: description: >- The cardholder's phone number. This is required for all cardholders who will be creating EU cards. See the [3D Secure documentation](https://stripe.com/docs/issuing/3d-secure#when-is-3d-secure-applied) for more details. maxLength: 5000 nullable: true type: string preferred_locales: description: >- The cardholder’s preferred locales (languages), ordered by preference. Locales can be `de`, `en`, `es`, `fr`, or `it`. This changes the language of the [3D Secure flow](https://stripe.com/docs/issuing/3d-secure) and one-time password messages sent to the cardholder. items: enum: - de - en - es - fr - it type: string nullable: true type: array requirements: $ref: '#/components/schemas/issuing_cardholder_requirements' spending_controls: anyOf: - $ref: '#/components/schemas/issuing_cardholder_authorization_controls' description: >- Rules that control spending across this cardholder's cards. Refer to our [documentation](https://stripe.com/docs/issuing/controls/spending-controls) for more details. nullable: true status: description: >- Specifies whether to permit authorizations on this cardholder's cards. enum: - active - blocked - inactive type: string type: description: >- One of `individual` or `company`. See [Choose a cardholder type](https://stripe.com/docs/issuing/other/choose-cardholder) for more details. enum: - company - individual type: string x-stripeBypassValidation: true required: - billing - created - id - livemode - metadata - name - object - requirements - status - type title: IssuingCardholder type: object x-expandableFields: - billing - company - individual - requirements - spending_controls x-resourceId: issuing.cardholder issuing.dispute: description: >- As a [card issuer](https://stripe.com/docs/issuing), you can dispute transactions that the cardholder does not recognize, suspects to be fraudulent, or has other issues with. Related guide: [Issuing disputes](https://stripe.com/docs/issuing/purchases/disputes) properties: amount: description: >- Disputed amount in the card's currency and in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). Usually the amount of the `transaction`, but can differ (usually because of currency fluctuation). type: integer balance_transactions: description: List of balance transactions associated with the dispute. items: $ref: '#/components/schemas/balance_transaction' nullable: true type: array created: description: >- Time at which the object was created. Measured in seconds since the Unix epoch. format: unix-time type: integer currency: description: The currency the `transaction` was made in. type: string evidence: $ref: '#/components/schemas/issuing_dispute_evidence' id: description: Unique identifier for the object. maxLength: 5000 type: string livemode: description: >- Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. type: boolean metadata: additionalProperties: maxLength: 500 type: string description: >- 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. type: object object: description: >- String representing the object's type. Objects of the same type share the same value. enum: - issuing.dispute type: string status: description: Current status of the dispute. enum: - expired - lost - submitted - unsubmitted - won type: string transaction: anyOf: - maxLength: 5000 type: string - $ref: '#/components/schemas/issuing.transaction' description: The transaction being disputed. x-expansionResources: oneOf: - $ref: '#/components/schemas/issuing.transaction' treasury: anyOf: - $ref: '#/components/schemas/issuing_dispute_treasury' description: >- [Treasury](https://stripe.com/docs/api/treasury) details related to this dispute if it was created on a [FinancialAccount](/docs/api/treasury/financial_accounts nullable: true required: - amount - created - currency - evidence - id - livemode - metadata - object - status - transaction title: IssuingDispute type: object x-expandableFields: - balance_transactions - evidence - transaction - treasury x-resourceId: issuing.dispute issuing.personalization_design: description: >- A Personalization Design is a logical grouping of a Physical Bundle, card logo, and carrier text that represents a product line. properties: card_logo: anyOf: - maxLength: 5000 type: string - $ref: '#/components/schemas/file' description: >- The file for the card logo to use with physical bundles that support card logos. Must have a `purpose` value of `issuing_logo`. nullable: true x-expansionResources: oneOf: - $ref: '#/components/schemas/file' carrier_text: anyOf: - $ref: '#/components/schemas/issuing_personalization_design_carrier_text' description: >- Hash containing carrier text, for use with physical bundles that support carrier text. nullable: true created: description: >- Time at which the object was created. Measured in seconds since the Unix epoch. format: unix-time type: integer id: description: Unique identifier for the object. maxLength: 5000 type: string livemode: description: >- Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. type: boolean lookup_key: description: >- A lookup key used to retrieve personalization designs dynamically from a static string. This may be up to 200 characters. maxLength: 5000 nullable: true type: string metadata: additionalProperties: maxLength: 500 type: string description: >- 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. type: object name: description: Friendly display name. maxLength: 5000 nullable: true type: string object: description: >- String representing the object's type. Objects of the same type share the same value. enum: - issuing.personalization_design type: string physical_bundle: anyOf: - maxLength: 5000 type: string - $ref: '#/components/schemas/issuing.physical_bundle' description: The physical bundle object belonging to this personalization design. x-expansionResources: oneOf: - $ref: '#/components/schemas/issuing.physical_bundle' preferences: $ref: '#/components/schemas/issuing_personalization_design_preferences' rejection_reasons: $ref: >- #/components/schemas/issuing_personalization_design_rejection_reasons status: description: Whether this personalization design can be used to create cards. enum: - active - inactive - rejected - review type: string required: - created - id - livemode - metadata - object - physical_bundle - preferences - rejection_reasons - status title: IssuingPersonalizationDesign type: object x-expandableFields: - card_logo - carrier_text - physical_bundle - preferences - rejection_reasons x-resourceId: issuing.personalization_design issuing.physical_bundle: description: >- A Physical Bundle represents the bundle of physical items - card stock, carrier letter, and envelope - that is shipped to a cardholder when you create a physical card. properties: features: $ref: '#/components/schemas/issuing_physical_bundle_features' id: description: Unique identifier for the object. maxLength: 5000 type: string livemode: description: >- Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. type: boolean name: description: Friendly display name. maxLength: 5000 type: string object: description: >- String representing the object's type. Objects of the same type share the same value. enum: - issuing.physical_bundle type: string status: description: Whether this physical bundle can be used to create cards. enum: - active - inactive - review type: string type: description: >- Whether this physical bundle is a standard Stripe offering or custom-made for you. enum: - custom - standard type: string required: - id - livemode - name - object - status - type title: IssuingPhysicalBundle type: object x-expandableFields: - features x-resourceId: issuing.physical_bundle issuing.settlement: description: >- When a non-stripe BIN is used, any use of an [issued card](https://stripe.com/docs/issuing) must be settled directly with the card network. The net amount owed is represented by an Issuing `Settlement` object. properties: bin: description: The Bank Identification Number reflecting this settlement record. maxLength: 5000 type: string clearing_date: description: >- The date that the transactions are cleared and posted to user's accounts. type: integer created: description: >- Time at which the object was created. Measured in seconds since the Unix epoch. format: unix-time type: integer currency: description: >- 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). type: string id: description: Unique identifier for the object. maxLength: 5000 type: string interchange_fees: description: >- The total interchange received as reimbursement for the transactions. type: integer livemode: description: >- Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. type: boolean metadata: additionalProperties: maxLength: 500 type: string description: >- 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. type: object net_total: description: The total net amount required to settle with the network. type: integer network: description: 'The card network for this settlement report. One of ["visa"]' enum: - visa type: string network_fees: description: The total amount of fees owed to the network. type: integer network_settlement_identifier: description: The Settlement Identification Number assigned by the network. maxLength: 5000 type: string object: description: >- String representing the object's type. Objects of the same type share the same value. enum: - issuing.settlement type: string settlement_service: description: One of `international` or `uk_national_net`. maxLength: 5000 type: string transaction_count: description: The total number of transactions reflected in this settlement. type: integer transaction_volume: description: The total transaction amount reflected in this settlement. type: integer required: - bin - clearing_date - created - currency - id - interchange_fees - livemode - metadata - net_total - network - network_fees - network_settlement_identifier - object - settlement_service - transaction_count - transaction_volume title: IssuingSettlement type: object x-expandableFields: [] x-resourceId: issuing.settlement issuing.token: description: >- An issuing token object is created when an issued card is added to a digital wallet. As a [card issuer](https://stripe.com/docs/issuing), you can [view and manage these tokens](https://stripe.com/docs/issuing/controls/token-management) through Stripe. properties: card: anyOf: - maxLength: 5000 type: string - $ref: '#/components/schemas/issuing.card' description: Card associated with this token. x-expansionResources: oneOf: - $ref: '#/components/schemas/issuing.card' created: description: >- Time at which the object was created. Measured in seconds since the Unix epoch. format: unix-time type: integer device_fingerprint: description: >- The hashed ID derived from the device ID from the card network associated with the token. maxLength: 5000 nullable: true type: string id: description: Unique identifier for the object. maxLength: 5000 type: string last4: description: The last four digits of the token. maxLength: 5000 type: string livemode: description: >- Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. type: boolean network: description: The token service provider / card network associated with the token. enum: - mastercard - visa type: string network_data: $ref: '#/components/schemas/issuing_network_token_network_data' network_updated_at: description: >- Time at which the token was last updated by the card network. Measured in seconds since the Unix epoch. format: unix-time type: integer object: description: >- String representing the object's type. Objects of the same type share the same value. enum: - issuing.token type: string status: description: The usage state of the token. enum: - active - deleted - requested - suspended type: string wallet_provider: description: 'The digital wallet for this token, if one was used.' enum: - apple_pay - google_pay - samsung_pay type: string required: - card - created - id - livemode - network - network_updated_at - object - status title: IssuingNetworkToken type: object x-expandableFields: - card - network_data x-resourceId: issuing.token issuing.transaction: description: >- Any use of an [issued card](https://stripe.com/docs/issuing) that results in funds entering or leaving your Stripe account, such as a completed purchase or refund, is represented by an Issuing `Transaction` object. Related guide: [Issued card transactions](https://stripe.com/docs/issuing/purchases/transactions) properties: amount: description: >- The transaction amount, which will be reflected in your balance. This amount is in your currency and in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). type: integer amount_details: anyOf: - $ref: '#/components/schemas/issuing_transaction_amount_details' description: >- Detailed breakdown of amount components. These amounts are denominated in `currency` and in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). nullable: true authorization: anyOf: - maxLength: 5000 type: string - $ref: '#/components/schemas/issuing.authorization' description: The `Authorization` object that led to this transaction. nullable: true x-expansionResources: oneOf: - $ref: '#/components/schemas/issuing.authorization' balance_transaction: anyOf: - maxLength: 5000 type: string - $ref: '#/components/schemas/balance_transaction' description: >- ID of the [balance transaction](https://stripe.com/docs/api/balance_transactions) associated with this transaction. nullable: true x-expansionResources: oneOf: - $ref: '#/components/schemas/balance_transaction' card: anyOf: - maxLength: 5000 type: string - $ref: '#/components/schemas/issuing.card' description: The card used to make this transaction. x-expansionResources: oneOf: - $ref: '#/components/schemas/issuing.card' cardholder: anyOf: - maxLength: 5000 type: string - $ref: '#/components/schemas/issuing.cardholder' description: The cardholder to whom this transaction belongs. nullable: true x-expansionResources: oneOf: - $ref: '#/components/schemas/issuing.cardholder' created: description: >- Time at which the object was created. Measured in seconds since the Unix epoch. format: unix-time type: integer currency: description: >- 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). type: string dispute: anyOf: - maxLength: 5000 type: string - $ref: '#/components/schemas/issuing.dispute' description: 'If you''ve disputed the transaction, the ID of the dispute.' nullable: true x-expansionResources: oneOf: - $ref: '#/components/schemas/issuing.dispute' id: description: Unique identifier for the object. maxLength: 5000 type: string livemode: description: >- Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. type: boolean merchant_amount: description: >- The amount that the merchant will receive, denominated in `merchant_currency` and in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). It will be different from `amount` if the merchant is taking payment in a different currency. type: integer merchant_currency: description: The currency with which the merchant is taking payment. type: string merchant_data: $ref: '#/components/schemas/issuing_authorization_merchant_data' metadata: additionalProperties: maxLength: 500 type: string description: >- 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. type: object network_data: anyOf: - $ref: '#/components/schemas/issuing_transaction_network_data' description: >- Details about the transaction, such as processing dates, set by the card network. nullable: true object: description: >- String representing the object's type. Objects of the same type share the same value. enum: - issuing.transaction type: string purchase_details: anyOf: - $ref: '#/components/schemas/issuing_transaction_purchase_details' description: >- Additional purchase information that is optionally provided by the merchant. nullable: true token: anyOf: - maxLength: 5000 type: string - $ref: '#/components/schemas/issuing.token' description: >- [Token](https://stripe.com/docs/api/issuing/tokens/object) object used for this transaction. If a network token was not used for this transaction, this field will be null. nullable: true x-expansionResources: oneOf: - $ref: '#/components/schemas/issuing.token' treasury: anyOf: - $ref: '#/components/schemas/issuing_transaction_treasury' description: >- [Treasury](https://stripe.com/docs/api/treasury) details related to this transaction if it was created on a [FinancialAccount](/docs/api/treasury/financial_accounts nullable: true type: description: The nature of the transaction. enum: - capture - refund type: string x-stripeBypassValidation: true wallet: description: >- The digital wallet used for this transaction. One of `apple_pay`, `google_pay`, or `samsung_pay`. enum: - apple_pay - google_pay - samsung_pay nullable: true type: string required: - amount - card - created - currency - id - livemode - merchant_amount - merchant_currency - merchant_data - metadata - object - type title: IssuingTransaction type: object x-expandableFields: - amount_details - authorization - balance_transaction - card - cardholder - dispute - merchant_data - network_data - purchase_details - token - treasury x-resourceId: issuing.transaction issuing_authorization_amount_details: description: '' properties: atm_fee: description: The fee charged by the ATM for the cash withdrawal. nullable: true type: integer cashback_amount: description: The amount of cash requested by the cardholder. nullable: true type: integer title: IssuingAuthorizationAmountDetails type: object x-expandableFields: [] issuing_authorization_authentication_exemption: description: '' properties: claimed_by: description: >- The entity that requested the exemption, either the acquiring merchant or the Issuing user. enum: - acquirer - issuer type: string type: description: The specific exemption claimed for this authorization. enum: - low_value_transaction - transaction_risk_analysis - unknown type: string x-stripeBypassValidation: true required: - claimed_by - type title: IssuingAuthorizationAuthenticationExemption type: object x-expandableFields: [] issuing_authorization_merchant_data: description: '' properties: category: description: >- A categorization of the seller's type of business. See our [merchant categories guide](https://stripe.com/docs/issuing/merchant-categories) for a list of possible values. maxLength: 5000 type: string category_code: description: The merchant category code for the seller’s business maxLength: 5000 type: string city: description: City where the seller is located maxLength: 5000 nullable: true type: string country: description: Country where the seller is located maxLength: 5000 nullable: true type: string name: description: Name of the seller maxLength: 5000 nullable: true type: string network_id: description: >- Identifier assigned to the seller by the card network. Different card networks may assign different network_id fields to the same merchant. maxLength: 5000 type: string postal_code: description: Postal code where the seller is located maxLength: 5000 nullable: true type: string state: description: State where the seller is located maxLength: 5000 nullable: true type: string terminal_id: description: An ID assigned by the seller to the location of the sale. maxLength: 5000 nullable: true type: string url: description: URL provided by the merchant on a 3DS request maxLength: 5000 nullable: true type: string required: - category - category_code - network_id title: IssuingAuthorizationMerchantData type: object x-expandableFields: [] issuing_authorization_network_data: description: '' properties: acquiring_institution_id: description: >- Identifier assigned to the acquirer by the card network. Sometimes this value is not provided by the network; in this case, the value will be `null`. maxLength: 5000 nullable: true type: string system_trace_audit_number: description: >- The System Trace Audit Number (STAN) is a 6-digit identifier assigned by the acquirer. Prefer `network_data.transaction_id` if present, unless you have special requirements. maxLength: 5000 nullable: true type: string transaction_id: description: >- Unique identifier for the authorization assigned by the card network used to match subsequent messages, disputes, and transactions. maxLength: 5000 nullable: true type: string title: IssuingAuthorizationNetworkData type: object x-expandableFields: [] issuing_authorization_pending_request: description: '' properties: amount: description: >- The additional amount Stripe will hold if the authorization is approved, in the card's [currency](https://stripe.com/docs/api#issuing_authorization_object-pending-request-currency) and in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). type: integer amount_details: anyOf: - $ref: '#/components/schemas/issuing_authorization_amount_details' description: >- Detailed breakdown of amount components. These amounts are denominated in `currency` and in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). nullable: true currency: description: >- 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). type: string is_amount_controllable: description: >- If set `true`, you may provide [amount](https://stripe.com/docs/api/issuing/authorizations/approve#approve_issuing_authorization-amount) to control how much to hold for the authorization. type: boolean merchant_amount: description: >- The amount the merchant is requesting to be authorized in the `merchant_currency`. The amount is in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). type: integer merchant_currency: description: The local currency the merchant is requesting to authorize. type: string network_risk_score: description: >- The card network's estimate of the likelihood that an authorization is fraudulent. Takes on values between 1 and 99. nullable: true type: integer required: - amount - currency - is_amount_controllable - merchant_amount - merchant_currency title: IssuingAuthorizationPendingRequest type: object x-expandableFields: - amount_details issuing_authorization_request: description: '' properties: amount: description: >- The `pending_request.amount` at the time of the request, presented in your card's currency and in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). Stripe held this amount from your account to fund the authorization if the request was approved. type: integer amount_details: anyOf: - $ref: '#/components/schemas/issuing_authorization_amount_details' description: >- Detailed breakdown of amount components. These amounts are denominated in `currency` and in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). nullable: true approved: description: Whether this request was approved. type: boolean authorization_code: description: >- A code created by Stripe which is shared with the merchant to validate the authorization. This field will be populated if the authorization message was approved. The code typically starts with the letter "S", followed by a six-digit number. For example, "S498162". Please note that the code is not guaranteed to be unique across authorizations. maxLength: 5000 nullable: true type: string created: description: >- Time at which the object was created. Measured in seconds since the Unix epoch. format: unix-time type: integer currency: description: >- 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). maxLength: 5000 type: string merchant_amount: description: >- The `pending_request.merchant_amount` at the time of the request, presented in the `merchant_currency` and in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). type: integer merchant_currency: description: >- The currency that was collected by the merchant and presented to the cardholder for the authorization. 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). maxLength: 5000 type: string network_risk_score: description: >- The card network's estimate of the likelihood that an authorization is fraudulent. Takes on values between 1 and 99. nullable: true type: integer reason: description: >- When an authorization is approved or declined by you or by Stripe, this field provides additional detail on the reason for the outcome. enum: - account_disabled - card_active - card_inactive - cardholder_inactive - cardholder_verification_required - insufficient_funds - not_allowed - spending_controls - suspected_fraud - verification_failed - webhook_approved - webhook_declined - webhook_error - webhook_timeout type: string x-stripeBypassValidation: true reason_message: description: >- If the `request_history.reason` is `webhook_error` because the direct webhook response is invalid (for example, parsing errors or missing parameters), we surface a more detailed error message via this field. maxLength: 5000 nullable: true type: string requested_at: description: >- Time when the card network received an authorization request from the acquirer in UTC. Referred to by networks as transmission time. format: unix-time nullable: true type: integer required: - amount - approved - created - currency - merchant_amount - merchant_currency - reason title: IssuingAuthorizationRequest type: object x-expandableFields: - amount_details issuing_authorization_three_d_secure: description: '' properties: result: description: The outcome of the 3D Secure authentication request. enum: - attempt_acknowledged - authenticated - failed - required type: string x-stripeBypassValidation: true required: - result title: IssuingAuthorizationThreeDSecure type: object x-expandableFields: [] issuing_authorization_treasury: description: '' properties: received_credits: description: >- The array of [ReceivedCredits](https://stripe.com/docs/api/treasury/received_credits) associated with this authorization items: maxLength: 5000 type: string type: array received_debits: description: >- The array of [ReceivedDebits](https://stripe.com/docs/api/treasury/received_debits) associated with this authorization items: maxLength: 5000 type: string type: array transaction: description: >- The Treasury [Transaction](https://stripe.com/docs/api/treasury/transactions) associated with this authorization maxLength: 5000 nullable: true type: string required: - received_credits - received_debits title: IssuingAuthorizationTreasury type: object x-expandableFields: [] issuing_authorization_verification_data: description: '' properties: address_line1_check: description: >- Whether the cardholder provided an address first line and if it matched the cardholder’s `billing.address.line1`. enum: - match - mismatch - not_provided type: string address_postal_code_check: description: >- Whether the cardholder provided a postal code and if it matched the cardholder’s `billing.address.postal_code`. enum: - match - mismatch - not_provided type: string authentication_exemption: anyOf: - $ref: >- #/components/schemas/issuing_authorization_authentication_exemption description: The exemption applied to this authorization. nullable: true cvc_check: description: >- Whether the cardholder provided a CVC and if it matched Stripe’s record. enum: - match - mismatch - not_provided type: string expiry_check: description: >- Whether the cardholder provided an expiry date and if it matched Stripe’s record. enum: - match - mismatch - not_provided type: string postal_code: description: >- The postal code submitted as part of the authorization used for postal code verification. maxLength: 5000 nullable: true type: string three_d_secure: anyOf: - $ref: '#/components/schemas/issuing_authorization_three_d_secure' description: 3D Secure details. nullable: true required: - address_line1_check - address_postal_code_check - cvc_check - expiry_check title: IssuingAuthorizationVerificationData type: object x-expandableFields: - authentication_exemption - three_d_secure issuing_card_apple_pay: description: '' properties: eligible: description: Apple Pay Eligibility type: boolean ineligible_reason: description: Reason the card is ineligible for Apple Pay enum: - missing_agreement - missing_cardholder_contact - unsupported_region nullable: true type: string required: - eligible title: IssuingCardApplePay type: object x-expandableFields: [] issuing_card_authorization_controls: description: '' properties: allowed_categories: description: >- Array of strings containing [categories](https://stripe.com/docs/api#issuing_authorization_object-merchant_data-category) of authorizations to allow. All other categories will be blocked. Cannot be set with `blocked_categories`. items: enum: - ac_refrigeration_repair - accounting_bookkeeping_services - advertising_services - agricultural_cooperative - airlines_air_carriers - airports_flying_fields - ambulance_services - amusement_parks_carnivals - antique_reproductions - antique_shops - aquariums - architectural_surveying_services - art_dealers_and_galleries - artists_supply_and_craft_shops - auto_and_home_supply_stores - auto_body_repair_shops - auto_paint_shops - auto_service_shops - automated_cash_disburse - automated_fuel_dispensers - automobile_associations - automotive_parts_and_accessories_stores - automotive_tire_stores - bail_and_bond_payments - bakeries - bands_orchestras - barber_and_beauty_shops - betting_casino_gambling - bicycle_shops - billiard_pool_establishments - boat_dealers - boat_rentals_and_leases - book_stores - books_periodicals_and_newspapers - bowling_alleys - bus_lines - business_secretarial_schools - buying_shopping_services - cable_satellite_and_other_pay_television_and_radio - camera_and_photographic_supply_stores - candy_nut_and_confectionery_stores - car_and_truck_dealers_new_used - car_and_truck_dealers_used_only - car_rental_agencies - car_washes - carpentry_services - carpet_upholstery_cleaning - caterers - charitable_and_social_service_organizations_fundraising - chemicals_and_allied_products - child_care_services - childrens_and_infants_wear_stores - chiropodists_podiatrists - chiropractors - cigar_stores_and_stands - civic_social_fraternal_associations - cleaning_and_maintenance - clothing_rental - colleges_universities - commercial_equipment - commercial_footwear - commercial_photography_art_and_graphics - commuter_transport_and_ferries - computer_network_services - computer_programming - computer_repair - computer_software_stores - computers_peripherals_and_software - concrete_work_services - construction_materials - consulting_public_relations - correspondence_schools - cosmetic_stores - counseling_services - country_clubs - courier_services - court_costs - credit_reporting_agencies - cruise_lines - dairy_products_stores - dance_hall_studios_schools - dating_escort_services - dentists_orthodontists - department_stores - detective_agencies - digital_goods_applications - digital_goods_games - digital_goods_large_volume - digital_goods_media - direct_marketing_catalog_merchant - direct_marketing_combination_catalog_and_retail_merchant - direct_marketing_inbound_telemarketing - direct_marketing_insurance_services - direct_marketing_other - direct_marketing_outbound_telemarketing - direct_marketing_subscription - direct_marketing_travel - discount_stores - doctors - door_to_door_sales - drapery_window_covering_and_upholstery_stores - drinking_places - drug_stores_and_pharmacies - drugs_drug_proprietaries_and_druggist_sundries - dry_cleaners - durable_goods - duty_free_stores - eating_places_restaurants - educational_services - electric_razor_stores - electric_vehicle_charging - electrical_parts_and_equipment - electrical_services - electronics_repair_shops - electronics_stores - elementary_secondary_schools - emergency_services_gcas_visa_use_only - employment_temp_agencies - equipment_rental - exterminating_services - family_clothing_stores - fast_food_restaurants - financial_institutions - fines_government_administrative_entities - fireplace_fireplace_screens_and_accessories_stores - floor_covering_stores - florists - florists_supplies_nursery_stock_and_flowers - freezer_and_locker_meat_provisioners - fuel_dealers_non_automotive - funeral_services_crematories - >- furniture_home_furnishings_and_equipment_stores_except_appliances - furniture_repair_refinishing - furriers_and_fur_shops - general_services - gift_card_novelty_and_souvenir_shops - glass_paint_and_wallpaper_stores - glassware_crystal_stores - golf_courses_public - government_licensed_horse_dog_racing_us_region_only - >- government_licensed_online_casions_online_gambling_us_region_only - government_owned_lotteries_non_us_region - government_owned_lotteries_us_region_only - government_services - grocery_stores_supermarkets - hardware_equipment_and_supplies - hardware_stores - health_and_beauty_spas - hearing_aids_sales_and_supplies - heating_plumbing_a_c - hobby_toy_and_game_shops - home_supply_warehouse_stores - hospitals - hotels_motels_and_resorts - household_appliance_stores - industrial_supplies - information_retrieval_services - insurance_default - insurance_underwriting_premiums - intra_company_purchases - jewelry_stores_watches_clocks_and_silverware_stores - landscaping_services - laundries - laundry_cleaning_services - legal_services_attorneys - luggage_and_leather_goods_stores - lumber_building_materials_stores - manual_cash_disburse - marinas_service_and_supplies - marketplaces - masonry_stonework_and_plaster - massage_parlors - medical_and_dental_labs - medical_dental_ophthalmic_and_hospital_equipment_and_supplies - medical_services - membership_organizations - mens_and_boys_clothing_and_accessories_stores - mens_womens_clothing_stores - metal_service_centers - miscellaneous - miscellaneous_apparel_and_accessory_shops - miscellaneous_auto_dealers - miscellaneous_business_services - miscellaneous_food_stores - miscellaneous_general_merchandise - miscellaneous_general_services - miscellaneous_home_furnishing_specialty_stores - miscellaneous_publishing_and_printing - miscellaneous_recreation_services - miscellaneous_repair_shops - miscellaneous_specialty_retail - mobile_home_dealers - motion_picture_theaters - motor_freight_carriers_and_trucking - motor_homes_dealers - motor_vehicle_supplies_and_new_parts - motorcycle_shops_and_dealers - motorcycle_shops_dealers - music_stores_musical_instruments_pianos_and_sheet_music - news_dealers_and_newsstands - non_fi_money_orders - non_fi_stored_value_card_purchase_load - nondurable_goods - nurseries_lawn_and_garden_supply_stores - nursing_personal_care - office_and_commercial_furniture - opticians_eyeglasses - optometrists_ophthalmologist - orthopedic_goods_prosthetic_devices - osteopaths - package_stores_beer_wine_and_liquor - paints_varnishes_and_supplies - parking_lots_garages - passenger_railways - pawn_shops - pet_shops_pet_food_and_supplies - petroleum_and_petroleum_products - photo_developing - photographic_photocopy_microfilm_equipment_and_supplies - photographic_studios - picture_video_production - piece_goods_notions_and_other_dry_goods - plumbing_heating_equipment_and_supplies - political_organizations - postal_services_government_only - precious_stones_and_metals_watches_and_jewelry - professional_services - public_warehousing_and_storage - quick_copy_repro_and_blueprint - railroads - real_estate_agents_and_managers_rentals - record_stores - recreational_vehicle_rentals - religious_goods_stores - religious_organizations - roofing_siding_sheet_metal - secretarial_support_services - security_brokers_dealers - service_stations - sewing_needlework_fabric_and_piece_goods_stores - shoe_repair_hat_cleaning - shoe_stores - small_appliance_repair - snowmobile_dealers - special_trade_services - specialty_cleaning - sporting_goods_stores - sporting_recreation_camps - sports_and_riding_apparel_stores - sports_clubs_fields - stamp_and_coin_stores - stationary_office_supplies_printing_and_writing_paper - stationery_stores_office_and_school_supply_stores - swimming_pools_sales - t_ui_travel_germany - tailors_alterations - tax_payments_government_agencies - tax_preparation_services - taxicabs_limousines - telecommunication_equipment_and_telephone_sales - telecommunication_services - telegraph_services - tent_and_awning_shops - testing_laboratories - theatrical_ticket_agencies - timeshares - tire_retreading_and_repair - tolls_bridge_fees - tourist_attractions_and_exhibits - towing_services - trailer_parks_campgrounds - transportation_services - travel_agencies_tour_operators - truck_stop_iteration - truck_utility_trailer_rentals - typesetting_plate_making_and_related_services - typewriter_stores - u_s_federal_government_agencies_or_departments - uniforms_commercial_clothing - used_merchandise_and_secondhand_stores - utilities - variety_stores - veterinary_services - video_amusement_game_supplies - video_game_arcades - video_tape_rental_stores - vocational_trade_schools - watch_jewelry_repair - welding_repair - wholesale_clubs - wig_and_toupee_stores - wires_money_orders - womens_accessory_and_specialty_shops - womens_ready_to_wear_stores - wrecking_and_salvage_yards type: string nullable: true type: array allowed_merchant_countries: description: >- Array of strings containing representing countries from which authorizations will be allowed. Authorizations from merchants in all other countries will be declined. Country codes should be ISO 3166 alpha-2 country codes (e.g. `US`). Cannot be set with `blocked_merchant_countries`. Provide an empty value to unset this control. items: maxLength: 5000 type: string nullable: true type: array blocked_categories: description: >- Array of strings containing [categories](https://stripe.com/docs/api#issuing_authorization_object-merchant_data-category) of authorizations to decline. All other categories will be allowed. Cannot be set with `allowed_categories`. items: enum: - ac_refrigeration_repair - accounting_bookkeeping_services - advertising_services - agricultural_cooperative - airlines_air_carriers - airports_flying_fields - ambulance_services - amusement_parks_carnivals - antique_reproductions - antique_shops - aquariums - architectural_surveying_services - art_dealers_and_galleries - artists_supply_and_craft_shops - auto_and_home_supply_stores - auto_body_repair_shops - auto_paint_shops - auto_service_shops - automated_cash_disburse - automated_fuel_dispensers - automobile_associations - automotive_parts_and_accessories_stores - automotive_tire_stores - bail_and_bond_payments - bakeries - bands_orchestras - barber_and_beauty_shops - betting_casino_gambling - bicycle_shops - billiard_pool_establishments - boat_dealers - boat_rentals_and_leases - book_stores - books_periodicals_and_newspapers - bowling_alleys - bus_lines - business_secretarial_schools - buying_shopping_services - cable_satellite_and_other_pay_television_and_radio - camera_and_photographic_supply_stores - candy_nut_and_confectionery_stores - car_and_truck_dealers_new_used - car_and_truck_dealers_used_only - car_rental_agencies - car_washes - carpentry_services - carpet_upholstery_cleaning - caterers - charitable_and_social_service_organizations_fundraising - chemicals_and_allied_products - child_care_services - childrens_and_infants_wear_stores - chiropodists_podiatrists - chiropractors - cigar_stores_and_stands - civic_social_fraternal_associations - cleaning_and_maintenance - clothing_rental - colleges_universities - commercial_equipment - commercial_footwear - commercial_photography_art_and_graphics - commuter_transport_and_ferries - computer_network_services - computer_programming - computer_repair - computer_software_stores - computers_peripherals_and_software - concrete_work_services - construction_materials - consulting_public_relations - correspondence_schools - cosmetic_stores - counseling_services - country_clubs - courier_services - court_costs - credit_reporting_agencies - cruise_lines - dairy_products_stores - dance_hall_studios_schools - dating_escort_services - dentists_orthodontists - department_stores - detective_agencies - digital_goods_applications - digital_goods_games - digital_goods_large_volume - digital_goods_media - direct_marketing_catalog_merchant - direct_marketing_combination_catalog_and_retail_merchant - direct_marketing_inbound_telemarketing - direct_marketing_insurance_services - direct_marketing_other - direct_marketing_outbound_telemarketing - direct_marketing_subscription - direct_marketing_travel - discount_stores - doctors - door_to_door_sales - drapery_window_covering_and_upholstery_stores - drinking_places - drug_stores_and_pharmacies - drugs_drug_proprietaries_and_druggist_sundries - dry_cleaners - durable_goods - duty_free_stores - eating_places_restaurants - educational_services - electric_razor_stores - electric_vehicle_charging - electrical_parts_and_equipment - electrical_services - electronics_repair_shops - electronics_stores - elementary_secondary_schools - emergency_services_gcas_visa_use_only - employment_temp_agencies - equipment_rental - exterminating_services - family_clothing_stores - fast_food_restaurants - financial_institutions - fines_government_administrative_entities - fireplace_fireplace_screens_and_accessories_stores - floor_covering_stores - florists - florists_supplies_nursery_stock_and_flowers - freezer_and_locker_meat_provisioners - fuel_dealers_non_automotive - funeral_services_crematories - >- furniture_home_furnishings_and_equipment_stores_except_appliances - furniture_repair_refinishing - furriers_and_fur_shops - general_services - gift_card_novelty_and_souvenir_shops - glass_paint_and_wallpaper_stores - glassware_crystal_stores - golf_courses_public - government_licensed_horse_dog_racing_us_region_only - >- government_licensed_online_casions_online_gambling_us_region_only - government_owned_lotteries_non_us_region - government_owned_lotteries_us_region_only - government_services - grocery_stores_supermarkets - hardware_equipment_and_supplies - hardware_stores - health_and_beauty_spas - hearing_aids_sales_and_supplies - heating_plumbing_a_c - hobby_toy_and_game_shops - home_supply_warehouse_stores - hospitals - hotels_motels_and_resorts - household_appliance_stores - industrial_supplies - information_retrieval_services - insurance_default - insurance_underwriting_premiums - intra_company_purchases - jewelry_stores_watches_clocks_and_silverware_stores - landscaping_services - laundries - laundry_cleaning_services - legal_services_attorneys - luggage_and_leather_goods_stores - lumber_building_materials_stores - manual_cash_disburse - marinas_service_and_supplies - marketplaces - masonry_stonework_and_plaster - massage_parlors - medical_and_dental_labs - medical_dental_ophthalmic_and_hospital_equipment_and_supplies - medical_services - membership_organizations - mens_and_boys_clothing_and_accessories_stores - mens_womens_clothing_stores - metal_service_centers - miscellaneous - miscellaneous_apparel_and_accessory_shops - miscellaneous_auto_dealers - miscellaneous_business_services - miscellaneous_food_stores - miscellaneous_general_merchandise - miscellaneous_general_services - miscellaneous_home_furnishing_specialty_stores - miscellaneous_publishing_and_printing - miscellaneous_recreation_services - miscellaneous_repair_shops - miscellaneous_specialty_retail - mobile_home_dealers - motion_picture_theaters - motor_freight_carriers_and_trucking - motor_homes_dealers - motor_vehicle_supplies_and_new_parts - motorcycle_shops_and_dealers - motorcycle_shops_dealers - music_stores_musical_instruments_pianos_and_sheet_music - news_dealers_and_newsstands - non_fi_money_orders - non_fi_stored_value_card_purchase_load - nondurable_goods - nurseries_lawn_and_garden_supply_stores - nursing_personal_care - office_and_commercial_furniture - opticians_eyeglasses - optometrists_ophthalmologist - orthopedic_goods_prosthetic_devices - osteopaths - package_stores_beer_wine_and_liquor - paints_varnishes_and_supplies - parking_lots_garages - passenger_railways - pawn_shops - pet_shops_pet_food_and_supplies - petroleum_and_petroleum_products - photo_developing - photographic_photocopy_microfilm_equipment_and_supplies - photographic_studios - picture_video_production - piece_goods_notions_and_other_dry_goods - plumbing_heating_equipment_and_supplies - political_organizations - postal_services_government_only - precious_stones_and_metals_watches_and_jewelry - professional_services - public_warehousing_and_storage - quick_copy_repro_and_blueprint - railroads - real_estate_agents_and_managers_rentals - record_stores - recreational_vehicle_rentals - religious_goods_stores - religious_organizations - roofing_siding_sheet_metal - secretarial_support_services - security_brokers_dealers - service_stations - sewing_needlework_fabric_and_piece_goods_stores - shoe_repair_hat_cleaning - shoe_stores - small_appliance_repair - snowmobile_dealers - special_trade_services - specialty_cleaning - sporting_goods_stores - sporting_recreation_camps - sports_and_riding_apparel_stores - sports_clubs_fields - stamp_and_coin_stores - stationary_office_supplies_printing_and_writing_paper - stationery_stores_office_and_school_supply_stores - swimming_pools_sales - t_ui_travel_germany - tailors_alterations - tax_payments_government_agencies - tax_preparation_services - taxicabs_limousines - telecommunication_equipment_and_telephone_sales - telecommunication_services - telegraph_services - tent_and_awning_shops - testing_laboratories - theatrical_ticket_agencies - timeshares - tire_retreading_and_repair - tolls_bridge_fees - tourist_attractions_and_exhibits - towing_services - trailer_parks_campgrounds - transportation_services - travel_agencies_tour_operators - truck_stop_iteration - truck_utility_trailer_rentals - typesetting_plate_making_and_related_services - typewriter_stores - u_s_federal_government_agencies_or_departments - uniforms_commercial_clothing - used_merchandise_and_secondhand_stores - utilities - variety_stores - veterinary_services - video_amusement_game_supplies - video_game_arcades - video_tape_rental_stores - vocational_trade_schools - watch_jewelry_repair - welding_repair - wholesale_clubs - wig_and_toupee_stores - wires_money_orders - womens_accessory_and_specialty_shops - womens_ready_to_wear_stores - wrecking_and_salvage_yards type: string nullable: true type: array blocked_merchant_countries: description: >- Array of strings containing representing countries from which authorizations will be declined. Country codes should be ISO 3166 alpha-2 country codes (e.g. `US`). Cannot be set with `allowed_merchant_countries`. Provide an empty value to unset this control. items: maxLength: 5000 type: string nullable: true type: array spending_limits: description: >- Limit spending with amount-based rules that apply across any cards this card replaced (i.e., its `replacement_for` card and _that_ card's `replacement_for` card, up the chain). items: $ref: '#/components/schemas/issuing_card_spending_limit' nullable: true type: array spending_limits_currency: description: >- Currency of the amounts within `spending_limits`. Always the same as the currency of the card. nullable: true type: string title: IssuingCardAuthorizationControls type: object x-expandableFields: - spending_limits issuing_card_google_pay: description: '' properties: eligible: description: Google Pay Eligibility type: boolean ineligible_reason: description: Reason the card is ineligible for Google Pay enum: - missing_agreement - missing_cardholder_contact - unsupported_region nullable: true type: string required: - eligible title: IssuingCardGooglePay type: object x-expandableFields: [] issuing_card_shipping: description: '' properties: address: $ref: '#/components/schemas/address' carrier: description: The delivery company that shipped a card. enum: - dhl - fedex - royal_mail - usps nullable: true type: string customs: anyOf: - $ref: '#/components/schemas/issuing_card_shipping_customs' description: Additional information that may be required for clearing customs. nullable: true eta: description: >- A unix timestamp representing a best estimate of when the card will be delivered. format: unix-time nullable: true type: integer name: description: Recipient name. maxLength: 5000 type: string phone_number: description: >- The phone number of the receiver of the shipment. Our courier partners will use this number to contact you in the event of card delivery issues. For individual shipments to the EU/UK, if this field is empty, we will provide them with the phone number provided when the cardholder was initially created. maxLength: 5000 nullable: true type: string require_signature: description: >- Whether a signature is required for card delivery. This feature is only supported for US users. Standard shipping service does not support signature on delivery. The default value for standard shipping service is false and for express and priority services is true. nullable: true type: boolean service: description: 'Shipment service, such as `standard` or `express`.' enum: - express - priority - standard type: string x-stripeBypassValidation: true status: description: The delivery status of the card. enum: - canceled - delivered - failure - pending - returned - shipped nullable: true type: string tracking_number: description: A tracking number for a card shipment. maxLength: 5000 nullable: true type: string tracking_url: description: >- A link to the shipping carrier's site where you can view detailed information about a card shipment. maxLength: 5000 nullable: true type: string type: description: Packaging options. enum: - bulk - individual type: string required: - address - name - service - type title: IssuingCardShipping type: object x-expandableFields: - address - customs issuing_card_shipping_customs: description: '' properties: eori_number: description: >- A registration number used for customs in Europe. See [https://www.gov.uk/eori](https://www.gov.uk/eori) for the UK and [https://ec.europa.eu/taxation_customs/business/customs-procedures-import-and-export/customs-procedures/economic-operators-registration-and-identification-number-eori_en](https://ec.europa.eu/taxation_customs/business/customs-procedures-import-and-export/customs-procedures/economic-operators-registration-and-identification-number-eori_en) for the EU. maxLength: 5000 nullable: true type: string title: IssuingCardShippingCustoms type: object x-expandableFields: [] issuing_card_spending_limit: description: '' properties: amount: description: >- Maximum amount allowed to spend per interval. This amount is in the card's currency and in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). type: integer categories: description: >- Array of strings containing [categories](https://stripe.com/docs/api#issuing_authorization_object-merchant_data-category) this limit applies to. Omitting this field will apply the limit to all categories. items: enum: - ac_refrigeration_repair - accounting_bookkeeping_services - advertising_services - agricultural_cooperative - airlines_air_carriers - airports_flying_fields - ambulance_services - amusement_parks_carnivals - antique_reproductions - antique_shops - aquariums - architectural_surveying_services - art_dealers_and_galleries - artists_supply_and_craft_shops - auto_and_home_supply_stores - auto_body_repair_shops - auto_paint_shops - auto_service_shops - automated_cash_disburse - automated_fuel_dispensers - automobile_associations - automotive_parts_and_accessories_stores - automotive_tire_stores - bail_and_bond_payments - bakeries - bands_orchestras - barber_and_beauty_shops - betting_casino_gambling - bicycle_shops - billiard_pool_establishments - boat_dealers - boat_rentals_and_leases - book_stores - books_periodicals_and_newspapers - bowling_alleys - bus_lines - business_secretarial_schools - buying_shopping_services - cable_satellite_and_other_pay_television_and_radio - camera_and_photographic_supply_stores - candy_nut_and_confectionery_stores - car_and_truck_dealers_new_used - car_and_truck_dealers_used_only - car_rental_agencies - car_washes - carpentry_services - carpet_upholstery_cleaning - caterers - charitable_and_social_service_organizations_fundraising - chemicals_and_allied_products - child_care_services - childrens_and_infants_wear_stores - chiropodists_podiatrists - chiropractors - cigar_stores_and_stands - civic_social_fraternal_associations - cleaning_and_maintenance - clothing_rental - colleges_universities - commercial_equipment - commercial_footwear - commercial_photography_art_and_graphics - commuter_transport_and_ferries - computer_network_services - computer_programming - computer_repair - computer_software_stores - computers_peripherals_and_software - concrete_work_services - construction_materials - consulting_public_relations - correspondence_schools - cosmetic_stores - counseling_services - country_clubs - courier_services - court_costs - credit_reporting_agencies - cruise_lines - dairy_products_stores - dance_hall_studios_schools - dating_escort_services - dentists_orthodontists - department_stores - detective_agencies - digital_goods_applications - digital_goods_games - digital_goods_large_volume - digital_goods_media - direct_marketing_catalog_merchant - direct_marketing_combination_catalog_and_retail_merchant - direct_marketing_inbound_telemarketing - direct_marketing_insurance_services - direct_marketing_other - direct_marketing_outbound_telemarketing - direct_marketing_subscription - direct_marketing_travel - discount_stores - doctors - door_to_door_sales - drapery_window_covering_and_upholstery_stores - drinking_places - drug_stores_and_pharmacies - drugs_drug_proprietaries_and_druggist_sundries - dry_cleaners - durable_goods - duty_free_stores - eating_places_restaurants - educational_services - electric_razor_stores - electric_vehicle_charging - electrical_parts_and_equipment - electrical_services - electronics_repair_shops - electronics_stores - elementary_secondary_schools - emergency_services_gcas_visa_use_only - employment_temp_agencies - equipment_rental - exterminating_services - family_clothing_stores - fast_food_restaurants - financial_institutions - fines_government_administrative_entities - fireplace_fireplace_screens_and_accessories_stores - floor_covering_stores - florists - florists_supplies_nursery_stock_and_flowers - freezer_and_locker_meat_provisioners - fuel_dealers_non_automotive - funeral_services_crematories - >- furniture_home_furnishings_and_equipment_stores_except_appliances - furniture_repair_refinishing - furriers_and_fur_shops - general_services - gift_card_novelty_and_souvenir_shops - glass_paint_and_wallpaper_stores - glassware_crystal_stores - golf_courses_public - government_licensed_horse_dog_racing_us_region_only - >- government_licensed_online_casions_online_gambling_us_region_only - government_owned_lotteries_non_us_region - government_owned_lotteries_us_region_only - government_services - grocery_stores_supermarkets - hardware_equipment_and_supplies - hardware_stores - health_and_beauty_spas - hearing_aids_sales_and_supplies - heating_plumbing_a_c - hobby_toy_and_game_shops - home_supply_warehouse_stores - hospitals - hotels_motels_and_resorts - household_appliance_stores - industrial_supplies - information_retrieval_services - insurance_default - insurance_underwriting_premiums - intra_company_purchases - jewelry_stores_watches_clocks_and_silverware_stores - landscaping_services - laundries - laundry_cleaning_services - legal_services_attorneys - luggage_and_leather_goods_stores - lumber_building_materials_stores - manual_cash_disburse - marinas_service_and_supplies - marketplaces - masonry_stonework_and_plaster - massage_parlors - medical_and_dental_labs - medical_dental_ophthalmic_and_hospital_equipment_and_supplies - medical_services - membership_organizations - mens_and_boys_clothing_and_accessories_stores - mens_womens_clothing_stores - metal_service_centers - miscellaneous - miscellaneous_apparel_and_accessory_shops - miscellaneous_auto_dealers - miscellaneous_business_services - miscellaneous_food_stores - miscellaneous_general_merchandise - miscellaneous_general_services - miscellaneous_home_furnishing_specialty_stores - miscellaneous_publishing_and_printing - miscellaneous_recreation_services - miscellaneous_repair_shops - miscellaneous_specialty_retail - mobile_home_dealers - motion_picture_theaters - motor_freight_carriers_and_trucking - motor_homes_dealers - motor_vehicle_supplies_and_new_parts - motorcycle_shops_and_dealers - motorcycle_shops_dealers - music_stores_musical_instruments_pianos_and_sheet_music - news_dealers_and_newsstands - non_fi_money_orders - non_fi_stored_value_card_purchase_load - nondurable_goods - nurseries_lawn_and_garden_supply_stores - nursing_personal_care - office_and_commercial_furniture - opticians_eyeglasses - optometrists_ophthalmologist - orthopedic_goods_prosthetic_devices - osteopaths - package_stores_beer_wine_and_liquor - paints_varnishes_and_supplies - parking_lots_garages - passenger_railways - pawn_shops - pet_shops_pet_food_and_supplies - petroleum_and_petroleum_products - photo_developing - photographic_photocopy_microfilm_equipment_and_supplies - photographic_studios - picture_video_production - piece_goods_notions_and_other_dry_goods - plumbing_heating_equipment_and_supplies - political_organizations - postal_services_government_only - precious_stones_and_metals_watches_and_jewelry - professional_services - public_warehousing_and_storage - quick_copy_repro_and_blueprint - railroads - real_estate_agents_and_managers_rentals - record_stores - recreational_vehicle_rentals - religious_goods_stores - religious_organizations - roofing_siding_sheet_metal - secretarial_support_services - security_brokers_dealers - service_stations - sewing_needlework_fabric_and_piece_goods_stores - shoe_repair_hat_cleaning - shoe_stores - small_appliance_repair - snowmobile_dealers - special_trade_services - specialty_cleaning - sporting_goods_stores - sporting_recreation_camps - sports_and_riding_apparel_stores - sports_clubs_fields - stamp_and_coin_stores - stationary_office_supplies_printing_and_writing_paper - stationery_stores_office_and_school_supply_stores - swimming_pools_sales - t_ui_travel_germany - tailors_alterations - tax_payments_government_agencies - tax_preparation_services - taxicabs_limousines - telecommunication_equipment_and_telephone_sales - telecommunication_services - telegraph_services - tent_and_awning_shops - testing_laboratories - theatrical_ticket_agencies - timeshares - tire_retreading_and_repair - tolls_bridge_fees - tourist_attractions_and_exhibits - towing_services - trailer_parks_campgrounds - transportation_services - travel_agencies_tour_operators - truck_stop_iteration - truck_utility_trailer_rentals - typesetting_plate_making_and_related_services - typewriter_stores - u_s_federal_government_agencies_or_departments - uniforms_commercial_clothing - used_merchandise_and_secondhand_stores - utilities - variety_stores - veterinary_services - video_amusement_game_supplies - video_game_arcades - video_tape_rental_stores - vocational_trade_schools - watch_jewelry_repair - welding_repair - wholesale_clubs - wig_and_toupee_stores - wires_money_orders - womens_accessory_and_specialty_shops - womens_ready_to_wear_stores - wrecking_and_salvage_yards type: string nullable: true type: array interval: description: Interval (or event) to which the amount applies. enum: - all_time - daily - monthly - per_authorization - weekly - yearly type: string required: - amount - interval title: IssuingCardSpendingLimit type: object x-expandableFields: [] issuing_card_wallets: description: '' properties: apple_pay: $ref: '#/components/schemas/issuing_card_apple_pay' google_pay: $ref: '#/components/schemas/issuing_card_google_pay' primary_account_identifier: description: Unique identifier for a card used with digital wallets maxLength: 5000 nullable: true type: string required: - apple_pay - google_pay title: IssuingCardWallets type: object x-expandableFields: - apple_pay - google_pay issuing_cardholder_address: description: '' properties: address: $ref: '#/components/schemas/address' required: - address title: IssuingCardholderAddress type: object x-expandableFields: - address issuing_cardholder_authorization_controls: description: '' properties: allowed_categories: description: >- Array of strings containing [categories](https://stripe.com/docs/api#issuing_authorization_object-merchant_data-category) of authorizations to allow. All other categories will be blocked. Cannot be set with `blocked_categories`. items: enum: - ac_refrigeration_repair - accounting_bookkeeping_services - advertising_services - agricultural_cooperative - airlines_air_carriers - airports_flying_fields - ambulance_services - amusement_parks_carnivals - antique_reproductions - antique_shops - aquariums - architectural_surveying_services - art_dealers_and_galleries - artists_supply_and_craft_shops - auto_and_home_supply_stores - auto_body_repair_shops - auto_paint_shops - auto_service_shops - automated_cash_disburse - automated_fuel_dispensers - automobile_associations - automotive_parts_and_accessories_stores - automotive_tire_stores - bail_and_bond_payments - bakeries - bands_orchestras - barber_and_beauty_shops - betting_casino_gambling - bicycle_shops - billiard_pool_establishments - boat_dealers - boat_rentals_and_leases - book_stores - books_periodicals_and_newspapers - bowling_alleys - bus_lines - business_secretarial_schools - buying_shopping_services - cable_satellite_and_other_pay_television_and_radio - camera_and_photographic_supply_stores - candy_nut_and_confectionery_stores - car_and_truck_dealers_new_used - car_and_truck_dealers_used_only - car_rental_agencies - car_washes - carpentry_services - carpet_upholstery_cleaning - caterers - charitable_and_social_service_organizations_fundraising - chemicals_and_allied_products - child_care_services - childrens_and_infants_wear_stores - chiropodists_podiatrists - chiropractors - cigar_stores_and_stands - civic_social_fraternal_associations - cleaning_and_maintenance - clothing_rental - colleges_universities - commercial_equipment - commercial_footwear - commercial_photography_art_and_graphics - commuter_transport_and_ferries - computer_network_services - computer_programming - computer_repair - computer_software_stores - computers_peripherals_and_software - concrete_work_services - construction_materials - consulting_public_relations - correspondence_schools - cosmetic_stores - counseling_services - country_clubs - courier_services - court_costs - credit_reporting_agencies - cruise_lines - dairy_products_stores - dance_hall_studios_schools - dating_escort_services - dentists_orthodontists - department_stores - detective_agencies - digital_goods_applications - digital_goods_games - digital_goods_large_volume - digital_goods_media - direct_marketing_catalog_merchant - direct_marketing_combination_catalog_and_retail_merchant - direct_marketing_inbound_telemarketing - direct_marketing_insurance_services - direct_marketing_other - direct_marketing_outbound_telemarketing - direct_marketing_subscription - direct_marketing_travel - discount_stores - doctors - door_to_door_sales - drapery_window_covering_and_upholstery_stores - drinking_places - drug_stores_and_pharmacies - drugs_drug_proprietaries_and_druggist_sundries - dry_cleaners - durable_goods - duty_free_stores - eating_places_restaurants - educational_services - electric_razor_stores - electric_vehicle_charging - electrical_parts_and_equipment - electrical_services - electronics_repair_shops - electronics_stores - elementary_secondary_schools - emergency_services_gcas_visa_use_only - employment_temp_agencies - equipment_rental - exterminating_services - family_clothing_stores - fast_food_restaurants - financial_institutions - fines_government_administrative_entities - fireplace_fireplace_screens_and_accessories_stores - floor_covering_stores - florists - florists_supplies_nursery_stock_and_flowers - freezer_and_locker_meat_provisioners - fuel_dealers_non_automotive - funeral_services_crematories - >- furniture_home_furnishings_and_equipment_stores_except_appliances - furniture_repair_refinishing - furriers_and_fur_shops - general_services - gift_card_novelty_and_souvenir_shops - glass_paint_and_wallpaper_stores - glassware_crystal_stores - golf_courses_public - government_licensed_horse_dog_racing_us_region_only - >- government_licensed_online_casions_online_gambling_us_region_only - government_owned_lotteries_non_us_region - government_owned_lotteries_us_region_only - government_services - grocery_stores_supermarkets - hardware_equipment_and_supplies - hardware_stores - health_and_beauty_spas - hearing_aids_sales_and_supplies - heating_plumbing_a_c - hobby_toy_and_game_shops - home_supply_warehouse_stores - hospitals - hotels_motels_and_resorts - household_appliance_stores - industrial_supplies - information_retrieval_services - insurance_default - insurance_underwriting_premiums - intra_company_purchases - jewelry_stores_watches_clocks_and_silverware_stores - landscaping_services - laundries - laundry_cleaning_services - legal_services_attorneys - luggage_and_leather_goods_stores - lumber_building_materials_stores - manual_cash_disburse - marinas_service_and_supplies - marketplaces - masonry_stonework_and_plaster - massage_parlors - medical_and_dental_labs - medical_dental_ophthalmic_and_hospital_equipment_and_supplies - medical_services - membership_organizations - mens_and_boys_clothing_and_accessories_stores - mens_womens_clothing_stores - metal_service_centers - miscellaneous - miscellaneous_apparel_and_accessory_shops - miscellaneous_auto_dealers - miscellaneous_business_services - miscellaneous_food_stores - miscellaneous_general_merchandise - miscellaneous_general_services - miscellaneous_home_furnishing_specialty_stores - miscellaneous_publishing_and_printing - miscellaneous_recreation_services - miscellaneous_repair_shops - miscellaneous_specialty_retail - mobile_home_dealers - motion_picture_theaters - motor_freight_carriers_and_trucking - motor_homes_dealers - motor_vehicle_supplies_and_new_parts - motorcycle_shops_and_dealers - motorcycle_shops_dealers - music_stores_musical_instruments_pianos_and_sheet_music - news_dealers_and_newsstands - non_fi_money_orders - non_fi_stored_value_card_purchase_load - nondurable_goods - nurseries_lawn_and_garden_supply_stores - nursing_personal_care - office_and_commercial_furniture - opticians_eyeglasses - optometrists_ophthalmologist - orthopedic_goods_prosthetic_devices - osteopaths - package_stores_beer_wine_and_liquor - paints_varnishes_and_supplies - parking_lots_garages - passenger_railways - pawn_shops - pet_shops_pet_food_and_supplies - petroleum_and_petroleum_products - photo_developing - photographic_photocopy_microfilm_equipment_and_supplies - photographic_studios - picture_video_production - piece_goods_notions_and_other_dry_goods - plumbing_heating_equipment_and_supplies - political_organizations - postal_services_government_only - precious_stones_and_metals_watches_and_jewelry - professional_services - public_warehousing_and_storage - quick_copy_repro_and_blueprint - railroads - real_estate_agents_and_managers_rentals - record_stores - recreational_vehicle_rentals - religious_goods_stores - religious_organizations - roofing_siding_sheet_metal - secretarial_support_services - security_brokers_dealers - service_stations - sewing_needlework_fabric_and_piece_goods_stores - shoe_repair_hat_cleaning - shoe_stores - small_appliance_repair - snowmobile_dealers - special_trade_services - specialty_cleaning - sporting_goods_stores - sporting_recreation_camps - sports_and_riding_apparel_stores - sports_clubs_fields - stamp_and_coin_stores - stationary_office_supplies_printing_and_writing_paper - stationery_stores_office_and_school_supply_stores - swimming_pools_sales - t_ui_travel_germany - tailors_alterations - tax_payments_government_agencies - tax_preparation_services - taxicabs_limousines - telecommunication_equipment_and_telephone_sales - telecommunication_services - telegraph_services - tent_and_awning_shops - testing_laboratories - theatrical_ticket_agencies - timeshares - tire_retreading_and_repair - tolls_bridge_fees - tourist_attractions_and_exhibits - towing_services - trailer_parks_campgrounds - transportation_services - travel_agencies_tour_operators - truck_stop_iteration - truck_utility_trailer_rentals - typesetting_plate_making_and_related_services - typewriter_stores - u_s_federal_government_agencies_or_departments - uniforms_commercial_clothing - used_merchandise_and_secondhand_stores - utilities - variety_stores - veterinary_services - video_amusement_game_supplies - video_game_arcades - video_tape_rental_stores - vocational_trade_schools - watch_jewelry_repair - welding_repair - wholesale_clubs - wig_and_toupee_stores - wires_money_orders - womens_accessory_and_specialty_shops - womens_ready_to_wear_stores - wrecking_and_salvage_yards type: string nullable: true type: array allowed_merchant_countries: description: >- Array of strings containing representing countries from which authorizations will be allowed. Authorizations from merchants in all other countries will be declined. Country codes should be ISO 3166 alpha-2 country codes (e.g. `US`). Cannot be set with `blocked_merchant_countries`. Provide an empty value to unset this control. items: maxLength: 5000 type: string nullable: true type: array blocked_categories: description: >- Array of strings containing [categories](https://stripe.com/docs/api#issuing_authorization_object-merchant_data-category) of authorizations to decline. All other categories will be allowed. Cannot be set with `allowed_categories`. items: enum: - ac_refrigeration_repair - accounting_bookkeeping_services - advertising_services - agricultural_cooperative - airlines_air_carriers - airports_flying_fields - ambulance_services - amusement_parks_carnivals - antique_reproductions - antique_shops - aquariums - architectural_surveying_services - art_dealers_and_galleries - artists_supply_and_craft_shops - auto_and_home_supply_stores - auto_body_repair_shops - auto_paint_shops - auto_service_shops - automated_cash_disburse - automated_fuel_dispensers - automobile_associations - automotive_parts_and_accessories_stores - automotive_tire_stores - bail_and_bond_payments - bakeries - bands_orchestras - barber_and_beauty_shops - betting_casino_gambling - bicycle_shops - billiard_pool_establishments - boat_dealers - boat_rentals_and_leases - book_stores - books_periodicals_and_newspapers - bowling_alleys - bus_lines - business_secretarial_schools - buying_shopping_services - cable_satellite_and_other_pay_television_and_radio - camera_and_photographic_supply_stores - candy_nut_and_confectionery_stores - car_and_truck_dealers_new_used - car_and_truck_dealers_used_only - car_rental_agencies - car_washes - carpentry_services - carpet_upholstery_cleaning - caterers - charitable_and_social_service_organizations_fundraising - chemicals_and_allied_products - child_care_services - childrens_and_infants_wear_stores - chiropodists_podiatrists - chiropractors - cigar_stores_and_stands - civic_social_fraternal_associations - cleaning_and_maintenance - clothing_rental - colleges_universities - commercial_equipment - commercial_footwear - commercial_photography_art_and_graphics - commuter_transport_and_ferries - computer_network_services - computer_programming - computer_repair - computer_software_stores - computers_peripherals_and_software - concrete_work_services - construction_materials - consulting_public_relations - correspondence_schools - cosmetic_stores - counseling_services - country_clubs - courier_services - court_costs - credit_reporting_agencies - cruise_lines - dairy_products_stores - dance_hall_studios_schools - dating_escort_services - dentists_orthodontists - department_stores - detective_agencies - digital_goods_applications - digital_goods_games - digital_goods_large_volume - digital_goods_media - direct_marketing_catalog_merchant - direct_marketing_combination_catalog_and_retail_merchant - direct_marketing_inbound_telemarketing - direct_marketing_insurance_services - direct_marketing_other - direct_marketing_outbound_telemarketing - direct_marketing_subscription - direct_marketing_travel - discount_stores - doctors - door_to_door_sales - drapery_window_covering_and_upholstery_stores - drinking_places - drug_stores_and_pharmacies - drugs_drug_proprietaries_and_druggist_sundries - dry_cleaners - durable_goods - duty_free_stores - eating_places_restaurants - educational_services - electric_razor_stores - electric_vehicle_charging - electrical_parts_and_equipment - electrical_services - electronics_repair_shops - electronics_stores - elementary_secondary_schools - emergency_services_gcas_visa_use_only - employment_temp_agencies - equipment_rental - exterminating_services - family_clothing_stores - fast_food_restaurants - financial_institutions - fines_government_administrative_entities - fireplace_fireplace_screens_and_accessories_stores - floor_covering_stores - florists - florists_supplies_nursery_stock_and_flowers - freezer_and_locker_meat_provisioners - fuel_dealers_non_automotive - funeral_services_crematories - >- furniture_home_furnishings_and_equipment_stores_except_appliances - furniture_repair_refinishing - furriers_and_fur_shops - general_services - gift_card_novelty_and_souvenir_shops - glass_paint_and_wallpaper_stores - glassware_crystal_stores - golf_courses_public - government_licensed_horse_dog_racing_us_region_only - >- government_licensed_online_casions_online_gambling_us_region_only - government_owned_lotteries_non_us_region - government_owned_lotteries_us_region_only - government_services - grocery_stores_supermarkets - hardware_equipment_and_supplies - hardware_stores - health_and_beauty_spas - hearing_aids_sales_and_supplies - heating_plumbing_a_c - hobby_toy_and_game_shops - home_supply_warehouse_stores - hospitals - hotels_motels_and_resorts - household_appliance_stores - industrial_supplies - information_retrieval_services - insurance_default - insurance_underwriting_premiums - intra_company_purchases - jewelry_stores_watches_clocks_and_silverware_stores - landscaping_services - laundries - laundry_cleaning_services - legal_services_attorneys - luggage_and_leather_goods_stores - lumber_building_materials_stores - manual_cash_disburse - marinas_service_and_supplies - marketplaces - masonry_stonework_and_plaster - massage_parlors - medical_and_dental_labs - medical_dental_ophthalmic_and_hospital_equipment_and_supplies - medical_services - membership_organizations - mens_and_boys_clothing_and_accessories_stores - mens_womens_clothing_stores - metal_service_centers - miscellaneous - miscellaneous_apparel_and_accessory_shops - miscellaneous_auto_dealers - miscellaneous_business_services - miscellaneous_food_stores - miscellaneous_general_merchandise - miscellaneous_general_services - miscellaneous_home_furnishing_specialty_stores - miscellaneous_publishing_and_printing - miscellaneous_recreation_services - miscellaneous_repair_shops - miscellaneous_specialty_retail - mobile_home_dealers - motion_picture_theaters - motor_freight_carriers_and_trucking - motor_homes_dealers - motor_vehicle_supplies_and_new_parts - motorcycle_shops_and_dealers - motorcycle_shops_dealers - music_stores_musical_instruments_pianos_and_sheet_music - news_dealers_and_newsstands - non_fi_money_orders - non_fi_stored_value_card_purchase_load - nondurable_goods - nurseries_lawn_and_garden_supply_stores - nursing_personal_care - office_and_commercial_furniture - opticians_eyeglasses - optometrists_ophthalmologist - orthopedic_goods_prosthetic_devices - osteopaths - package_stores_beer_wine_and_liquor - paints_varnishes_and_supplies - parking_lots_garages - passenger_railways - pawn_shops - pet_shops_pet_food_and_supplies - petroleum_and_petroleum_products - photo_developing - photographic_photocopy_microfilm_equipment_and_supplies - photographic_studios - picture_video_production - piece_goods_notions_and_other_dry_goods - plumbing_heating_equipment_and_supplies - political_organizations - postal_services_government_only - precious_stones_and_metals_watches_and_jewelry - professional_services - public_warehousing_and_storage - quick_copy_repro_and_blueprint - railroads - real_estate_agents_and_managers_rentals - record_stores - recreational_vehicle_rentals - religious_goods_stores - religious_organizations - roofing_siding_sheet_metal - secretarial_support_services - security_brokers_dealers - service_stations - sewing_needlework_fabric_and_piece_goods_stores - shoe_repair_hat_cleaning - shoe_stores - small_appliance_repair - snowmobile_dealers - special_trade_services - specialty_cleaning - sporting_goods_stores - sporting_recreation_camps - sports_and_riding_apparel_stores - sports_clubs_fields - stamp_and_coin_stores - stationary_office_supplies_printing_and_writing_paper - stationery_stores_office_and_school_supply_stores - swimming_pools_sales - t_ui_travel_germany - tailors_alterations - tax_payments_government_agencies - tax_preparation_services - taxicabs_limousines - telecommunication_equipment_and_telephone_sales - telecommunication_services - telegraph_services - tent_and_awning_shops - testing_laboratories - theatrical_ticket_agencies - timeshares - tire_retreading_and_repair - tolls_bridge_fees - tourist_attractions_and_exhibits - towing_services - trailer_parks_campgrounds - transportation_services - travel_agencies_tour_operators - truck_stop_iteration - truck_utility_trailer_rentals - typesetting_plate_making_and_related_services - typewriter_stores - u_s_federal_government_agencies_or_departments - uniforms_commercial_clothing - used_merchandise_and_secondhand_stores - utilities - variety_stores - veterinary_services - video_amusement_game_supplies - video_game_arcades - video_tape_rental_stores - vocational_trade_schools - watch_jewelry_repair - welding_repair - wholesale_clubs - wig_and_toupee_stores - wires_money_orders - womens_accessory_and_specialty_shops - womens_ready_to_wear_stores - wrecking_and_salvage_yards type: string nullable: true type: array blocked_merchant_countries: description: >- Array of strings containing representing countries from which authorizations will be declined. Country codes should be ISO 3166 alpha-2 country codes (e.g. `US`). Cannot be set with `allowed_merchant_countries`. Provide an empty value to unset this control. items: maxLength: 5000 type: string nullable: true type: array spending_limits: description: >- Limit spending with amount-based rules that apply across this cardholder's cards. items: $ref: '#/components/schemas/issuing_cardholder_spending_limit' nullable: true type: array spending_limits_currency: description: Currency of the amounts within `spending_limits`. nullable: true type: string title: IssuingCardholderAuthorizationControls type: object x-expandableFields: - spending_limits issuing_cardholder_card_issuing: description: '' properties: user_terms_acceptance: anyOf: - $ref: '#/components/schemas/issuing_cardholder_user_terms_acceptance' description: >- Information about cardholder acceptance of Celtic [Authorized User Terms](https://stripe.com/docs/issuing/cards#accept-authorized-user-terms). Required for cards backed by a Celtic program. nullable: true title: IssuingCardholderCardIssuing type: object x-expandableFields: - user_terms_acceptance issuing_cardholder_company: description: '' properties: tax_id_provided: description: Whether the company's business ID number was provided. type: boolean required: - tax_id_provided title: IssuingCardholderCompany type: object x-expandableFields: [] issuing_cardholder_id_document: description: '' properties: back: anyOf: - maxLength: 5000 type: string - $ref: '#/components/schemas/file' description: >- The back of a document returned by a [file upload](https://stripe.com/docs/api#create_file) with a `purpose` value of `identity_document`. nullable: true x-expansionResources: oneOf: - $ref: '#/components/schemas/file' front: anyOf: - maxLength: 5000 type: string - $ref: '#/components/schemas/file' description: >- The front of a document returned by a [file upload](https://stripe.com/docs/api#create_file) with a `purpose` value of `identity_document`. nullable: true x-expansionResources: oneOf: - $ref: '#/components/schemas/file' title: IssuingCardholderIdDocument type: object x-expandableFields: - back - front issuing_cardholder_individual: description: '' properties: card_issuing: anyOf: - $ref: '#/components/schemas/issuing_cardholder_card_issuing' description: Information related to the card_issuing program for this cardholder. nullable: true dob: anyOf: - $ref: '#/components/schemas/issuing_cardholder_individual_dob' description: The date of birth of this cardholder. nullable: true first_name: description: >- The first name of this cardholder. Required before activating Cards. This field cannot contain any numbers, special characters (except periods, commas, hyphens, spaces and apostrophes) or non-latin letters. maxLength: 5000 nullable: true type: string last_name: description: >- The last name of this cardholder. Required before activating Cards. This field cannot contain any numbers, special characters (except periods, commas, hyphens, spaces and apostrophes) or non-latin letters. maxLength: 5000 nullable: true type: string verification: anyOf: - $ref: '#/components/schemas/issuing_cardholder_verification' description: Government-issued ID document for this cardholder. nullable: true title: IssuingCardholderIndividual type: object x-expandableFields: - card_issuing - dob - verification issuing_cardholder_individual_dob: description: '' properties: day: description: 'The day of birth, between 1 and 31.' nullable: true type: integer month: description: 'The month of birth, between 1 and 12.' nullable: true type: integer year: description: The four-digit year of birth. nullable: true type: integer title: IssuingCardholderIndividualDOB type: object x-expandableFields: [] issuing_cardholder_requirements: description: '' properties: disabled_reason: description: >- If `disabled_reason` is present, all cards will decline authorizations with `cardholder_verification_required` reason. enum: - listed - rejected.listed - requirements.past_due - under_review nullable: true type: string past_due: description: >- Array of fields that need to be collected in order to verify and re-enable the cardholder. items: enum: - company.tax_id - individual.card_issuing.user_terms_acceptance.date - individual.card_issuing.user_terms_acceptance.ip - individual.dob.day - individual.dob.month - individual.dob.year - individual.first_name - individual.last_name - individual.verification.document type: string x-stripeBypassValidation: true nullable: true type: array title: IssuingCardholderRequirements type: object x-expandableFields: [] issuing_cardholder_spending_limit: description: '' properties: amount: description: >- Maximum amount allowed to spend per interval. This amount is in the card's currency and in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). type: integer categories: description: >- Array of strings containing [categories](https://stripe.com/docs/api#issuing_authorization_object-merchant_data-category) this limit applies to. Omitting this field will apply the limit to all categories. items: enum: - ac_refrigeration_repair - accounting_bookkeeping_services - advertising_services - agricultural_cooperative - airlines_air_carriers - airports_flying_fields - ambulance_services - amusement_parks_carnivals - antique_reproductions - antique_shops - aquariums - architectural_surveying_services - art_dealers_and_galleries - artists_supply_and_craft_shops - auto_and_home_supply_stores - auto_body_repair_shops - auto_paint_shops - auto_service_shops - automated_cash_disburse - automated_fuel_dispensers - automobile_associations - automotive_parts_and_accessories_stores - automotive_tire_stores - bail_and_bond_payments - bakeries - bands_orchestras - barber_and_beauty_shops - betting_casino_gambling - bicycle_shops - billiard_pool_establishments - boat_dealers - boat_rentals_and_leases - book_stores - books_periodicals_and_newspapers - bowling_alleys - bus_lines - business_secretarial_schools - buying_shopping_services - cable_satellite_and_other_pay_television_and_radio - camera_and_photographic_supply_stores - candy_nut_and_confectionery_stores - car_and_truck_dealers_new_used - car_and_truck_dealers_used_only - car_rental_agencies - car_washes - carpentry_services - carpet_upholstery_cleaning - caterers - charitable_and_social_service_organizations_fundraising - chemicals_and_allied_products - child_care_services - childrens_and_infants_wear_stores - chiropodists_podiatrists - chiropractors - cigar_stores_and_stands - civic_social_fraternal_associations - cleaning_and_maintenance - clothing_rental - colleges_universities - commercial_equipment - commercial_footwear - commercial_photography_art_and_graphics - commuter_transport_and_ferries - computer_network_services - computer_programming - computer_repair - computer_software_stores - computers_peripherals_and_software - concrete_work_services - construction_materials - consulting_public_relations - correspondence_schools - cosmetic_stores - counseling_services - country_clubs - courier_services - court_costs - credit_reporting_agencies - cruise_lines - dairy_products_stores - dance_hall_studios_schools - dating_escort_services - dentists_orthodontists - department_stores - detective_agencies - digital_goods_applications - digital_goods_games - digital_goods_large_volume - digital_goods_media - direct_marketing_catalog_merchant - direct_marketing_combination_catalog_and_retail_merchant - direct_marketing_inbound_telemarketing - direct_marketing_insurance_services - direct_marketing_other - direct_marketing_outbound_telemarketing - direct_marketing_subscription - direct_marketing_travel - discount_stores - doctors - door_to_door_sales - drapery_window_covering_and_upholstery_stores - drinking_places - drug_stores_and_pharmacies - drugs_drug_proprietaries_and_druggist_sundries - dry_cleaners - durable_goods - duty_free_stores - eating_places_restaurants - educational_services - electric_razor_stores - electric_vehicle_charging - electrical_parts_and_equipment - electrical_services - electronics_repair_shops - electronics_stores - elementary_secondary_schools - emergency_services_gcas_visa_use_only - employment_temp_agencies - equipment_rental - exterminating_services - family_clothing_stores - fast_food_restaurants - financial_institutions - fines_government_administrative_entities - fireplace_fireplace_screens_and_accessories_stores - floor_covering_stores - florists - florists_supplies_nursery_stock_and_flowers - freezer_and_locker_meat_provisioners - fuel_dealers_non_automotive - funeral_services_crematories - >- furniture_home_furnishings_and_equipment_stores_except_appliances - furniture_repair_refinishing - furriers_and_fur_shops - general_services - gift_card_novelty_and_souvenir_shops - glass_paint_and_wallpaper_stores - glassware_crystal_stores - golf_courses_public - government_licensed_horse_dog_racing_us_region_only - >- government_licensed_online_casions_online_gambling_us_region_only - government_owned_lotteries_non_us_region - government_owned_lotteries_us_region_only - government_services - grocery_stores_supermarkets - hardware_equipment_and_supplies - hardware_stores - health_and_beauty_spas - hearing_aids_sales_and_supplies - heating_plumbing_a_c - hobby_toy_and_game_shops - home_supply_warehouse_stores - hospitals - hotels_motels_and_resorts - household_appliance_stores - industrial_supplies - information_retrieval_services - insurance_default - insurance_underwriting_premiums - intra_company_purchases - jewelry_stores_watches_clocks_and_silverware_stores - landscaping_services - laundries - laundry_cleaning_services - legal_services_attorneys - luggage_and_leather_goods_stores - lumber_building_materials_stores - manual_cash_disburse - marinas_service_and_supplies - marketplaces - masonry_stonework_and_plaster - massage_parlors - medical_and_dental_labs - medical_dental_ophthalmic_and_hospital_equipment_and_supplies - medical_services - membership_organizations - mens_and_boys_clothing_and_accessories_stores - mens_womens_clothing_stores - metal_service_centers - miscellaneous - miscellaneous_apparel_and_accessory_shops - miscellaneous_auto_dealers - miscellaneous_business_services - miscellaneous_food_stores - miscellaneous_general_merchandise - miscellaneous_general_services - miscellaneous_home_furnishing_specialty_stores - miscellaneous_publishing_and_printing - miscellaneous_recreation_services - miscellaneous_repair_shops - miscellaneous_specialty_retail - mobile_home_dealers - motion_picture_theaters - motor_freight_carriers_and_trucking - motor_homes_dealers - motor_vehicle_supplies_and_new_parts - motorcycle_shops_and_dealers - motorcycle_shops_dealers - music_stores_musical_instruments_pianos_and_sheet_music - news_dealers_and_newsstands - non_fi_money_orders - non_fi_stored_value_card_purchase_load - nondurable_goods - nurseries_lawn_and_garden_supply_stores - nursing_personal_care - office_and_commercial_furniture - opticians_eyeglasses - optometrists_ophthalmologist - orthopedic_goods_prosthetic_devices - osteopaths - package_stores_beer_wine_and_liquor - paints_varnishes_and_supplies - parking_lots_garages - passenger_railways - pawn_shops - pet_shops_pet_food_and_supplies - petroleum_and_petroleum_products - photo_developing - photographic_photocopy_microfilm_equipment_and_supplies - photographic_studios - picture_video_production - piece_goods_notions_and_other_dry_goods - plumbing_heating_equipment_and_supplies - political_organizations - postal_services_government_only - precious_stones_and_metals_watches_and_jewelry - professional_services - public_warehousing_and_storage - quick_copy_repro_and_blueprint - railroads - real_estate_agents_and_managers_rentals - record_stores - recreational_vehicle_rentals - religious_goods_stores - religious_organizations - roofing_siding_sheet_metal - secretarial_support_services - security_brokers_dealers - service_stations - sewing_needlework_fabric_and_piece_goods_stores - shoe_repair_hat_cleaning - shoe_stores - small_appliance_repair - snowmobile_dealers - special_trade_services - specialty_cleaning - sporting_goods_stores - sporting_recreation_camps - sports_and_riding_apparel_stores - sports_clubs_fields - stamp_and_coin_stores - stationary_office_supplies_printing_and_writing_paper - stationery_stores_office_and_school_supply_stores - swimming_pools_sales - t_ui_travel_germany - tailors_alterations - tax_payments_government_agencies - tax_preparation_services - taxicabs_limousines - telecommunication_equipment_and_telephone_sales - telecommunication_services - telegraph_services - tent_and_awning_shops - testing_laboratories - theatrical_ticket_agencies - timeshares - tire_retreading_and_repair - tolls_bridge_fees - tourist_attractions_and_exhibits - towing_services - trailer_parks_campgrounds - transportation_services - travel_agencies_tour_operators - truck_stop_iteration - truck_utility_trailer_rentals - typesetting_plate_making_and_related_services - typewriter_stores - u_s_federal_government_agencies_or_departments - uniforms_commercial_clothing - used_merchandise_and_secondhand_stores - utilities - variety_stores - veterinary_services - video_amusement_game_supplies - video_game_arcades - video_tape_rental_stores - vocational_trade_schools - watch_jewelry_repair - welding_repair - wholesale_clubs - wig_and_toupee_stores - wires_money_orders - womens_accessory_and_specialty_shops - womens_ready_to_wear_stores - wrecking_and_salvage_yards type: string nullable: true type: array interval: description: Interval (or event) to which the amount applies. enum: - all_time - daily - monthly - per_authorization - weekly - yearly type: string required: - amount - interval title: IssuingCardholderSpendingLimit type: object x-expandableFields: [] issuing_cardholder_user_terms_acceptance: description: '' properties: date: description: >- The Unix timestamp marking when the cardholder accepted the Authorized User Terms. format: unix-time nullable: true type: integer ip: description: >- The IP address from which the cardholder accepted the Authorized User Terms. maxLength: 5000 nullable: true type: string user_agent: description: >- The user agent of the browser from which the cardholder accepted the Authorized User Terms. maxLength: 5000 nullable: true type: string title: IssuingCardholderUserTermsAcceptance type: object x-expandableFields: [] issuing_cardholder_verification: description: '' properties: document: anyOf: - $ref: '#/components/schemas/issuing_cardholder_id_document' description: 'An identifying document, either a passport or local ID card.' nullable: true title: IssuingCardholderVerification type: object x-expandableFields: - document issuing_dispute_canceled_evidence: description: '' properties: additional_documentation: anyOf: - maxLength: 5000 type: string - $ref: '#/components/schemas/file' description: >- (ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Additional documentation supporting the dispute. nullable: true x-expansionResources: oneOf: - $ref: '#/components/schemas/file' canceled_at: description: Date when order was canceled. format: unix-time nullable: true type: integer cancellation_policy_provided: description: Whether the cardholder was provided with a cancellation policy. nullable: true type: boolean cancellation_reason: description: Reason for canceling the order. maxLength: 5000 nullable: true type: string expected_at: description: Date when the cardholder expected to receive the product. format: unix-time nullable: true type: integer explanation: description: Explanation of why the cardholder is disputing this transaction. maxLength: 5000 nullable: true type: string product_description: description: Description of the merchandise or service that was purchased. maxLength: 5000 nullable: true type: string product_type: description: Whether the product was a merchandise or service. enum: - merchandise - service nullable: true type: string return_status: description: Result of cardholder's attempt to return the product. enum: - merchant_rejected - successful nullable: true type: string returned_at: description: Date when the product was returned or attempted to be returned. format: unix-time nullable: true type: integer title: IssuingDisputeCanceledEvidence type: object x-expandableFields: - additional_documentation issuing_dispute_duplicate_evidence: description: '' properties: additional_documentation: anyOf: - maxLength: 5000 type: string - $ref: '#/components/schemas/file' description: >- (ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Additional documentation supporting the dispute. nullable: true x-expansionResources: oneOf: - $ref: '#/components/schemas/file' card_statement: anyOf: - maxLength: 5000 type: string - $ref: '#/components/schemas/file' description: >- (ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Copy of the card statement showing that the product had already been paid for. nullable: true x-expansionResources: oneOf: - $ref: '#/components/schemas/file' cash_receipt: anyOf: - maxLength: 5000 type: string - $ref: '#/components/schemas/file' description: >- (ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Copy of the receipt showing that the product had been paid for in cash. nullable: true x-expansionResources: oneOf: - $ref: '#/components/schemas/file' check_image: anyOf: - maxLength: 5000 type: string - $ref: '#/components/schemas/file' description: >- (ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Image of the front and back of the check that was used to pay for the product. nullable: true x-expansionResources: oneOf: - $ref: '#/components/schemas/file' explanation: description: Explanation of why the cardholder is disputing this transaction. maxLength: 5000 nullable: true type: string original_transaction: description: >- Transaction (e.g., ipi_...) that the disputed transaction is a duplicate of. Of the two or more transactions that are copies of each other, this is original undisputed one. maxLength: 5000 nullable: true type: string title: IssuingDisputeDuplicateEvidence type: object x-expandableFields: - additional_documentation - card_statement - cash_receipt - check_image issuing_dispute_evidence: description: '' properties: canceled: $ref: '#/components/schemas/issuing_dispute_canceled_evidence' duplicate: $ref: '#/components/schemas/issuing_dispute_duplicate_evidence' fraudulent: $ref: '#/components/schemas/issuing_dispute_fraudulent_evidence' merchandise_not_as_described: $ref: >- #/components/schemas/issuing_dispute_merchandise_not_as_described_evidence not_received: $ref: '#/components/schemas/issuing_dispute_not_received_evidence' other: $ref: '#/components/schemas/issuing_dispute_other_evidence' reason: description: >- The reason for filing the dispute. Its value will match the field containing the evidence. enum: - canceled - duplicate - fraudulent - merchandise_not_as_described - not_received - other - service_not_as_described type: string x-stripeBypassValidation: true service_not_as_described: $ref: >- #/components/schemas/issuing_dispute_service_not_as_described_evidence required: - reason title: IssuingDisputeEvidence type: object x-expandableFields: - canceled - duplicate - fraudulent - merchandise_not_as_described - not_received - other - service_not_as_described issuing_dispute_fraudulent_evidence: description: '' properties: additional_documentation: anyOf: - maxLength: 5000 type: string - $ref: '#/components/schemas/file' description: >- (ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Additional documentation supporting the dispute. nullable: true x-expansionResources: oneOf: - $ref: '#/components/schemas/file' explanation: description: Explanation of why the cardholder is disputing this transaction. maxLength: 5000 nullable: true type: string title: IssuingDisputeFraudulentEvidence type: object x-expandableFields: - additional_documentation issuing_dispute_merchandise_not_as_described_evidence: description: '' properties: additional_documentation: anyOf: - maxLength: 5000 type: string - $ref: '#/components/schemas/file' description: >- (ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Additional documentation supporting the dispute. nullable: true x-expansionResources: oneOf: - $ref: '#/components/schemas/file' explanation: description: Explanation of why the cardholder is disputing this transaction. maxLength: 5000 nullable: true type: string received_at: description: Date when the product was received. format: unix-time nullable: true type: integer return_description: description: Description of the cardholder's attempt to return the product. maxLength: 5000 nullable: true type: string return_status: description: Result of cardholder's attempt to return the product. enum: - merchant_rejected - successful nullable: true type: string returned_at: description: Date when the product was returned or attempted to be returned. format: unix-time nullable: true type: integer title: IssuingDisputeMerchandiseNotAsDescribedEvidence type: object x-expandableFields: - additional_documentation issuing_dispute_not_received_evidence: description: '' properties: additional_documentation: anyOf: - maxLength: 5000 type: string - $ref: '#/components/schemas/file' description: >- (ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Additional documentation supporting the dispute. nullable: true x-expansionResources: oneOf: - $ref: '#/components/schemas/file' expected_at: description: Date when the cardholder expected to receive the product. format: unix-time nullable: true type: integer explanation: description: Explanation of why the cardholder is disputing this transaction. maxLength: 5000 nullable: true type: string product_description: description: Description of the merchandise or service that was purchased. maxLength: 5000 nullable: true type: string product_type: description: Whether the product was a merchandise or service. enum: - merchandise - service nullable: true type: string title: IssuingDisputeNotReceivedEvidence type: object x-expandableFields: - additional_documentation issuing_dispute_other_evidence: description: '' properties: additional_documentation: anyOf: - maxLength: 5000 type: string - $ref: '#/components/schemas/file' description: >- (ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Additional documentation supporting the dispute. nullable: true x-expansionResources: oneOf: - $ref: '#/components/schemas/file' explanation: description: Explanation of why the cardholder is disputing this transaction. maxLength: 5000 nullable: true type: string product_description: description: Description of the merchandise or service that was purchased. maxLength: 5000 nullable: true type: string product_type: description: Whether the product was a merchandise or service. enum: - merchandise - service nullable: true type: string title: IssuingDisputeOtherEvidence type: object x-expandableFields: - additional_documentation issuing_dispute_service_not_as_described_evidence: description: '' properties: additional_documentation: anyOf: - maxLength: 5000 type: string - $ref: '#/components/schemas/file' description: >- (ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Additional documentation supporting the dispute. nullable: true x-expansionResources: oneOf: - $ref: '#/components/schemas/file' canceled_at: description: Date when order was canceled. format: unix-time nullable: true type: integer cancellation_reason: description: Reason for canceling the order. maxLength: 5000 nullable: true type: string explanation: description: Explanation of why the cardholder is disputing this transaction. maxLength: 5000 nullable: true type: string received_at: description: Date when the product was received. format: unix-time nullable: true type: integer title: IssuingDisputeServiceNotAsDescribedEvidence type: object x-expandableFields: - additional_documentation issuing_dispute_treasury: description: '' properties: debit_reversal: description: >- The Treasury [DebitReversal](https://stripe.com/docs/api/treasury/debit_reversals) representing this Issuing dispute maxLength: 5000 nullable: true type: string received_debit: description: >- The Treasury [ReceivedDebit](https://stripe.com/docs/api/treasury/received_debits) that is being disputed. maxLength: 5000 type: string required: - received_debit title: IssuingDisputeTreasury type: object x-expandableFields: [] issuing_network_token_address: description: '' properties: line1: description: The street address of the cardholder tokenizing the card. maxLength: 5000 type: string postal_code: description: The postal code of the cardholder tokenizing the card. maxLength: 5000 type: string required: - line1 - postal_code title: IssuingNetworkTokenAddress type: object x-expandableFields: [] issuing_network_token_device: description: '' properties: device_fingerprint: description: An obfuscated ID derived from the device ID. maxLength: 5000 type: string ip_address: description: The IP address of the device at provisioning time. maxLength: 5000 type: string location: description: >- The geographic latitude/longitude coordinates of the device at provisioning time. The format is [+-]decimal/[+-]decimal. maxLength: 5000 type: string name: description: The name of the device used for tokenization. maxLength: 5000 type: string phone_number: description: The phone number of the device used for tokenization. maxLength: 5000 type: string type: description: The type of device used for tokenization. enum: - other - phone - watch type: string title: IssuingNetworkTokenDevice type: object x-expandableFields: [] issuing_network_token_mastercard: description: '' properties: card_reference_id: description: >- A unique reference ID from MasterCard to represent the card account number. maxLength: 5000 type: string token_reference_id: description: The network-unique identifier for the token. maxLength: 5000 type: string token_requestor_id: description: >- The ID of the entity requesting tokenization, specific to MasterCard. maxLength: 5000 type: string token_requestor_name: description: >- The name of the entity requesting tokenization, if known. This is directly provided from MasterCard. maxLength: 5000 type: string required: - token_reference_id - token_requestor_id title: IssuingNetworkTokenMastercard type: object x-expandableFields: [] issuing_network_token_network_data: description: '' properties: device: $ref: '#/components/schemas/issuing_network_token_device' mastercard: $ref: '#/components/schemas/issuing_network_token_mastercard' type: description: >- The network that the token is associated with. An additional hash is included with a name matching this value, containing tokenization data specific to the card network. enum: - mastercard - visa type: string visa: $ref: '#/components/schemas/issuing_network_token_visa' wallet_provider: $ref: '#/components/schemas/issuing_network_token_wallet_provider' required: - type title: IssuingNetworkTokenNetworkData type: object x-expandableFields: - device - mastercard - visa - wallet_provider issuing_network_token_visa: description: '' properties: card_reference_id: description: >- A unique reference ID from Visa to represent the card account number. maxLength: 5000 type: string token_reference_id: description: The network-unique identifier for the token. maxLength: 5000 type: string token_requestor_id: description: 'The ID of the entity requesting tokenization, specific to Visa.' maxLength: 5000 type: string token_risk_score: description: >- Degree of risk associated with the token between `01` and `99`, with higher number indicating higher risk. A `00` value indicates the token was not scored by Visa. maxLength: 5000 type: string required: - card_reference_id - token_reference_id - token_requestor_id title: IssuingNetworkTokenVisa type: object x-expandableFields: [] issuing_network_token_wallet_provider: description: '' properties: account_id: description: >- The wallet provider-given account ID of the digital wallet the token belongs to. maxLength: 5000 type: string account_trust_score: description: >- An evaluation on the trustworthiness of the wallet account between 1 and 5. A higher score indicates more trustworthy. type: integer card_number_source: description: The method used for tokenizing a card. enum: - app - manual - on_file - other type: string cardholder_address: $ref: '#/components/schemas/issuing_network_token_address' cardholder_name: description: The name of the cardholder tokenizing the card. maxLength: 5000 type: string device_trust_score: description: >- An evaluation on the trustworthiness of the device. A higher score indicates more trustworthy. type: integer hashed_account_email_address: description: >- The hashed email address of the cardholder's account with the wallet provider. maxLength: 5000 type: string reason_codes: description: The reasons for suggested tokenization given by the card network. items: enum: - account_card_too_new - account_recently_changed - account_too_new - account_too_new_since_launch - additional_device - data_expired - defer_id_v_decision - device_recently_lost - good_activity_history - has_suspended_tokens - high_risk - inactive_account - long_account_tenure - low_account_score - low_device_score - low_phone_number_score - network_service_error - outside_home_territory - provisioning_cardholder_mismatch - provisioning_device_and_cardholder_mismatch - provisioning_device_mismatch - same_device_no_prior_authentication - same_device_successful_prior_authentication - software_update - suspicious_activity - too_many_different_cardholders - too_many_recent_attempts - too_many_recent_tokens type: string type: array suggested_decision: description: The recommendation on responding to the tokenization request. enum: - approve - decline - require_auth type: string suggested_decision_version: description: >- The version of the standard for mapping reason codes followed by the wallet provider. maxLength: 5000 type: string title: IssuingNetworkTokenWalletProvider type: object x-expandableFields: - cardholder_address issuing_personalization_design_carrier_text: description: '' properties: footer_body: description: The footer body text of the carrier letter. maxLength: 5000 nullable: true type: string footer_title: description: The footer title text of the carrier letter. maxLength: 5000 nullable: true type: string header_body: description: The header body text of the carrier letter. maxLength: 5000 nullable: true type: string header_title: description: The header title text of the carrier letter. maxLength: 5000 nullable: true type: string title: IssuingPersonalizationDesignCarrierText type: object x-expandableFields: [] issuing_personalization_design_preferences: description: '' properties: is_default: description: >- Whether we use this personalization design to create cards when one isn't specified. A connected account uses the Connect platform's default design if no personalization design is set as the default design. type: boolean is_platform_default: description: >- Whether this personalization design is used to create cards when one is not specified and a default for this connected account does not exist. nullable: true type: boolean required: - is_default title: IssuingPersonalizationDesignPreferences type: object x-expandableFields: [] issuing_personalization_design_rejection_reasons: description: '' properties: card_logo: description: The reason(s) the card logo was rejected. items: enum: - geographic_location - inappropriate - network_name - non_binary_image - non_fiat_currency - other - other_entity - promotional_material type: string nullable: true type: array carrier_text: description: The reason(s) the carrier text was rejected. items: enum: - geographic_location - inappropriate - network_name - non_fiat_currency - other - other_entity - promotional_material type: string nullable: true type: array title: IssuingPersonalizationDesignRejectionReasons type: object x-expandableFields: [] issuing_physical_bundle_features: description: '' properties: card_logo: description: >- The policy for how to use card logo images in a card design with this physical bundle. enum: - optional - required - unsupported type: string carrier_text: description: >- The policy for how to use carrier letter text in a card design with this physical bundle. enum: - optional - required - unsupported type: string second_line: description: >- The policy for how to use a second line on a card with this physical bundle. enum: - optional - required - unsupported type: string required: - card_logo - carrier_text - second_line title: IssuingPhysicalBundleFeatures type: object x-expandableFields: [] issuing_transaction_amount_details: description: '' properties: atm_fee: description: The fee charged by the ATM for the cash withdrawal. nullable: true type: integer cashback_amount: description: The amount of cash requested by the cardholder. nullable: true type: integer title: IssuingTransactionAmountDetails type: object x-expandableFields: [] issuing_transaction_flight_data: description: '' properties: departure_at: description: The time that the flight departed. nullable: true type: integer passenger_name: description: The name of the passenger. maxLength: 5000 nullable: true type: string refundable: description: Whether the ticket is refundable. nullable: true type: boolean segments: description: The legs of the trip. items: $ref: '#/components/schemas/issuing_transaction_flight_data_leg' nullable: true type: array travel_agency: description: The travel agency that issued the ticket. maxLength: 5000 nullable: true type: string title: IssuingTransactionFlightData type: object x-expandableFields: - segments issuing_transaction_flight_data_leg: description: '' properties: arrival_airport_code: description: The three-letter IATA airport code of the flight's destination. maxLength: 5000 nullable: true type: string carrier: description: The airline carrier code. maxLength: 5000 nullable: true type: string departure_airport_code: description: The three-letter IATA airport code that the flight departed from. maxLength: 5000 nullable: true type: string flight_number: description: The flight number. maxLength: 5000 nullable: true type: string service_class: description: The flight's service class. maxLength: 5000 nullable: true type: string stopover_allowed: description: Whether a stopover is allowed on this flight. nullable: true type: boolean title: IssuingTransactionFlightDataLeg type: object x-expandableFields: [] issuing_transaction_fuel_data: description: '' properties: type: description: >- The type of fuel that was purchased. One of `diesel`, `unleaded_plus`, `unleaded_regular`, `unleaded_super`, or `other`. maxLength: 5000 type: string unit: description: >- The units for `volume_decimal`. One of `liter`, `us_gallon`, or `other`. maxLength: 5000 type: string unit_cost_decimal: description: >- The cost in cents per each unit of fuel, represented as a decimal string with at most 12 decimal places. format: decimal type: string volume_decimal: description: >- The volume of the fuel that was pumped, represented as a decimal string with at most 12 decimal places. format: decimal nullable: true type: string required: - type - unit - unit_cost_decimal title: IssuingTransactionFuelData type: object x-expandableFields: [] issuing_transaction_lodging_data: description: '' properties: check_in_at: description: The time of checking into the lodging. nullable: true type: integer nights: description: The number of nights stayed at the lodging. nullable: true type: integer title: IssuingTransactionLodgingData type: object x-expandableFields: [] issuing_transaction_network_data: description: '' properties: authorization_code: description: >- A code created by Stripe which is shared with the merchant to validate the authorization. This field will be populated if the authorization message was approved. The code typically starts with the letter "S", followed by a six-digit number. For example, "S498162". Please note that the code is not guaranteed to be unique across authorizations. maxLength: 5000 nullable: true type: string processing_date: description: >- The date the transaction was processed by the card network. This can be different from the date the seller recorded the transaction depending on when the acquirer submits the transaction to the network. maxLength: 5000 nullable: true type: string transaction_id: description: >- Unique identifier for the authorization assigned by the card network used to match subsequent messages, disputes, and transactions. maxLength: 5000 nullable: true type: string title: IssuingTransactionNetworkData type: object x-expandableFields: [] issuing_transaction_purchase_details: description: '' properties: flight: anyOf: - $ref: '#/components/schemas/issuing_transaction_flight_data' description: >- Information about the flight that was purchased with this transaction. nullable: true fuel: anyOf: - $ref: '#/components/schemas/issuing_transaction_fuel_data' description: Information about fuel that was purchased with this transaction. nullable: true lodging: anyOf: - $ref: '#/components/schemas/issuing_transaction_lodging_data' description: Information about lodging that was purchased with this transaction. nullable: true receipt: description: The line items in the purchase. items: $ref: '#/components/schemas/issuing_transaction_receipt_data' nullable: true type: array reference: description: A merchant-specific order number. maxLength: 5000 nullable: true type: string title: IssuingTransactionPurchaseDetails type: object x-expandableFields: - flight - fuel - lodging - receipt issuing_transaction_receipt_data: description: '' properties: description: description: >- The description of the item. The maximum length of this field is 26 characters. maxLength: 5000 nullable: true type: string quantity: description: The quantity of the item. nullable: true type: number total: description: The total for this line item in cents. nullable: true type: integer unit_cost: description: The unit cost of the item in cents. nullable: true type: integer title: IssuingTransactionReceiptData type: object x-expandableFields: [] issuing_transaction_treasury: description: '' properties: received_credit: description: >- The Treasury [ReceivedCredit](https://stripe.com/docs/api/treasury/received_credits) representing this Issuing transaction if it is a refund maxLength: 5000 nullable: true type: string received_debit: description: >- The Treasury [ReceivedDebit](https://stripe.com/docs/api/treasury/received_debits) representing this Issuing transaction if it is a capture maxLength: 5000 nullable: true type: string title: IssuingTransactionTreasury type: object x-expandableFields: [] item: description: A line item. properties: amount_discount: description: >- Total discount amount applied. If no discounts were applied, defaults to 0. type: integer amount_subtotal: description: Total before any discounts or taxes are applied. type: integer amount_tax: description: 'Total tax amount applied. If no tax was applied, defaults to 0.' type: integer amount_total: description: Total after discounts and taxes. type: integer currency: description: >- 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). type: string description: description: >- An arbitrary string attached to the object. Often useful for displaying to users. Defaults to product name. maxLength: 5000 type: string discounts: description: The discounts applied to the line item. items: $ref: '#/components/schemas/line_items_discount_amount' type: array id: description: Unique identifier for the object. maxLength: 5000 type: string object: description: >- String representing the object's type. Objects of the same type share the same value. enum: - item type: string price: anyOf: - $ref: '#/components/schemas/price' description: The price used to generate the line item. nullable: true quantity: description: The quantity of products being purchased. nullable: true type: integer taxes: description: The taxes applied to the line item. items: $ref: '#/components/schemas/line_items_tax_amount' type: array required: - amount_discount - amount_subtotal - amount_tax - amount_total - currency - description - id - object title: LineItem type: object x-expandableFields: - discounts - price - taxes x-resourceId: item legal_entity_company: description: '' properties: address: $ref: '#/components/schemas/address' address_kana: anyOf: - $ref: '#/components/schemas/legal_entity_japan_address' description: The Kana variation of the company's primary address (Japan only). nullable: true address_kanji: anyOf: - $ref: '#/components/schemas/legal_entity_japan_address' description: The Kanji variation of the company's primary address (Japan only). nullable: true directors_provided: description: >- 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). type: boolean executives_provided: description: >- 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. type: boolean export_license_id: description: >- The export license ID number of the company, also referred as Import Export Code (India only). maxLength: 5000 type: string export_purpose_code: description: The purpose code to use for export transactions (India only). maxLength: 5000 type: string name: description: The company's legal name. maxLength: 5000 nullable: true type: string name_kana: description: The Kana variation of the company's legal name (Japan only). maxLength: 5000 nullable: true type: string name_kanji: description: The Kanji variation of the company's legal name (Japan only). maxLength: 5000 nullable: true type: string owners_provided: description: >- 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). type: boolean ownership_declaration: anyOf: - $ref: '#/components/schemas/legal_entity_ubo_declaration' description: >- This hash is used to attest that the beneficial owner information provided to Stripe is both current and correct. nullable: true phone: description: The company's phone number (used for verification). maxLength: 5000 nullable: true type: string structure: description: >- 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. enum: - 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 type: string x-stripeBypassValidation: true tax_id_provided: description: Whether the company's business ID number was provided. type: boolean tax_id_registrar: description: >- The jurisdiction in which the `tax_id` is registered (Germany-based companies only). maxLength: 5000 type: string vat_id_provided: description: Whether the company's business VAT number was provided. type: boolean verification: anyOf: - $ref: '#/components/schemas/legal_entity_company_verification' description: Information on the verification state of the company. nullable: true title: LegalEntityCompany type: object x-expandableFields: - address - address_kana - address_kanji - ownership_declaration - verification legal_entity_company_verification: description: '' properties: document: $ref: '#/components/schemas/legal_entity_company_verification_document' required: - document title: LegalEntityCompanyVerification type: object x-expandableFields: - document legal_entity_company_verification_document: description: '' properties: back: anyOf: - maxLength: 5000 type: string - $ref: '#/components/schemas/file' description: >- The back of a document returned by a [file upload](https://stripe.com/docs/api#create_file) with a `purpose` value of `additional_verification`. nullable: true x-expansionResources: oneOf: - $ref: '#/components/schemas/file' details: description: >- A user-displayable string describing the verification state of this document. maxLength: 5000 nullable: true type: string details_code: description: >- One of `document_corrupt`, `document_expired`, `document_failed_copy`, `document_failed_greyscale`, `document_failed_other`, `document_failed_test_mode`, `document_fraudulent`, `document_incomplete`, `document_invalid`, `document_manipulated`, `document_not_readable`, `document_not_uploaded`, `document_type_not_supported`, or `document_too_large`. A machine-readable code specifying the verification state for this document. maxLength: 5000 nullable: true type: string front: anyOf: - maxLength: 5000 type: string - $ref: '#/components/schemas/file' description: >- The front of a document returned by a [file upload](https://stripe.com/docs/api#create_file) with a `purpose` value of `additional_verification`. nullable: true x-expansionResources: oneOf: - $ref: '#/components/schemas/file' title: LegalEntityCompanyVerificationDocument type: object x-expandableFields: - back - front legal_entity_dob: description: '' properties: day: description: 'The day of birth, between 1 and 31.' nullable: true type: integer month: description: 'The month of birth, between 1 and 12.' nullable: true type: integer year: description: The four-digit year of birth. nullable: true type: integer title: LegalEntityDOB type: object x-expandableFields: [] legal_entity_japan_address: description: '' properties: city: description: City/Ward. maxLength: 5000 nullable: true type: string country: description: >- Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)). maxLength: 5000 nullable: true type: string line1: description: Block/Building number. maxLength: 5000 nullable: true type: string line2: description: Building details. maxLength: 5000 nullable: true type: string postal_code: description: ZIP or postal code. maxLength: 5000 nullable: true type: string state: description: Prefecture. maxLength: 5000 nullable: true type: string town: description: Town/cho-me. maxLength: 5000 nullable: true type: string title: LegalEntityJapanAddress type: object x-expandableFields: [] legal_entity_person_verification: description: '' properties: additional_document: anyOf: - $ref: '#/components/schemas/legal_entity_person_verification_document' description: >- A document showing address, either a passport, local ID card, or utility bill from a well-known utility company. nullable: true details: description: >- A user-displayable string describing the verification state for the person. For example, this may say "Provided identity information could not be verified". maxLength: 5000 nullable: true type: string details_code: description: >- 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. maxLength: 5000 nullable: true type: string document: $ref: '#/components/schemas/legal_entity_person_verification_document' status: description: >- The state of verification for the person. Possible values are `unverified`, `pending`, or `verified`. maxLength: 5000 type: string required: - status title: LegalEntityPersonVerification type: object x-expandableFields: - additional_document - document legal_entity_person_verification_document: description: '' properties: back: anyOf: - maxLength: 5000 type: string - $ref: '#/components/schemas/file' description: >- The back of an ID returned by a [file upload](https://stripe.com/docs/api#create_file) with a `purpose` value of `identity_document`. nullable: true x-expansionResources: oneOf: - $ref: '#/components/schemas/file' details: description: >- A user-displayable string describing the verification state of this document. For example, if a document is uploaded and the picture is too fuzzy, this may say "Identity document is too unclear to read". maxLength: 5000 nullable: true type: string details_code: description: >- One of `document_corrupt`, `document_country_not_supported`, `document_expired`, `document_failed_copy`, `document_failed_other`, `document_failed_test_mode`, `document_fraudulent`, `document_failed_greyscale`, `document_incomplete`, `document_invalid`, `document_manipulated`, `document_missing_back`, `document_missing_front`, `document_not_readable`, `document_not_uploaded`, `document_photo_mismatch`, `document_too_large`, or `document_type_not_supported`. A machine-readable code specifying the verification state for this document. maxLength: 5000 nullable: true type: string front: anyOf: - maxLength: 5000 type: string - $ref: '#/components/schemas/file' description: >- The front of an ID returned by a [file upload](https://stripe.com/docs/api#create_file) with a `purpose` value of `identity_document`. nullable: true x-expansionResources: oneOf: - $ref: '#/components/schemas/file' title: LegalEntityPersonVerificationDocument type: object x-expandableFields: - back - front legal_entity_ubo_declaration: description: '' properties: date: description: >- The Unix timestamp marking when the beneficial owner attestation was made. format: unix-time nullable: true type: integer ip: description: The IP address from which the beneficial owner attestation was made. maxLength: 5000 nullable: true type: string user_agent: description: >- The user-agent string from the browser where the beneficial owner attestation was made. maxLength: 5000 nullable: true type: string title: LegalEntityUBODeclaration type: object x-expandableFields: [] line_item: description: '' properties: amount: description: 'The amount, in cents (or local equivalent).' type: integer amount_excluding_tax: description: >- The integer amount in cents (or local equivalent) representing the amount for this line item, excluding all tax and discounts. nullable: true type: integer currency: description: >- 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). type: string description: description: >- An arbitrary string attached to the object. Often useful for displaying to users. maxLength: 5000 nullable: true type: string discount_amounts: description: The amount of discount calculated per discount for this line item. items: $ref: '#/components/schemas/discounts_resource_discount_amount' nullable: true type: array discountable: description: >- If true, discounts will apply to this line item. Always false for prorations. type: boolean discounts: description: >- The discounts applied to the invoice line item. Line item discounts are applied before invoice discounts. Use `expand[]=discounts` to expand each discount. items: anyOf: - maxLength: 5000 type: string - $ref: '#/components/schemas/discount' x-expansionResources: oneOf: - $ref: '#/components/schemas/discount' type: array id: description: Unique identifier for the object. maxLength: 5000 type: string invoice: description: The ID of the invoice that contains this line item. maxLength: 5000 nullable: true type: string invoice_item: anyOf: - maxLength: 5000 type: string - $ref: '#/components/schemas/invoiceitem' description: >- The ID of the [invoice item](https://stripe.com/docs/api/invoiceitems) associated with this line item if any. x-expansionResources: oneOf: - $ref: '#/components/schemas/invoiceitem' livemode: description: >- Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. type: boolean metadata: additionalProperties: maxLength: 500 type: string description: >- 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. Note that for line items with `type=subscription` this will reflect the metadata of the subscription that caused the line item to be created. type: object object: description: >- String representing the object's type. Objects of the same type share the same value. enum: - line_item type: string period: $ref: '#/components/schemas/invoice_line_item_period' price: anyOf: - $ref: '#/components/schemas/price' description: The price of the line item. nullable: true proration: description: Whether this is a proration. type: boolean proration_details: anyOf: - $ref: >- #/components/schemas/invoices_resource_line_items_proration_details description: Additional details for proration line items nullable: true quantity: description: >- The quantity of the subscription, if the line item is a subscription or a proration. nullable: true type: integer subscription: anyOf: - maxLength: 5000 type: string - $ref: '#/components/schemas/subscription' description: 'The subscription that the invoice item pertains to, if any.' nullable: true x-expansionResources: oneOf: - $ref: '#/components/schemas/subscription' subscription_item: anyOf: - maxLength: 5000 type: string - $ref: '#/components/schemas/subscription_item' description: >- The subscription item that generated this line item. Left empty if the line item is not an explicit result of a subscription. x-expansionResources: oneOf: - $ref: '#/components/schemas/subscription_item' tax_amounts: description: The amount of tax calculated per tax rate for this line item items: $ref: '#/components/schemas/invoice_tax_amount' type: array tax_rates: description: The tax rates which apply to the line item. items: $ref: '#/components/schemas/tax_rate' type: array type: description: >- A string identifying the type of the source of this line item, either an `invoiceitem` or a `subscription`. enum: - invoiceitem - subscription type: string unit_amount_excluding_tax: description: >- The amount in cents (or local equivalent) representing the unit amount for this line item, excluding all tax and discounts. format: decimal nullable: true type: string required: - amount - currency - discountable - discounts - id - livemode - metadata - object - period - proration - type title: InvoiceLineItem type: object x-expandableFields: - discount_amounts - discounts - invoice_item - period - price - proration_details - subscription - subscription_item - tax_amounts - tax_rates x-resourceId: line_item line_items_discount_amount: description: '' properties: amount: description: The amount discounted. type: integer discount: $ref: '#/components/schemas/discount' required: - amount - discount title: LineItemsDiscountAmount type: object x-expandableFields: - discount line_items_tax_amount: description: '' properties: amount: description: Amount of tax applied for this rate. type: integer rate: $ref: '#/components/schemas/tax_rate' taxability_reason: description: >- The reasoning behind this tax, for example, if the product is tax exempt. The possible values for this field may be extended as new tax rules are supported. enum: - customer_exempt - not_collecting - not_subject_to_tax - not_supported - portion_product_exempt - portion_reduced_rated - portion_standard_rated - product_exempt - product_exempt_holiday - proportionally_rated - reduced_rated - reverse_charge - standard_rated - taxable_basis_reduced - zero_rated nullable: true type: string x-stripeBypassValidation: true taxable_amount: description: >- The amount on which tax is calculated, in cents (or local equivalent). nullable: true type: integer required: - amount - rate title: LineItemsTaxAmount type: object x-expandableFields: - rate linked_account_options_us_bank_account: description: '' properties: permissions: description: >- The list of permissions to request. The `payment_method` permission must be included. items: enum: - balances - ownership - payment_method - transactions type: string type: array prefetch: description: Data features requested to be retrieved upon account creation. items: enum: - balances - ownership - transactions type: string x-stripeBypassValidation: true nullable: true type: array return_url: description: >- For webview integrations only. Upon completing OAuth login in the native browser, the user will be redirected to this URL to return to your app. maxLength: 5000 type: string title: linked_account_options_us_bank_account type: object x-expandableFields: [] login_link: description: >- Login Links are single-use login link for an Express account to access their Stripe dashboard. properties: created: description: >- Time at which the object was created. Measured in seconds since the Unix epoch. format: unix-time type: integer object: description: >- String representing the object's type. Objects of the same type share the same value. enum: - login_link type: string url: description: The URL for the login link. maxLength: 5000 type: string required: - created - object - url title: LoginLink type: object x-expandableFields: [] x-resourceId: login_link mandate: description: >- A Mandate is a record of the permission that your customer gives you to debit their payment method. properties: customer_acceptance: $ref: '#/components/schemas/customer_acceptance' id: description: Unique identifier for the object. maxLength: 5000 type: string livemode: description: >- Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. type: boolean multi_use: $ref: '#/components/schemas/mandate_multi_use' object: description: >- String representing the object's type. Objects of the same type share the same value. enum: - mandate type: string on_behalf_of: description: The account (if any) that the mandate is intended for. maxLength: 5000 type: string payment_method: anyOf: - maxLength: 5000 type: string - $ref: '#/components/schemas/payment_method' description: ID of the payment method associated with this mandate. x-expansionResources: oneOf: - $ref: '#/components/schemas/payment_method' payment_method_details: $ref: '#/components/schemas/mandate_payment_method_details' single_use: $ref: '#/components/schemas/mandate_single_use' status: description: >- The mandate status indicates whether or not you can use it to initiate a payment. enum: - active - inactive - pending type: string type: description: The type of the mandate. enum: - multi_use - single_use type: string required: - customer_acceptance - id - livemode - object - payment_method - payment_method_details - status - type title: Mandate type: object x-expandableFields: - customer_acceptance - multi_use - payment_method - payment_method_details - single_use x-resourceId: mandate mandate_acss_debit: description: '' properties: default_for: description: >- List of Stripe products where this mandate can be selected automatically. items: enum: - invoice - subscription type: string type: array interval_description: description: >- Description of the interval. Only required if the 'payment_schedule' parameter is 'interval' or 'combined'. maxLength: 5000 nullable: true type: string payment_schedule: description: Payment schedule for the mandate. enum: - combined - interval - sporadic type: string transaction_type: description: Transaction type of the mandate. enum: - business - personal type: string required: - payment_schedule - transaction_type title: mandate_acss_debit type: object x-expandableFields: [] mandate_au_becs_debit: description: '' properties: url: description: >- The URL of the mandate. This URL generally contains sensitive information about the customer and should be shared with them exclusively. maxLength: 5000 type: string required: - url title: mandate_au_becs_debit type: object x-expandableFields: [] mandate_bacs_debit: description: '' properties: network_status: description: >- The status of the mandate on the Bacs network. Can be one of `pending`, `revoked`, `refused`, or `accepted`. enum: - accepted - pending - refused - revoked type: string reference: description: The unique reference identifying the mandate on the Bacs network. maxLength: 5000 type: string revocation_reason: description: >- When the mandate is revoked on the Bacs network this field displays the reason for the revocation. enum: - account_closed - bank_account_restricted - bank_ownership_changed - could_not_process - debit_not_authorized nullable: true type: string url: description: The URL that will contain the mandate that the customer has signed. maxLength: 5000 type: string required: - network_status - reference - url title: mandate_bacs_debit type: object x-expandableFields: [] mandate_cashapp: description: '' properties: {} title: mandate_cashapp type: object x-expandableFields: [] mandate_link: description: '' properties: {} title: mandate_link type: object x-expandableFields: [] mandate_multi_use: description: '' properties: {} title: mandate_multi_use type: object x-expandableFields: [] mandate_payment_method_details: description: '' properties: acss_debit: $ref: '#/components/schemas/mandate_acss_debit' au_becs_debit: $ref: '#/components/schemas/mandate_au_becs_debit' bacs_debit: $ref: '#/components/schemas/mandate_bacs_debit' card: $ref: '#/components/schemas/card_mandate_payment_method_details' cashapp: $ref: '#/components/schemas/mandate_cashapp' link: $ref: '#/components/schemas/mandate_link' paypal: $ref: '#/components/schemas/mandate_paypal' sepa_debit: $ref: '#/components/schemas/mandate_sepa_debit' type: description: >- This mandate corresponds with a specific payment method type. The `payment_method_details` includes an additional hash with the same name and contains mandate information that's specific to that payment method. maxLength: 5000 type: string us_bank_account: $ref: '#/components/schemas/mandate_us_bank_account' required: - type title: mandate_payment_method_details type: object x-expandableFields: - acss_debit - au_becs_debit - bacs_debit - card - cashapp - link - paypal - sepa_debit - us_bank_account mandate_paypal: description: '' properties: billing_agreement_id: description: >- The PayPal Billing Agreement ID (BAID). This is an ID generated by PayPal which represents the mandate between the merchant and the customer. maxLength: 5000 nullable: true type: string payer_id: description: >- PayPal account PayerID. This identifier uniquely identifies the PayPal customer. maxLength: 5000 nullable: true type: string title: mandate_paypal type: object x-expandableFields: [] mandate_sepa_debit: description: '' properties: reference: description: The unique reference of the mandate. maxLength: 5000 type: string url: description: >- The URL of the mandate. This URL generally contains sensitive information about the customer and should be shared with them exclusively. maxLength: 5000 type: string required: - reference - url title: mandate_sepa_debit type: object x-expandableFields: [] mandate_single_use: description: '' properties: amount: description: The amount of the payment on a single use mandate. type: integer currency: description: The currency of the payment on a single use mandate. type: string required: - amount - currency title: mandate_single_use type: object x-expandableFields: [] mandate_us_bank_account: description: '' properties: collection_method: description: Mandate collection method enum: - paper type: string x-stripeBypassValidation: true title: mandate_us_bank_account type: object x-expandableFields: [] networks: description: '' properties: available: description: All available networks for the card. items: maxLength: 5000 type: string type: array preferred: description: >- 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. maxLength: 5000 nullable: true type: string required: - available title: networks type: object x-expandableFields: [] notification_event_data: description: '' properties: object: description: >- Object containing the API resource relevant to the event. For example, an `invoice.created` event will have a full [invoice object](https://stripe.com/docs/api#invoice_object) as the value of the object key. type: object previous_attributes: description: >- Object containing the names of the updated attributes and their values prior to the event (only included in events of type `*.updated`). If an array attribute has any updated elements, this object contains the entire array. In Stripe API versions 2017-04-06 or earlier, an updated array attribute in this object includes only the updated array elements. type: object required: - object title: NotificationEventData type: object x-expandableFields: [] notification_event_request: description: '' properties: id: description: >- ID of the API request that caused the event. If null, the event was automatic (e.g., Stripe's automatic subscription handling). Request logs are available in the [dashboard](https://dashboard.stripe.com/logs), but currently not in the API. maxLength: 5000 nullable: true type: string idempotency_key: description: >- The idempotency key transmitted during the request, if any. *Note: This property is populated only for events on or after May 23, 2017*. maxLength: 5000 nullable: true type: string title: NotificationEventRequest type: object x-expandableFields: [] offline_acceptance: description: '' properties: {} title: offline_acceptance type: object x-expandableFields: [] online_acceptance: description: '' properties: ip_address: description: The customer accepts the mandate from this IP address. maxLength: 5000 nullable: true type: string user_agent: description: >- The customer accepts the mandate using the user agent of the browser. maxLength: 5000 nullable: true type: string title: online_acceptance type: object x-expandableFields: [] outbound_payments_payment_method_details: description: '' properties: billing_details: $ref: '#/components/schemas/treasury_shared_resource_billing_details' financial_account: $ref: >- #/components/schemas/outbound_payments_payment_method_details_financial_account type: description: The type of the payment method used in the OutboundPayment. enum: - financial_account - us_bank_account type: string us_bank_account: $ref: >- #/components/schemas/outbound_payments_payment_method_details_us_bank_account required: - billing_details - type title: OutboundPaymentsPaymentMethodDetails type: object x-expandableFields: - billing_details - financial_account - us_bank_account outbound_payments_payment_method_details_financial_account: description: '' properties: id: description: Token of the FinancialAccount. maxLength: 5000 type: string network: description: The rails used to send funds. enum: - stripe type: string required: - id - network title: outbound_payments_payment_method_details_financial_account type: object x-expandableFields: [] outbound_payments_payment_method_details_us_bank_account: description: '' properties: account_holder_type: description: 'Account holder type: individual or company.' enum: - company - individual nullable: true type: string account_type: description: 'Account type: checkings or savings. Defaults to checking if omitted.' enum: - checking - savings nullable: true type: string bank_name: description: Name of the bank associated with the bank account. maxLength: 5000 nullable: true type: string fingerprint: description: >- Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same. maxLength: 5000 nullable: true type: string last4: description: Last four digits of the bank account number. maxLength: 5000 nullable: true type: string mandate: anyOf: - maxLength: 5000 type: string - $ref: '#/components/schemas/mandate' description: ID of the mandate used to make this payment. x-expansionResources: oneOf: - $ref: '#/components/schemas/mandate' network: description: >- The network rails used. See the [docs](https://stripe.com/docs/treasury/money-movement/timelines) to learn more about money movement timelines for each network type. enum: - ach - us_domestic_wire type: string routing_number: description: Routing number of the bank account. maxLength: 5000 nullable: true type: string required: - network title: outbound_payments_payment_method_details_us_bank_account type: object x-expandableFields: - mandate outbound_transfers_payment_method_details: description: '' properties: billing_details: $ref: '#/components/schemas/treasury_shared_resource_billing_details' type: description: The type of the payment method used in the OutboundTransfer. enum: - us_bank_account type: string x-stripeBypassValidation: true us_bank_account: $ref: >- #/components/schemas/outbound_transfers_payment_method_details_us_bank_account required: - billing_details - type title: OutboundTransfersPaymentMethodDetails type: object x-expandableFields: - billing_details - us_bank_account outbound_transfers_payment_method_details_us_bank_account: description: '' properties: account_holder_type: description: 'Account holder type: individual or company.' enum: - company - individual nullable: true type: string account_type: description: 'Account type: checkings or savings. Defaults to checking if omitted.' enum: - checking - savings nullable: true type: string bank_name: description: Name of the bank associated with the bank account. maxLength: 5000 nullable: true type: string fingerprint: description: >- Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same. maxLength: 5000 nullable: true type: string last4: description: Last four digits of the bank account number. maxLength: 5000 nullable: true type: string mandate: anyOf: - maxLength: 5000 type: string - $ref: '#/components/schemas/mandate' description: ID of the mandate used to make this payment. x-expansionResources: oneOf: - $ref: '#/components/schemas/mandate' network: description: >- The network rails used. See the [docs](https://stripe.com/docs/treasury/money-movement/timelines) to learn more about money movement timelines for each network type. enum: - ach - us_domestic_wire type: string routing_number: description: Routing number of the bank account. maxLength: 5000 nullable: true type: string required: - network title: outbound_transfers_payment_method_details_us_bank_account type: object x-expandableFields: - mandate package_dimensions: description: '' properties: height: description: 'Height, in inches.' type: number length: description: 'Length, in inches.' type: number weight: description: 'Weight, in ounces.' type: number width: description: 'Width, in inches.' type: number required: - height - length - weight - width title: PackageDimensions type: object x-expandableFields: [] payment_flows_amount_details: description: '' properties: tip: $ref: '#/components/schemas/payment_flows_amount_details_resource_tip' title: PaymentFlowsAmountDetails type: object x-expandableFields: - tip payment_flows_amount_details_resource_tip: description: '' properties: amount: description: Portion of the amount that corresponds to a tip. type: integer title: PaymentFlowsAmountDetailsResourceTip type: object x-expandableFields: [] payment_flows_automatic_payment_methods_payment_intent: description: '' properties: allow_redirects: description: >- 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. enum: - always - never type: string enabled: description: Automatically calculates compatible payment methods type: boolean required: - enabled title: PaymentFlowsAutomaticPaymentMethodsPaymentIntent type: object x-expandableFields: [] payment_flows_automatic_payment_methods_setup_intent: description: '' properties: allow_redirects: description: >- Controls whether this SetupIntent will accept redirect-based payment methods. Redirect-based payment methods may require your customer to be redirected to a payment method's app or site for authentication or additional steps. To [confirm](https://stripe.com/docs/api/setup_intents/confirm) this SetupIntent, you may be required to provide a `return_url` to redirect customers back to your site after they authenticate or complete the setup. enum: - always - never type: string enabled: description: Automatically calculates compatible payment methods nullable: true type: boolean title: PaymentFlowsAutomaticPaymentMethodsSetupIntent type: object x-expandableFields: [] payment_flows_installment_options: description: '' properties: enabled: type: boolean plan: $ref: '#/components/schemas/payment_method_details_card_installments_plan' required: - enabled title: PaymentFlowsInstallmentOptions type: object x-expandableFields: - plan payment_flows_private_payment_methods_alipay: description: '' properties: {} title: PaymentFlowsPrivatePaymentMethodsAlipay type: object x-expandableFields: [] payment_flows_private_payment_methods_alipay_details: description: '' properties: buyer_id: description: >- Uniquely identifies this particular Alipay account. You can use this attribute to check whether two Alipay accounts are the same. maxLength: 5000 type: string fingerprint: description: >- Uniquely identifies this particular Alipay account. You can use this attribute to check whether two Alipay accounts are the same. maxLength: 5000 nullable: true type: string transaction_id: description: Transaction ID of this particular Alipay transaction. maxLength: 5000 nullable: true type: string title: PaymentFlowsPrivatePaymentMethodsAlipayDetails type: object x-expandableFields: [] payment_flows_private_payment_methods_card_details_api_resource_enterprise_features_extended_authorization_extended_authorization: description: '' properties: status: description: >- Indicates whether or not the capture window is extended beyond the standard authorization. enum: - disabled - enabled type: string required: - status title: >- PaymentFlowsPrivatePaymentMethodsCardDetailsAPIResourceEnterpriseFeaturesExtendedAuthorizationExtendedAuthorization type: object x-expandableFields: [] payment_flows_private_payment_methods_card_details_api_resource_enterprise_features_incremental_authorization_incremental_authorization: description: '' properties: status: description: >- Indicates whether or not the incremental authorization feature is supported. enum: - available - unavailable type: string required: - status title: >- PaymentFlowsPrivatePaymentMethodsCardDetailsAPIResourceEnterpriseFeaturesIncrementalAuthorizationIncrementalAuthorization type: object x-expandableFields: [] payment_flows_private_payment_methods_card_details_api_resource_enterprise_features_overcapture_overcapture: description: '' properties: maximum_amount_capturable: description: The maximum amount that can be captured. type: integer status: description: Indicates whether or not the authorized amount can be over-captured. enum: - available - unavailable type: string required: - maximum_amount_capturable - status title: >- PaymentFlowsPrivatePaymentMethodsCardDetailsAPIResourceEnterpriseFeaturesOvercaptureOvercapture type: object x-expandableFields: [] payment_flows_private_payment_methods_card_details_api_resource_multicapture: description: '' properties: status: description: Indicates whether or not multiple captures are supported. enum: - available - unavailable type: string required: - status title: PaymentFlowsPrivatePaymentMethodsCardDetailsAPIResourceMulticapture type: object x-expandableFields: [] payment_flows_private_payment_methods_klarna_dob: description: '' properties: day: description: 'The day of birth, between 1 and 31.' nullable: true type: integer month: description: 'The month of birth, between 1 and 12.' nullable: true type: integer year: description: The four-digit year of birth. nullable: true type: integer title: PaymentFlowsPrivatePaymentMethodsKlarnaDOB type: object x-expandableFields: [] payment_intent: description: >- 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) properties: amount: description: >- 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). type: integer amount_capturable: description: Amount that can be captured from this PaymentIntent. type: integer amount_details: $ref: '#/components/schemas/payment_flows_amount_details' amount_received: description: Amount that this PaymentIntent collects. type: integer application: anyOf: - maxLength: 5000 type: string - $ref: '#/components/schemas/application' description: ID of the Connect application that created the PaymentIntent. nullable: true x-expansionResources: oneOf: - $ref: '#/components/schemas/application' application_fee_amount: description: >- 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). nullable: true type: integer automatic_payment_methods: anyOf: - $ref: >- #/components/schemas/payment_flows_automatic_payment_methods_payment_intent description: >- Settings to configure compatible payment methods from the [Stripe Dashboard](https://dashboard.stripe.com/settings/payment_methods) nullable: true canceled_at: description: >- Populated when `status` is `canceled`, this is the time at which the PaymentIntent was canceled. Measured in seconds since the Unix epoch. format: unix-time nullable: true type: integer cancellation_reason: description: >- 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`). enum: - abandoned - automatic - duplicate - failed_invoice - fraudulent - requested_by_customer - void_invoice nullable: true type: string capture_method: description: >- Controls when the funds will be captured from the customer's account. enum: - automatic - automatic_async - manual type: string client_secret: description: >- 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. maxLength: 5000 nullable: true type: string confirmation_method: description: >- Describes whether we can confirm this PaymentIntent automatically, or if it requires customer action to confirm the payment. enum: - automatic - manual type: string created: description: >- Time at which the object was created. Measured in seconds since the Unix epoch. format: unix-time type: integer currency: description: >- 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). type: string customer: anyOf: - maxLength: 5000 type: string - $ref: '#/components/schemas/customer' - $ref: '#/components/schemas/deleted_customer' description: >- ID of the Customer this PaymentIntent belongs to, if one exists. Payment methods attached to other Customers cannot be used with this PaymentIntent. If present in combination with [setup_future_usage](https://stripe.com/docs/api#payment_intent_object-setup_future_usage), this PaymentIntent's payment method will be attached to the Customer after the PaymentIntent has been confirmed and any required actions from the user are complete. nullable: true x-expansionResources: oneOf: - $ref: '#/components/schemas/customer' - $ref: '#/components/schemas/deleted_customer' description: description: >- An arbitrary string attached to the object. Often useful for displaying to users. maxLength: 5000 nullable: true type: string id: description: Unique identifier for the object. maxLength: 5000 type: string invoice: anyOf: - maxLength: 5000 type: string - $ref: '#/components/schemas/invoice' description: 'ID of the invoice that created this PaymentIntent, if it exists.' nullable: true x-expansionResources: oneOf: - $ref: '#/components/schemas/invoice' last_payment_error: anyOf: - $ref: '#/components/schemas/api_errors' description: >- The payment error encountered in the previous PaymentIntent confirmation. It will be cleared if the PaymentIntent is later updated for any reason. nullable: true latest_charge: anyOf: - maxLength: 5000 type: string - $ref: '#/components/schemas/charge' description: The latest charge created by this PaymentIntent. nullable: true x-expansionResources: oneOf: - $ref: '#/components/schemas/charge' livemode: description: >- Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. type: boolean metadata: additionalProperties: maxLength: 500 type: string description: >- 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). type: object next_action: anyOf: - $ref: '#/components/schemas/payment_intent_next_action' description: >- If present, this property tells you what actions you need to take in order for your customer to fulfill a payment using the provided source. nullable: true object: description: >- String representing the object's type. Objects of the same type share the same value. enum: - payment_intent type: string on_behalf_of: anyOf: - maxLength: 5000 type: string - $ref: '#/components/schemas/account' description: >- 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. nullable: true x-expansionResources: oneOf: - $ref: '#/components/schemas/account' payment_method: anyOf: - maxLength: 5000 type: string - $ref: '#/components/schemas/payment_method' description: ID of the payment method used in this PaymentIntent. nullable: true x-expansionResources: oneOf: - $ref: '#/components/schemas/payment_method' payment_method_configuration_details: anyOf: - $ref: >- #/components/schemas/payment_method_config_biz_payment_method_configuration_details description: >- Information about the payment method configuration used for this PaymentIntent. nullable: true payment_method_options: anyOf: - $ref: '#/components/schemas/payment_intent_payment_method_options' description: Payment-method-specific configuration for this PaymentIntent. nullable: true payment_method_types: description: >- The list of payment method types (e.g. card) that this PaymentIntent is allowed to use. items: maxLength: 5000 type: string type: array processing: anyOf: - $ref: '#/components/schemas/payment_intent_processing' description: >- If present, this property tells you about the processing state of the payment. nullable: true receipt_email: description: >- Email address that the receipt for the resulting payment will be sent to. If `receipt_email` is specified for a payment in live mode, a receipt will be sent regardless of your [email settings](https://dashboard.stripe.com/account/emails). maxLength: 5000 nullable: true type: string review: anyOf: - maxLength: 5000 type: string - $ref: '#/components/schemas/review' description: 'ID of the review associated with this PaymentIntent, if any.' nullable: true x-expansionResources: oneOf: - $ref: '#/components/schemas/review' setup_future_usage: description: >- Indicates that you intend to make future payments with this PaymentIntent's payment method. Providing this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes. When processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication). enum: - off_session - on_session nullable: true type: string shipping: anyOf: - $ref: '#/components/schemas/shipping' description: Shipping information for this PaymentIntent. nullable: true statement_descriptor: description: >- For card charges, use [statement_descriptor_suffix](https://stripe.com/docs/payments/account/statement-descriptors#dynamic). Otherwise, you can use this value as the complete description of a charge on your customers' statements. It must contain at least one letter and be 1–22 characters long. maxLength: 5000 nullable: true type: string statement_descriptor_suffix: description: >- Provides information about a card payment that customers see on their statements. Concatenated with the prefix (shortened descriptor) or statement descriptor that’s set on the account to form the complete statement descriptor. Maximum 22 characters for the concatenated descriptor. maxLength: 5000 nullable: true type: string status: description: >- Status of this PaymentIntent, one of `requires_payment_method`, `requires_confirmation`, `requires_action`, `processing`, `requires_capture`, `canceled`, or `succeeded`. Read more about each PaymentIntent [status](https://stripe.com/docs/payments/intents#intent-statuses). enum: - canceled - processing - requires_action - requires_capture - requires_confirmation - requires_payment_method - succeeded type: string transfer_data: anyOf: - $ref: '#/components/schemas/transfer_data' description: >- The data that automatically creates a Transfer after the payment finalizes. Learn more about the [use case for connected accounts](https://stripe.com/docs/payments/connected-accounts). nullable: true transfer_group: description: >- A string that identifies the resulting payment as part of a group. Learn more about the [use case for connected accounts](https://stripe.com/docs/connect/separate-charges-and-transfers). maxLength: 5000 nullable: true type: string required: - amount - capture_method - confirmation_method - created - currency - id - livemode - object - payment_method_types - status title: PaymentIntent type: object x-expandableFields: - amount_details - application - automatic_payment_methods - customer - invoice - last_payment_error - latest_charge - next_action - on_behalf_of - payment_method - payment_method_configuration_details - payment_method_options - processing - review - shipping - transfer_data x-resourceId: payment_intent payment_intent_card_processing: description: '' properties: customer_notification: $ref: '#/components/schemas/payment_intent_processing_customer_notification' title: PaymentIntentCardProcessing type: object x-expandableFields: - customer_notification payment_intent_next_action: description: '' properties: alipay_handle_redirect: $ref: >- #/components/schemas/payment_intent_next_action_alipay_handle_redirect boleto_display_details: $ref: '#/components/schemas/payment_intent_next_action_boleto' card_await_notification: $ref: >- #/components/schemas/payment_intent_next_action_card_await_notification cashapp_handle_redirect_or_display_qr_code: $ref: >- #/components/schemas/payment_intent_next_action_cashapp_handle_redirect_or_display_qr_code display_bank_transfer_instructions: $ref: >- #/components/schemas/payment_intent_next_action_display_bank_transfer_instructions konbini_display_details: $ref: '#/components/schemas/payment_intent_next_action_konbini' oxxo_display_details: $ref: '#/components/schemas/payment_intent_next_action_display_oxxo_details' paynow_display_qr_code: $ref: >- #/components/schemas/payment_intent_next_action_paynow_display_qr_code pix_display_qr_code: $ref: '#/components/schemas/payment_intent_next_action_pix_display_qr_code' promptpay_display_qr_code: $ref: >- #/components/schemas/payment_intent_next_action_promptpay_display_qr_code redirect_to_url: $ref: '#/components/schemas/payment_intent_next_action_redirect_to_url' swish_handle_redirect_or_display_qr_code: $ref: >- #/components/schemas/payment_intent_next_action_swish_handle_redirect_or_display_qr_code type: description: >- 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`. maxLength: 5000 type: string use_stripe_sdk: description: >- 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. type: object verify_with_microdeposits: $ref: >- #/components/schemas/payment_intent_next_action_verify_with_microdeposits wechat_pay_display_qr_code: $ref: >- #/components/schemas/payment_intent_next_action_wechat_pay_display_qr_code wechat_pay_redirect_to_android_app: $ref: >- #/components/schemas/payment_intent_next_action_wechat_pay_redirect_to_android_app wechat_pay_redirect_to_ios_app: $ref: >- #/components/schemas/payment_intent_next_action_wechat_pay_redirect_to_ios_app required: - type title: PaymentIntentNextAction type: object x-expandableFields: - alipay_handle_redirect - boleto_display_details - card_await_notification - cashapp_handle_redirect_or_display_qr_code - display_bank_transfer_instructions - konbini_display_details - oxxo_display_details - paynow_display_qr_code - pix_display_qr_code - promptpay_display_qr_code - redirect_to_url - swish_handle_redirect_or_display_qr_code - verify_with_microdeposits - wechat_pay_display_qr_code - wechat_pay_redirect_to_android_app - wechat_pay_redirect_to_ios_app payment_intent_next_action_alipay_handle_redirect: description: '' properties: native_data: description: >- 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. maxLength: 5000 nullable: true type: string native_url: description: >- The native URL you must redirect your customer to in order to authenticate the payment in an iOS App. maxLength: 5000 nullable: true type: string return_url: description: >- If the customer does not exit their browser while authenticating, they will be redirected to this specified URL after completion. maxLength: 5000 nullable: true type: string url: description: >- The URL you must redirect your customer to in order to authenticate the payment. maxLength: 5000 nullable: true type: string title: PaymentIntentNextActionAlipayHandleRedirect type: object x-expandableFields: [] payment_intent_next_action_boleto: description: '' properties: expires_at: description: The timestamp after which the boleto expires. format: unix-time nullable: true type: integer hosted_voucher_url: description: >- The URL to the hosted boleto voucher page, which allows customers to view the boleto voucher. maxLength: 5000 nullable: true type: string number: description: The boleto number. maxLength: 5000 nullable: true type: string pdf: description: The URL to the downloadable boleto voucher PDF. maxLength: 5000 nullable: true type: string title: payment_intent_next_action_boleto type: object x-expandableFields: [] payment_intent_next_action_card_await_notification: description: '' properties: charge_attempt_at: description: >- The time that payment will be attempted. If customer approval is required, they need to provide approval before this time. format: unix-time nullable: true type: integer customer_approval_required: description: >- 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. nullable: true type: boolean title: PaymentIntentNextActionCardAwaitNotification type: object x-expandableFields: [] payment_intent_next_action_cashapp_handle_redirect_or_display_qr_code: description: '' properties: hosted_instructions_url: description: >- 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. maxLength: 5000 type: string mobile_auth_url: description: The url for mobile redirect based auth maxLength: 5000 type: string qr_code: $ref: '#/components/schemas/payment_intent_next_action_cashapp_qr_code' required: - hosted_instructions_url - mobile_auth_url - qr_code title: PaymentIntentNextActionCashappHandleRedirectOrDisplayQrCode type: object x-expandableFields: - qr_code payment_intent_next_action_cashapp_qr_code: description: '' properties: expires_at: description: The date (unix timestamp) when the QR code expires. format: unix-time type: integer image_url_png: description: The image_url_png string used to render QR code maxLength: 5000 type: string image_url_svg: description: The image_url_svg string used to render QR code maxLength: 5000 type: string required: - expires_at - image_url_png - image_url_svg title: PaymentIntentNextActionCashappQRCode type: object x-expandableFields: [] payment_intent_next_action_display_bank_transfer_instructions: description: '' properties: amount_remaining: description: >- The remaining amount that needs to be transferred to complete the payment. nullable: true type: integer currency: description: >- 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). nullable: true type: string financial_addresses: description: >- A list of financial addresses that can be used to fund the customer balance items: $ref: >- #/components/schemas/funding_instructions_bank_transfer_financial_address type: array hosted_instructions_url: description: >- A link to a hosted page that guides your customer through completing the transfer. maxLength: 5000 nullable: true type: string reference: description: >- A string identifying this payment. Instruct your customer to include this code in the reference or memo field of their bank transfer. maxLength: 5000 nullable: true type: string type: description: Type of bank transfer enum: - eu_bank_transfer - gb_bank_transfer - jp_bank_transfer - mx_bank_transfer - us_bank_transfer type: string x-stripeBypassValidation: true required: - type title: PaymentIntentNextActionDisplayBankTransferInstructions type: object x-expandableFields: - financial_addresses payment_intent_next_action_display_oxxo_details: description: '' properties: expires_after: description: The timestamp after which the OXXO voucher expires. format: unix-time nullable: true type: integer hosted_voucher_url: description: >- The URL for the hosted OXXO voucher page, which allows customers to view and print an OXXO voucher. maxLength: 5000 nullable: true type: string number: description: OXXO reference number. maxLength: 5000 nullable: true type: string title: PaymentIntentNextActionDisplayOxxoDetails type: object x-expandableFields: [] payment_intent_next_action_konbini: description: '' properties: expires_at: description: The timestamp at which the pending Konbini payment expires. format: unix-time type: integer hosted_voucher_url: description: >- The URL for the Konbini payment instructions page, which allows customers to view and print a Konbini voucher. maxLength: 5000 nullable: true type: string stores: $ref: '#/components/schemas/payment_intent_next_action_konbini_stores' required: - expires_at - stores title: payment_intent_next_action_konbini type: object x-expandableFields: - stores payment_intent_next_action_konbini_familymart: description: '' properties: confirmation_number: description: The confirmation number. maxLength: 5000 type: string payment_code: description: The payment code. maxLength: 5000 type: string required: - payment_code title: payment_intent_next_action_konbini_familymart type: object x-expandableFields: [] payment_intent_next_action_konbini_lawson: description: '' properties: confirmation_number: description: The confirmation number. maxLength: 5000 type: string payment_code: description: The payment code. maxLength: 5000 type: string required: - payment_code title: payment_intent_next_action_konbini_lawson type: object x-expandableFields: [] payment_intent_next_action_konbini_ministop: description: '' properties: confirmation_number: description: The confirmation number. maxLength: 5000 type: string payment_code: description: The payment code. maxLength: 5000 type: string required: - payment_code title: payment_intent_next_action_konbini_ministop type: object x-expandableFields: [] payment_intent_next_action_konbini_seicomart: description: '' properties: confirmation_number: description: The confirmation number. maxLength: 5000 type: string payment_code: description: The payment code. maxLength: 5000 type: string required: - payment_code title: payment_intent_next_action_konbini_seicomart type: object x-expandableFields: [] payment_intent_next_action_konbini_stores: description: '' properties: familymart: anyOf: - $ref: >- #/components/schemas/payment_intent_next_action_konbini_familymart description: FamilyMart instruction details. nullable: true lawson: anyOf: - $ref: '#/components/schemas/payment_intent_next_action_konbini_lawson' description: Lawson instruction details. nullable: true ministop: anyOf: - $ref: '#/components/schemas/payment_intent_next_action_konbini_ministop' description: Ministop instruction details. nullable: true seicomart: anyOf: - $ref: >- #/components/schemas/payment_intent_next_action_konbini_seicomart description: Seicomart instruction details. nullable: true title: payment_intent_next_action_konbini_stores type: object x-expandableFields: - familymart - lawson - ministop - seicomart payment_intent_next_action_paynow_display_qr_code: description: '' properties: data: description: >- The raw data string used to generate QR code, it should be used together with QR code library. maxLength: 5000 type: string hosted_instructions_url: description: >- The URL to the hosted PayNow instructions page, which allows customers to view the PayNow QR code. maxLength: 5000 nullable: true type: string image_url_png: description: The image_url_png string used to render QR code maxLength: 5000 type: string image_url_svg: description: The image_url_svg string used to render QR code maxLength: 5000 type: string required: - data - image_url_png - image_url_svg title: PaymentIntentNextActionPaynowDisplayQrCode type: object x-expandableFields: [] payment_intent_next_action_pix_display_qr_code: description: '' properties: data: description: >- The raw data string used to generate QR code, it should be used together with QR code library. maxLength: 5000 type: string expires_at: description: The date (unix timestamp) when the PIX expires. type: integer hosted_instructions_url: description: >- The URL to the hosted pix instructions page, which allows customers to view the pix QR code. maxLength: 5000 type: string image_url_png: description: The image_url_png string used to render png QR code maxLength: 5000 type: string image_url_svg: description: The image_url_svg string used to render svg QR code maxLength: 5000 type: string title: PaymentIntentNextActionPixDisplayQrCode type: object x-expandableFields: [] payment_intent_next_action_promptpay_display_qr_code: description: '' properties: data: description: >- The raw data string used to generate QR code, it should be used together with QR code library. maxLength: 5000 type: string hosted_instructions_url: description: >- The URL to the hosted PromptPay instructions page, which allows customers to view the PromptPay QR code. maxLength: 5000 type: string image_url_png: description: >- The PNG path used to render the QR code, can be used as the source in an HTML img tag maxLength: 5000 type: string image_url_svg: description: >- The SVG path used to render the QR code, can be used as the source in an HTML img tag maxLength: 5000 type: string required: - data - hosted_instructions_url - image_url_png - image_url_svg title: PaymentIntentNextActionPromptpayDisplayQrCode type: object x-expandableFields: [] payment_intent_next_action_redirect_to_url: description: '' properties: return_url: description: >- If the customer does not exit their browser while authenticating, they will be redirected to this specified URL after completion. maxLength: 5000 nullable: true type: string url: description: >- The URL you must redirect your customer to in order to authenticate the payment. maxLength: 5000 nullable: true type: string title: PaymentIntentNextActionRedirectToUrl type: object x-expandableFields: [] payment_intent_next_action_swish_handle_redirect_or_display_qr_code: description: '' properties: hosted_instructions_url: description: >- The URL to the hosted Swish instructions page, which allows customers to view the QR code. maxLength: 5000 type: string qr_code: $ref: '#/components/schemas/payment_intent_next_action_swish_qr_code' required: - hosted_instructions_url - qr_code title: PaymentIntentNextActionSwishHandleRedirectOrDisplayQrCode type: object x-expandableFields: - qr_code payment_intent_next_action_swish_qr_code: description: '' properties: data: description: >- The raw data string used to generate QR code, it should be used together with QR code library. maxLength: 5000 type: string image_url_png: description: The image_url_png string used to render QR code maxLength: 5000 type: string image_url_svg: description: The image_url_svg string used to render QR code maxLength: 5000 type: string required: - data - image_url_png - image_url_svg title: PaymentIntentNextActionSwishQRCode type: object x-expandableFields: [] payment_intent_next_action_verify_with_microdeposits: description: '' properties: arrival_date: description: The timestamp when the microdeposits are expected to land. format: unix-time type: integer hosted_verification_url: description: >- The URL for the hosted verification page, which allows customers to verify their bank account. maxLength: 5000 type: string microdeposit_type: description: >- The type of the microdeposit sent to the customer. Used to distinguish between different verification methods. enum: - amounts - descriptor_code nullable: true type: string required: - arrival_date - hosted_verification_url title: PaymentIntentNextActionVerifyWithMicrodeposits type: object x-expandableFields: [] payment_intent_next_action_wechat_pay_display_qr_code: description: '' properties: data: description: The data being used to generate QR code maxLength: 5000 type: string hosted_instructions_url: description: >- The URL to the hosted WeChat Pay instructions page, which allows customers to view the WeChat Pay QR code. maxLength: 5000 type: string image_data_url: description: The base64 image data for a pre-generated QR code maxLength: 5000 type: string image_url_png: description: The image_url_png string used to render QR code maxLength: 5000 type: string image_url_svg: description: The image_url_svg string used to render QR code maxLength: 5000 type: string required: - data - hosted_instructions_url - image_data_url - image_url_png - image_url_svg title: PaymentIntentNextActionWechatPayDisplayQrCode type: object x-expandableFields: [] payment_intent_next_action_wechat_pay_redirect_to_android_app: description: '' properties: app_id: description: app_id is the APP ID registered on WeChat open platform maxLength: 5000 type: string nonce_str: description: nonce_str is a random string maxLength: 5000 type: string package: description: package is static value maxLength: 5000 type: string partner_id: description: an unique merchant ID assigned by WeChat Pay maxLength: 5000 type: string prepay_id: description: an unique trading ID assigned by WeChat Pay maxLength: 5000 type: string sign: description: A signature maxLength: 5000 type: string timestamp: description: Specifies the current time in epoch format maxLength: 5000 type: string required: - app_id - nonce_str - package - partner_id - prepay_id - sign - timestamp title: PaymentIntentNextActionWechatPayRedirectToAndroidApp type: object x-expandableFields: [] payment_intent_next_action_wechat_pay_redirect_to_ios_app: description: '' properties: native_url: description: An universal link that redirect to WeChat Pay app maxLength: 5000 type: string required: - native_url title: PaymentIntentNextActionWechatPayRedirectToIOSApp type: object x-expandableFields: [] payment_intent_payment_method_options: description: '' properties: acss_debit: anyOf: - $ref: >- #/components/schemas/payment_intent_payment_method_options_acss_debit - $ref: >- #/components/schemas/payment_intent_type_specific_payment_method_options_client affirm: anyOf: - $ref: '#/components/schemas/payment_method_options_affirm' - $ref: >- #/components/schemas/payment_intent_type_specific_payment_method_options_client afterpay_clearpay: anyOf: - $ref: '#/components/schemas/payment_method_options_afterpay_clearpay' - $ref: >- #/components/schemas/payment_intent_type_specific_payment_method_options_client alipay: anyOf: - $ref: '#/components/schemas/payment_method_options_alipay' - $ref: >- #/components/schemas/payment_intent_type_specific_payment_method_options_client amazon_pay: anyOf: - $ref: '#/components/schemas/payment_method_options_amazon_pay' - $ref: >- #/components/schemas/payment_intent_type_specific_payment_method_options_client au_becs_debit: anyOf: - $ref: >- #/components/schemas/payment_intent_payment_method_options_au_becs_debit - $ref: >- #/components/schemas/payment_intent_type_specific_payment_method_options_client bacs_debit: anyOf: - $ref: '#/components/schemas/payment_method_options_bacs_debit' - $ref: >- #/components/schemas/payment_intent_type_specific_payment_method_options_client bancontact: anyOf: - $ref: '#/components/schemas/payment_method_options_bancontact' - $ref: >- #/components/schemas/payment_intent_type_specific_payment_method_options_client blik: anyOf: - $ref: '#/components/schemas/payment_intent_payment_method_options_blik' - $ref: >- #/components/schemas/payment_intent_type_specific_payment_method_options_client boleto: anyOf: - $ref: '#/components/schemas/payment_method_options_boleto' - $ref: >- #/components/schemas/payment_intent_type_specific_payment_method_options_client card: anyOf: - $ref: '#/components/schemas/payment_intent_payment_method_options_card' - $ref: >- #/components/schemas/payment_intent_type_specific_payment_method_options_client card_present: anyOf: - $ref: '#/components/schemas/payment_method_options_card_present' - $ref: >- #/components/schemas/payment_intent_type_specific_payment_method_options_client cashapp: anyOf: - $ref: '#/components/schemas/payment_method_options_cashapp' - $ref: >- #/components/schemas/payment_intent_type_specific_payment_method_options_client customer_balance: anyOf: - $ref: '#/components/schemas/payment_method_options_customer_balance' - $ref: >- #/components/schemas/payment_intent_type_specific_payment_method_options_client eps: anyOf: - $ref: '#/components/schemas/payment_intent_payment_method_options_eps' - $ref: >- #/components/schemas/payment_intent_type_specific_payment_method_options_client fpx: anyOf: - $ref: '#/components/schemas/payment_method_options_fpx' - $ref: >- #/components/schemas/payment_intent_type_specific_payment_method_options_client giropay: anyOf: - $ref: '#/components/schemas/payment_method_options_giropay' - $ref: >- #/components/schemas/payment_intent_type_specific_payment_method_options_client grabpay: anyOf: - $ref: '#/components/schemas/payment_method_options_grabpay' - $ref: >- #/components/schemas/payment_intent_type_specific_payment_method_options_client ideal: anyOf: - $ref: '#/components/schemas/payment_method_options_ideal' - $ref: >- #/components/schemas/payment_intent_type_specific_payment_method_options_client interac_present: anyOf: - $ref: '#/components/schemas/payment_method_options_interac_present' - $ref: >- #/components/schemas/payment_intent_type_specific_payment_method_options_client klarna: anyOf: - $ref: '#/components/schemas/payment_method_options_klarna' - $ref: >- #/components/schemas/payment_intent_type_specific_payment_method_options_client konbini: anyOf: - $ref: '#/components/schemas/payment_method_options_konbini' - $ref: >- #/components/schemas/payment_intent_type_specific_payment_method_options_client link: anyOf: - $ref: '#/components/schemas/payment_intent_payment_method_options_link' - $ref: >- #/components/schemas/payment_intent_type_specific_payment_method_options_client mobilepay: anyOf: - $ref: >- #/components/schemas/payment_intent_payment_method_options_mobilepay - $ref: >- #/components/schemas/payment_intent_type_specific_payment_method_options_client oxxo: anyOf: - $ref: '#/components/schemas/payment_method_options_oxxo' - $ref: >- #/components/schemas/payment_intent_type_specific_payment_method_options_client p24: anyOf: - $ref: '#/components/schemas/payment_method_options_p24' - $ref: >- #/components/schemas/payment_intent_type_specific_payment_method_options_client paynow: anyOf: - $ref: '#/components/schemas/payment_method_options_paynow' - $ref: >- #/components/schemas/payment_intent_type_specific_payment_method_options_client paypal: anyOf: - $ref: '#/components/schemas/payment_method_options_paypal' - $ref: >- #/components/schemas/payment_intent_type_specific_payment_method_options_client pix: anyOf: - $ref: '#/components/schemas/payment_method_options_pix' - $ref: >- #/components/schemas/payment_intent_type_specific_payment_method_options_client promptpay: anyOf: - $ref: '#/components/schemas/payment_method_options_promptpay' - $ref: >- #/components/schemas/payment_intent_type_specific_payment_method_options_client revolut_pay: anyOf: - $ref: '#/components/schemas/payment_method_options_revolut_pay' - $ref: >- #/components/schemas/payment_intent_type_specific_payment_method_options_client sepa_debit: anyOf: - $ref: >- #/components/schemas/payment_intent_payment_method_options_sepa_debit - $ref: >- #/components/schemas/payment_intent_type_specific_payment_method_options_client sofort: anyOf: - $ref: '#/components/schemas/payment_method_options_sofort' - $ref: >- #/components/schemas/payment_intent_type_specific_payment_method_options_client swish: anyOf: - $ref: '#/components/schemas/payment_intent_payment_method_options_swish' - $ref: >- #/components/schemas/payment_intent_type_specific_payment_method_options_client us_bank_account: anyOf: - $ref: >- #/components/schemas/payment_intent_payment_method_options_us_bank_account - $ref: >- #/components/schemas/payment_intent_type_specific_payment_method_options_client wechat_pay: anyOf: - $ref: '#/components/schemas/payment_method_options_wechat_pay' - $ref: >- #/components/schemas/payment_intent_type_specific_payment_method_options_client zip: anyOf: - $ref: '#/components/schemas/payment_method_options_zip' - $ref: >- #/components/schemas/payment_intent_type_specific_payment_method_options_client title: PaymentIntentPaymentMethodOptions type: object x-expandableFields: - acss_debit - affirm - afterpay_clearpay - alipay - amazon_pay - au_becs_debit - bacs_debit - bancontact - blik - boleto - card - card_present - cashapp - customer_balance - eps - fpx - giropay - grabpay - ideal - interac_present - klarna - konbini - link - mobilepay - oxxo - p24 - paynow - paypal - pix - promptpay - revolut_pay - sepa_debit - sofort - swish - us_bank_account - wechat_pay - zip payment_intent_payment_method_options_acss_debit: description: '' properties: mandate_options: $ref: >- #/components/schemas/payment_intent_payment_method_options_mandate_options_acss_debit setup_future_usage: description: >- Indicates that you intend to make future payments with this PaymentIntent's payment method. Providing this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes. When processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication). enum: - none - off_session - on_session type: string verification_method: description: Bank account verification method. enum: - automatic - instant - microdeposits type: string x-stripeBypassValidation: true title: payment_intent_payment_method_options_acss_debit type: object x-expandableFields: - mandate_options payment_intent_payment_method_options_au_becs_debit: description: '' properties: setup_future_usage: description: >- Indicates that you intend to make future payments with this PaymentIntent's payment method. Providing this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes. When processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication). enum: - none - off_session - on_session type: string title: payment_intent_payment_method_options_au_becs_debit type: object x-expandableFields: [] payment_intent_payment_method_options_blik: description: '' properties: setup_future_usage: description: >- Indicates that you intend to make future payments with this PaymentIntent's payment method. Providing this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes. When processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication). enum: - none type: string x-stripeBypassValidation: true title: payment_intent_payment_method_options_blik type: object x-expandableFields: [] payment_intent_payment_method_options_card: description: '' properties: capture_method: description: >- Controls when the funds will be captured from the customer's account. enum: - manual type: string installments: anyOf: - $ref: '#/components/schemas/payment_method_options_card_installments' description: >- Installment details for this payment (Mexico only). For more information, see the [installments integration guide](https://stripe.com/docs/payments/installments). nullable: true mandate_options: anyOf: - $ref: '#/components/schemas/payment_method_options_card_mandate_options' description: >- Configuration options for setting up an eMandate for cards issued in India. nullable: true network: description: >- Selected network to process this payment intent on. Depends on the available networks of the card attached to the payment intent. Can be only set confirm-time. enum: - amex - cartes_bancaires - diners - discover - eftpos_au - interac - jcb - mastercard - unionpay - unknown - visa nullable: true type: string request_extended_authorization: description: >- Request ability to [capture beyond the standard authorization validity window](https://stripe.com/docs/payments/extended-authorization) for this PaymentIntent. enum: - if_available - never type: string request_incremental_authorization: description: >- Request ability to [increment the authorization](https://stripe.com/docs/payments/incremental-authorization) for this PaymentIntent. enum: - if_available - never type: string request_multicapture: description: >- Request ability to make [multiple captures](https://stripe.com/docs/payments/multicapture) for this PaymentIntent. enum: - if_available - never type: string request_overcapture: description: >- Request ability to [overcapture](https://stripe.com/docs/payments/overcapture) for this PaymentIntent. enum: - if_available - never type: string request_three_d_secure: description: >- We strongly recommend that you rely on our SCA Engine to automatically prompt your customers for authentication based on risk level and [other requirements](https://stripe.com/docs/strong-customer-authentication). However, if you wish to request 3D Secure based on logic from your own fraud engine, provide this option. If not provided, this value defaults to `automatic`. Read our guide on [manually requesting 3D Secure](https://stripe.com/docs/payments/3d-secure/authentication-flow#manual-three-ds) for more information on how this configuration interacts with Radar and our SCA Engine. enum: - any - automatic - challenge nullable: true type: string x-stripeBypassValidation: true require_cvc_recollection: description: >- When enabled, using a card that is attached to a customer will require the CVC to be provided again (i.e. using the cvc_token parameter). type: boolean setup_future_usage: description: >- Indicates that you intend to make future payments with this PaymentIntent's payment method. Providing this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes. When processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication). enum: - none - off_session - on_session type: string statement_descriptor_suffix_kana: description: >- Provides information about a card payment that customers see on their statements. Concatenated with the Kana prefix (shortened Kana descriptor) or Kana statement descriptor that’s set on the account to form the complete statement descriptor. Maximum 22 characters. On card statements, the *concatenation* of both prefix and suffix (including separators) will appear truncated to 22 characters. maxLength: 5000 type: string statement_descriptor_suffix_kanji: description: >- Provides information about a card payment that customers see on their statements. Concatenated with the Kanji prefix (shortened Kanji descriptor) or Kanji statement descriptor that’s set on the account to form the complete statement descriptor. Maximum 17 characters. On card statements, the *concatenation* of both prefix and suffix (including separators) will appear truncated to 17 characters. maxLength: 5000 type: string title: payment_intent_payment_method_options_card type: object x-expandableFields: - installments - mandate_options payment_intent_payment_method_options_eps: description: '' properties: setup_future_usage: description: >- Indicates that you intend to make future payments with this PaymentIntent's payment method. Providing this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes. When processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication). enum: - none type: string title: payment_intent_payment_method_options_eps type: object x-expandableFields: [] payment_intent_payment_method_options_link: description: '' properties: capture_method: description: >- Controls when the funds will be captured from the customer's account. enum: - manual type: string setup_future_usage: description: >- Indicates that you intend to make future payments with this PaymentIntent's payment method. Providing this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes. When processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication). enum: - none - off_session type: string title: payment_intent_payment_method_options_link type: object x-expandableFields: [] payment_intent_payment_method_options_mandate_options_acss_debit: description: '' properties: custom_mandate_url: description: A URL for custom mandate text maxLength: 5000 type: string interval_description: description: >- Description of the interval. Only required if the 'payment_schedule' parameter is 'interval' or 'combined'. maxLength: 5000 nullable: true type: string payment_schedule: description: Payment schedule for the mandate. enum: - combined - interval - sporadic nullable: true type: string transaction_type: description: Transaction type of the mandate. enum: - business - personal nullable: true type: string title: payment_intent_payment_method_options_mandate_options_acss_debit type: object x-expandableFields: [] payment_intent_payment_method_options_mandate_options_sepa_debit: description: '' properties: {} title: payment_intent_payment_method_options_mandate_options_sepa_debit type: object x-expandableFields: [] payment_intent_payment_method_options_mobilepay: description: '' properties: capture_method: description: >- Controls when the funds will be captured from the customer's account. enum: - manual type: string setup_future_usage: description: >- Indicates that you intend to make future payments with this PaymentIntent's payment method. Providing this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes. When processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication). enum: - none type: string title: payment_intent_payment_method_options_mobilepay type: object x-expandableFields: [] payment_intent_payment_method_options_sepa_debit: description: '' properties: mandate_options: $ref: >- #/components/schemas/payment_intent_payment_method_options_mandate_options_sepa_debit setup_future_usage: description: >- Indicates that you intend to make future payments with this PaymentIntent's payment method. Providing this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes. When processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication). enum: - none - off_session - on_session type: string title: payment_intent_payment_method_options_sepa_debit type: object x-expandableFields: - mandate_options payment_intent_payment_method_options_swish: description: '' properties: reference: description: >- The order ID displayed in the Swish app after the payment is authorized. maxLength: 35 nullable: true type: string setup_future_usage: description: >- Indicates that you intend to make future payments with this PaymentIntent's payment method. Providing this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes. When processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication). enum: - none type: string title: payment_intent_payment_method_options_swish type: object x-expandableFields: [] payment_intent_payment_method_options_us_bank_account: description: '' properties: financial_connections: $ref: '#/components/schemas/linked_account_options_us_bank_account' mandate_options: $ref: >- #/components/schemas/payment_method_options_us_bank_account_mandate_options preferred_settlement_speed: description: Preferred transaction settlement speed enum: - fastest - standard type: string setup_future_usage: description: >- Indicates that you intend to make future payments with this PaymentIntent's payment method. Providing this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes. When processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication). enum: - none - off_session - on_session type: string verification_method: description: Bank account verification method. enum: - automatic - instant - microdeposits type: string x-stripeBypassValidation: true title: payment_intent_payment_method_options_us_bank_account type: object x-expandableFields: - financial_connections - mandate_options payment_intent_processing: description: '' properties: card: $ref: '#/components/schemas/payment_intent_card_processing' type: description: >- Type of the payment method for which payment is in `processing` state, one of `card`. enum: - card type: string required: - type title: PaymentIntentProcessing type: object x-expandableFields: - card payment_intent_processing_customer_notification: description: '' properties: approval_requested: description: >- Whether customer approval has been requested for this payment. For payments greater than INR 15000 or mandate amount, the customer must provide explicit approval of the payment with their bank. nullable: true type: boolean completes_at: description: >- If customer approval is required, they need to provide approval before this time. format: unix-time nullable: true type: integer title: PaymentIntentProcessingCustomerNotification type: object x-expandableFields: [] payment_intent_type_specific_payment_method_options_client: description: '' properties: capture_method: description: >- Controls when the funds will be captured from the customer's account. enum: - manual - manual_preferred type: string installments: $ref: '#/components/schemas/payment_flows_installment_options' require_cvc_recollection: description: >- When enabled, using a card that is attached to a customer will require the CVC to be provided again (i.e. using the cvc_token parameter). type: boolean setup_future_usage: description: >- Indicates that you intend to make future payments with this PaymentIntent's payment method. Providing this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes. When processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication). enum: - none - off_session - on_session type: string verification_method: description: Bank account verification method. enum: - automatic - instant - microdeposits type: string x-stripeBypassValidation: true title: PaymentIntentTypeSpecificPaymentMethodOptionsClient type: object x-expandableFields: - installments payment_link: description: >- A payment link is a shareable URL that will take your customers to a hosted payment page. A payment link can be shared and used multiple times. When a customer opens a payment link it will open a new [checkout session](https://stripe.com/docs/api/checkout/sessions) to render the payment page. You can use [checkout session events](https://stripe.com/docs/api/events/types#event_types-checkout.session.completed) to track payments through payment links. Related guide: [Payment Links API](https://stripe.com/docs/payment-links) properties: active: description: >- Whether the payment link's `url` is active. If `false`, customers visiting the URL will be shown a page saying that the link has been deactivated. type: boolean after_completion: $ref: '#/components/schemas/payment_links_resource_after_completion' allow_promotion_codes: description: Whether user redeemable promotion codes are enabled. type: boolean application: anyOf: - maxLength: 5000 type: string - $ref: '#/components/schemas/application' - $ref: '#/components/schemas/deleted_application' description: The ID of the Connect application that created the Payment Link. nullable: true x-expansionResources: oneOf: - $ref: '#/components/schemas/application' - $ref: '#/components/schemas/deleted_application' application_fee_amount: description: >- 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. nullable: true type: integer application_fee_percent: description: >- This represents the percentage of the subscription invoice total that will be transferred to the application owner's Stripe account. nullable: true type: number automatic_tax: $ref: '#/components/schemas/payment_links_resource_automatic_tax' billing_address_collection: description: >- Configuration for collecting the customer's billing address. Defaults to `auto`. enum: - auto - required type: string consent_collection: anyOf: - $ref: '#/components/schemas/payment_links_resource_consent_collection' description: >- When set, provides configuration to gather active consent from customers. nullable: true currency: description: >- 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). type: string custom_fields: description: >- Collect additional information from your customer using custom fields. Up to 3 fields are supported. items: $ref: '#/components/schemas/payment_links_resource_custom_fields' type: array custom_text: $ref: '#/components/schemas/payment_links_resource_custom_text' customer_creation: description: Configuration for Customer creation during checkout. enum: - always - if_required type: string id: description: Unique identifier for the object. maxLength: 5000 type: string inactive_message: description: >- The custom message to be displayed to a customer when a payment link is no longer active. maxLength: 5000 nullable: true type: string invoice_creation: anyOf: - $ref: '#/components/schemas/payment_links_resource_invoice_creation' description: Configuration for creating invoice for payment mode payment links. nullable: true line_items: description: The line items representing what is being sold. properties: data: description: Details about each object. items: $ref: '#/components/schemas/item' type: array has_more: description: >- True if this list has another page of items after this one that can be fetched. type: boolean object: description: >- String representing the object's type. Objects of the same type share the same value. Always has the value `list`. enum: - list type: string url: description: The URL where this list can be accessed. maxLength: 5000 type: string required: - data - has_more - object - url title: PaymentLinksResourceListLineItems type: object x-expandableFields: - data livemode: description: >- Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. type: boolean metadata: additionalProperties: maxLength: 500 type: string description: >- 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. type: object object: description: >- String representing the object's type. Objects of the same type share the same value. enum: - payment_link type: string on_behalf_of: anyOf: - maxLength: 5000 type: string - $ref: '#/components/schemas/account' description: >- The account on behalf of which to charge. See the [Connect documentation](https://support.stripe.com/questions/sending-invoices-on-behalf-of-connected-accounts) for details. nullable: true x-expansionResources: oneOf: - $ref: '#/components/schemas/account' payment_intent_data: anyOf: - $ref: '#/components/schemas/payment_links_resource_payment_intent_data' description: >- Indicates the parameters to be passed to PaymentIntent creation during checkout. nullable: true payment_method_collection: description: >- Configuration for collecting a payment method during checkout. Defaults to `always`. enum: - always - if_required type: string payment_method_types: description: >- The list of payment method types that customers can use. When `null`, Stripe will dynamically show relevant payment methods you've enabled in your [payment method settings](https://dashboard.stripe.com/settings/payment_methods). items: enum: - affirm - afterpay_clearpay - alipay - au_becs_debit - bacs_debit - bancontact - blik - boleto - card - cashapp - eps - fpx - giropay - grabpay - ideal - klarna - konbini - link - oxxo - p24 - paynow - paypal - pix - promptpay - sepa_debit - sofort - swish - us_bank_account - wechat_pay type: string x-stripeBypassValidation: true nullable: true type: array phone_number_collection: $ref: '#/components/schemas/payment_links_resource_phone_number_collection' restrictions: anyOf: - $ref: '#/components/schemas/payment_links_resource_restrictions' description: Settings that restrict the usage of a payment link. nullable: true shipping_address_collection: anyOf: - $ref: >- #/components/schemas/payment_links_resource_shipping_address_collection description: Configuration for collecting the customer's shipping address. nullable: true shipping_options: description: The shipping rate options applied to the session. items: $ref: '#/components/schemas/payment_links_resource_shipping_option' type: array submit_type: description: >- Indicates the type of transaction being performed which customizes relevant text on the page, such as the submit button. enum: - auto - book - donate - pay type: string subscription_data: anyOf: - $ref: '#/components/schemas/payment_links_resource_subscription_data' description: >- When creating a subscription, the specified configuration data will be used. There must be at least one line item with a recurring price to use `subscription_data`. nullable: true tax_id_collection: $ref: '#/components/schemas/payment_links_resource_tax_id_collection' transfer_data: anyOf: - $ref: '#/components/schemas/payment_links_resource_transfer_data' description: >- The account (if any) the payments will be attributed to for tax reporting, and where funds from each payment will be transferred to. nullable: true url: description: The public URL that can be shared with customers. maxLength: 5000 type: string required: - active - after_completion - allow_promotion_codes - automatic_tax - billing_address_collection - currency - custom_fields - custom_text - customer_creation - id - livemode - metadata - object - payment_method_collection - phone_number_collection - shipping_options - submit_type - tax_id_collection - url title: PaymentLink type: object x-expandableFields: - after_completion - application - automatic_tax - consent_collection - custom_fields - custom_text - invoice_creation - line_items - on_behalf_of - payment_intent_data - phone_number_collection - restrictions - shipping_address_collection - shipping_options - subscription_data - tax_id_collection - transfer_data x-resourceId: payment_link payment_links_resource_after_completion: description: '' properties: hosted_confirmation: $ref: >- #/components/schemas/payment_links_resource_completion_behavior_confirmation_page redirect: $ref: >- #/components/schemas/payment_links_resource_completion_behavior_redirect type: description: The specified behavior after the purchase is complete. enum: - hosted_confirmation - redirect type: string required: - type title: PaymentLinksResourceAfterCompletion type: object x-expandableFields: - hosted_confirmation - redirect payment_links_resource_automatic_tax: description: '' properties: enabled: description: >- If `true`, tax will be calculated automatically using the customer's location. type: boolean liability: anyOf: - $ref: '#/components/schemas/connect_account_reference' description: >- The account that's liable for tax. If set, the business address and tax registrations required to perform the tax calculation are loaded from this account. The tax transaction is returned in the report of the connected account. nullable: true required: - enabled title: PaymentLinksResourceAutomaticTax type: object x-expandableFields: - liability payment_links_resource_completed_sessions: description: '' properties: count: description: >- The current number of checkout sessions that have been completed on the payment link which count towards the `completed_sessions` restriction to be met. type: integer limit: description: >- The maximum number of checkout sessions that can be completed for the `completed_sessions` restriction to be met. type: integer required: - count - limit title: PaymentLinksResourceCompletedSessions type: object x-expandableFields: [] payment_links_resource_completion_behavior_confirmation_page: description: '' properties: custom_message: description: >- The custom message that is displayed to the customer after the purchase is complete. maxLength: 5000 nullable: true type: string title: PaymentLinksResourceCompletionBehaviorConfirmationPage type: object x-expandableFields: [] payment_links_resource_completion_behavior_redirect: description: '' properties: url: description: >- The URL the customer will be redirected to after the purchase is complete. maxLength: 5000 type: string required: - url title: PaymentLinksResourceCompletionBehaviorRedirect type: object x-expandableFields: [] payment_links_resource_consent_collection: description: '' properties: payment_method_reuse_agreement: anyOf: - $ref: >- #/components/schemas/payment_links_resource_payment_method_reuse_agreement description: >- Settings related to the payment method reuse text shown in the Checkout UI. nullable: true promotions: description: >- If set to `auto`, enables the collection of customer consent for promotional communications. enum: - auto - none nullable: true type: string terms_of_service: description: >- If set to `required`, it requires cutomers to accept the terms of service before being able to pay. If set to `none`, customers won't be shown a checkbox to accept the terms of service. enum: - none - required nullable: true type: string title: PaymentLinksResourceConsentCollection type: object x-expandableFields: - payment_method_reuse_agreement payment_links_resource_custom_fields: description: '' properties: dropdown: $ref: '#/components/schemas/payment_links_resource_custom_fields_dropdown' key: description: >- String of your choice that your integration can use to reconcile this field. Must be unique to this field, alphanumeric, and up to 200 characters. maxLength: 5000 type: string label: $ref: '#/components/schemas/payment_links_resource_custom_fields_label' numeric: $ref: '#/components/schemas/payment_links_resource_custom_fields_numeric' optional: description: >- Whether the customer is required to complete the field before completing the Checkout Session. Defaults to `false`. type: boolean text: $ref: '#/components/schemas/payment_links_resource_custom_fields_text' type: description: The type of the field. enum: - dropdown - numeric - text type: string required: - key - label - optional - type title: PaymentLinksResourceCustomFields type: object x-expandableFields: - dropdown - label - numeric - text payment_links_resource_custom_fields_dropdown: description: '' properties: options: description: >- The options available for the customer to select. Up to 200 options allowed. items: $ref: >- #/components/schemas/payment_links_resource_custom_fields_dropdown_option type: array required: - options title: PaymentLinksResourceCustomFieldsDropdown type: object x-expandableFields: - options payment_links_resource_custom_fields_dropdown_option: description: '' properties: label: description: >- The label for the option, displayed to the customer. Up to 100 characters. maxLength: 5000 type: string value: description: >- The value for this option, not displayed to the customer, used by your integration to reconcile the option selected by the customer. Must be unique to this option, alphanumeric, and up to 100 characters. maxLength: 5000 type: string required: - label - value title: PaymentLinksResourceCustomFieldsDropdownOption type: object x-expandableFields: [] payment_links_resource_custom_fields_label: description: '' properties: custom: description: >- Custom text for the label, displayed to the customer. Up to 50 characters. maxLength: 5000 nullable: true type: string type: description: The type of the label. enum: - custom type: string required: - type title: PaymentLinksResourceCustomFieldsLabel type: object x-expandableFields: [] payment_links_resource_custom_fields_numeric: description: '' properties: maximum_length: description: The maximum character length constraint for the customer's input. nullable: true type: integer minimum_length: description: The minimum character length requirement for the customer's input. nullable: true type: integer title: PaymentLinksResourceCustomFieldsNumeric type: object x-expandableFields: [] payment_links_resource_custom_fields_text: description: '' properties: maximum_length: description: The maximum character length constraint for the customer's input. nullable: true type: integer minimum_length: description: The minimum character length requirement for the customer's input. nullable: true type: integer title: PaymentLinksResourceCustomFieldsText type: object x-expandableFields: [] payment_links_resource_custom_text: description: '' properties: after_submit: anyOf: - $ref: '#/components/schemas/payment_links_resource_custom_text_position' description: >- Custom text that should be displayed after the payment confirmation button. nullable: true shipping_address: anyOf: - $ref: '#/components/schemas/payment_links_resource_custom_text_position' description: >- Custom text that should be displayed alongside shipping address collection. nullable: true submit: anyOf: - $ref: '#/components/schemas/payment_links_resource_custom_text_position' description: >- Custom text that should be displayed alongside the payment confirmation button. nullable: true terms_of_service_acceptance: anyOf: - $ref: '#/components/schemas/payment_links_resource_custom_text_position' description: >- Custom text that should be displayed in place of the default terms of service agreement text. nullable: true title: PaymentLinksResourceCustomText type: object x-expandableFields: - after_submit - shipping_address - submit - terms_of_service_acceptance payment_links_resource_custom_text_position: description: '' properties: message: description: Text may be up to 1200 characters in length. maxLength: 500 type: string required: - message title: PaymentLinksResourceCustomTextPosition type: object x-expandableFields: [] payment_links_resource_invoice_creation: description: '' properties: enabled: description: Enable creating an invoice on successful payment. type: boolean invoice_data: anyOf: - $ref: '#/components/schemas/payment_links_resource_invoice_settings' description: >- Configuration for the invoice. Default invoice values will be used if unspecified. nullable: true required: - enabled title: PaymentLinksResourceInvoiceCreation type: object x-expandableFields: - invoice_data payment_links_resource_invoice_settings: description: '' properties: account_tax_ids: description: The account tax IDs associated with the invoice. items: anyOf: - maxLength: 5000 type: string - $ref: '#/components/schemas/tax_id' - $ref: '#/components/schemas/deleted_tax_id' x-expansionResources: oneOf: - $ref: '#/components/schemas/tax_id' - $ref: '#/components/schemas/deleted_tax_id' nullable: true type: array custom_fields: description: A list of up to 4 custom fields to be displayed on the invoice. items: $ref: '#/components/schemas/invoice_setting_custom_field' nullable: true type: array description: description: >- An arbitrary string attached to the object. Often useful for displaying to users. maxLength: 5000 nullable: true type: string footer: description: Footer to be displayed on the invoice. maxLength: 5000 nullable: true type: string issuer: anyOf: - $ref: '#/components/schemas/connect_account_reference' description: >- The connected account that issues the invoice. The invoice is presented with the branding and support information of the specified account. nullable: true metadata: additionalProperties: maxLength: 500 type: string description: >- 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. nullable: true type: object rendering_options: anyOf: - $ref: '#/components/schemas/invoice_setting_rendering_options' description: Options for invoice PDF rendering. nullable: true title: PaymentLinksResourceInvoiceSettings type: object x-expandableFields: - account_tax_ids - custom_fields - issuer - rendering_options payment_links_resource_payment_intent_data: description: '' properties: capture_method: description: >- Indicates when the funds will be captured from the customer's account. enum: - automatic - automatic_async - manual nullable: true type: string description: description: >- An arbitrary string attached to the object. Often useful for displaying to users. maxLength: 5000 nullable: true type: string metadata: additionalProperties: maxLength: 500 type: string description: >- Set of [key-value pairs](https://stripe.com/docs/api/metadata) that will set metadata on [Payment Intents](https://stripe.com/docs/api/payment_intents) generated from this payment link. type: object setup_future_usage: description: >- Indicates that you intend to make future payments with the payment method collected during checkout. enum: - off_session - on_session nullable: true type: string statement_descriptor: description: >- Extra information about the payment. This will appear on your customer's statement when this payment succeeds in creating a charge. maxLength: 5000 nullable: true type: string statement_descriptor_suffix: description: >- Provides information about the charge that customers see on their statements. Concatenated with the prefix (shortened descriptor) or statement descriptor that's set on the account to form the complete statement descriptor. Maximum 22 characters for the concatenated descriptor. maxLength: 5000 nullable: true type: string transfer_group: description: >- A string that identifies the resulting payment as part of a group. See the PaymentIntents [use case for connected accounts](https://stripe.com/docs/connect/separate-charges-and-transfers) for details. maxLength: 5000 nullable: true type: string required: - metadata title: PaymentLinksResourcePaymentIntentData type: object x-expandableFields: [] payment_links_resource_payment_method_reuse_agreement: description: '' properties: position: description: >- Determines the position and visibility of the payment method reuse agreement in the UI. When set to `auto`, Stripe's defaults will be used. When set to `hidden`, the payment method reuse agreement text will always be hidden in the UI. enum: - auto - hidden type: string required: - position title: PaymentLinksResourcePaymentMethodReuseAgreement type: object x-expandableFields: [] payment_links_resource_phone_number_collection: description: '' properties: enabled: description: 'If `true`, a phone number will be collected during checkout.' type: boolean required: - enabled title: PaymentLinksResourcePhoneNumberCollection type: object x-expandableFields: [] payment_links_resource_restrictions: description: '' properties: completed_sessions: $ref: '#/components/schemas/payment_links_resource_completed_sessions' required: - completed_sessions title: PaymentLinksResourceRestrictions type: object x-expandableFields: - completed_sessions payment_links_resource_shipping_address_collection: description: '' properties: allowed_countries: description: >- An array of two-letter ISO country codes representing which countries Checkout should provide as options for shipping locations. Unsupported country codes: `AS, CX, CC, CU, HM, IR, KP, MH, FM, NF, MP, PW, SD, SY, UM, VI`. items: enum: - AC - AD - AE - AF - AG - AI - AL - AM - AO - AQ - AR - AT - AU - AW - AX - AZ - BA - BB - BD - BE - BF - BG - BH - BI - BJ - BL - BM - BN - BO - BQ - BR - BS - BT - BV - BW - BY - BZ - CA - CD - CF - CG - CH - CI - CK - CL - CM - CN - CO - CR - CV - CW - CY - CZ - DE - DJ - DK - DM - DO - DZ - EC - EE - EG - EH - ER - ES - ET - FI - FJ - FK - FO - FR - GA - GB - GD - GE - GF - GG - GH - GI - GL - GM - GN - GP - GQ - GR - GS - GT - GU - GW - GY - HK - HN - HR - HT - HU - ID - IE - IL - IM - IN - IO - IQ - IS - IT - JE - JM - JO - JP - KE - KG - KH - KI - KM - KN - KR - KW - KY - KZ - LA - LB - LC - LI - LK - LR - LS - LT - LU - LV - LY - MA - MC - MD - ME - MF - MG - MK - ML - MM - MN - MO - MQ - MR - MS - MT - MU - MV - MW - MX - MY - MZ - NA - NC - NE - NG - NI - NL - 'NO' - NP - NR - NU - NZ - OM - PA - PE - PF - PG - PH - PK - PL - PM - PN - PR - PS - PT - PY - QA - RE - RO - RS - RU - RW - SA - SB - SC - SE - SG - SH - SI - SJ - SK - SL - SM - SN - SO - SR - SS - ST - SV - SX - SZ - TA - TC - TD - TF - TG - TH - TJ - TK - TL - TM - TN - TO - TR - TT - TV - TW - TZ - UA - UG - US - UY - UZ - VA - VC - VE - VG - VN - VU - WF - WS - XK - YE - YT - ZA - ZM - ZW - ZZ type: string type: array required: - allowed_countries title: PaymentLinksResourceShippingAddressCollection type: object x-expandableFields: [] payment_links_resource_shipping_option: description: '' properties: shipping_amount: description: A non-negative integer in cents representing how much to charge. type: integer shipping_rate: anyOf: - maxLength: 5000 type: string - $ref: '#/components/schemas/shipping_rate' description: The ID of the Shipping Rate to use for this shipping option. x-expansionResources: oneOf: - $ref: '#/components/schemas/shipping_rate' required: - shipping_amount - shipping_rate title: PaymentLinksResourceShippingOption type: object x-expandableFields: - shipping_rate payment_links_resource_subscription_data: description: '' properties: description: description: >- 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. maxLength: 5000 nullable: true type: string invoice_settings: $ref: >- #/components/schemas/payment_links_resource_subscription_data_invoice_settings metadata: additionalProperties: maxLength: 500 type: string description: >- Set of [key-value pairs](https://stripe.com/docs/api/metadata) that will set metadata on [Subscriptions](https://stripe.com/docs/api/subscriptions) generated from this payment link. type: object trial_period_days: description: >- Integer representing the number of trial period days before the customer is charged for the first time. nullable: true type: integer trial_settings: anyOf: - $ref: >- #/components/schemas/subscriptions_trials_resource_trial_settings description: Settings related to subscription trials. nullable: true required: - invoice_settings - metadata title: PaymentLinksResourceSubscriptionData type: object x-expandableFields: - invoice_settings - trial_settings payment_links_resource_subscription_data_invoice_settings: description: '' properties: issuer: $ref: '#/components/schemas/connect_account_reference' required: - issuer title: PaymentLinksResourceSubscriptionDataInvoiceSettings type: object x-expandableFields: - issuer payment_links_resource_tax_id_collection: description: '' properties: enabled: description: Indicates whether tax ID collection is enabled for the session. type: boolean required: - enabled title: PaymentLinksResourceTaxIdCollection type: object x-expandableFields: [] payment_links_resource_transfer_data: description: '' properties: amount: description: >- The amount in cents (or local equivalent) that will be transferred to the destination account. By default, the entire amount is transferred to the destination. nullable: true type: integer destination: anyOf: - maxLength: 5000 type: string - $ref: '#/components/schemas/account' description: The connected account receiving the transfer. x-expansionResources: oneOf: - $ref: '#/components/schemas/account' required: - destination title: PaymentLinksResourceTransferData type: object x-expandableFields: - destination payment_method: description: >- 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). properties: acss_debit: $ref: '#/components/schemas/payment_method_acss_debit' affirm: $ref: '#/components/schemas/payment_method_affirm' afterpay_clearpay: $ref: '#/components/schemas/payment_method_afterpay_clearpay' alipay: $ref: '#/components/schemas/payment_flows_private_payment_methods_alipay' amazon_pay: $ref: '#/components/schemas/payment_method_amazon_pay' au_becs_debit: $ref: '#/components/schemas/payment_method_au_becs_debit' bacs_debit: $ref: '#/components/schemas/payment_method_bacs_debit' bancontact: $ref: '#/components/schemas/payment_method_bancontact' billing_details: $ref: '#/components/schemas/billing_details' blik: $ref: '#/components/schemas/payment_method_blik' boleto: $ref: '#/components/schemas/payment_method_boleto' card: $ref: '#/components/schemas/payment_method_card' card_present: $ref: '#/components/schemas/payment_method_card_present' cashapp: $ref: '#/components/schemas/payment_method_cashapp' created: description: >- Time at which the object was created. Measured in seconds since the Unix epoch. format: unix-time type: integer customer: anyOf: - maxLength: 5000 type: string - $ref: '#/components/schemas/customer' description: >- 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. nullable: true x-expansionResources: oneOf: - $ref: '#/components/schemas/customer' customer_balance: $ref: '#/components/schemas/payment_method_customer_balance' eps: $ref: '#/components/schemas/payment_method_eps' fpx: $ref: '#/components/schemas/payment_method_fpx' giropay: $ref: '#/components/schemas/payment_method_giropay' grabpay: $ref: '#/components/schemas/payment_method_grabpay' id: description: Unique identifier for the object. maxLength: 5000 type: string ideal: $ref: '#/components/schemas/payment_method_ideal' interac_present: $ref: '#/components/schemas/payment_method_interac_present' klarna: $ref: '#/components/schemas/payment_method_klarna' konbini: $ref: '#/components/schemas/payment_method_konbini' link: $ref: '#/components/schemas/payment_method_link' livemode: description: >- Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. type: boolean metadata: additionalProperties: maxLength: 500 type: string description: >- 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. nullable: true type: object mobilepay: $ref: '#/components/schemas/payment_method_mobilepay' object: description: >- String representing the object's type. Objects of the same type share the same value. enum: - payment_method type: string oxxo: $ref: '#/components/schemas/payment_method_oxxo' p24: $ref: '#/components/schemas/payment_method_p24' paynow: $ref: '#/components/schemas/payment_method_paynow' paypal: $ref: '#/components/schemas/payment_method_paypal' pix: $ref: '#/components/schemas/payment_method_pix' promptpay: $ref: '#/components/schemas/payment_method_promptpay' radar_options: $ref: '#/components/schemas/radar_radar_options' revolut_pay: $ref: '#/components/schemas/payment_method_revolut_pay' sepa_debit: $ref: '#/components/schemas/payment_method_sepa_debit' sofort: $ref: '#/components/schemas/payment_method_sofort' swish: $ref: '#/components/schemas/payment_method_swish' type: description: >- 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. enum: - acss_debit - affirm - afterpay_clearpay - alipay - amazon_pay - au_becs_debit - bacs_debit - bancontact - blik - boleto - card - card_present - cashapp - customer_balance - eps - fpx - giropay - grabpay - ideal - interac_present - klarna - konbini - link - mobilepay - oxxo - p24 - paynow - paypal - pix - promptpay - revolut_pay - sepa_debit - sofort - swish - us_bank_account - wechat_pay - zip type: string x-stripeBypassValidation: true us_bank_account: $ref: '#/components/schemas/payment_method_us_bank_account' wechat_pay: $ref: '#/components/schemas/payment_method_wechat_pay' zip: $ref: '#/components/schemas/payment_method_zip' required: - billing_details - created - id - livemode - object - type title: PaymentMethod type: object x-expandableFields: - acss_debit - affirm - afterpay_clearpay - alipay - amazon_pay - au_becs_debit - bacs_debit - bancontact - billing_details - blik - boleto - card - card_present - cashapp - customer - customer_balance - eps - fpx - giropay - grabpay - ideal - interac_present - klarna - konbini - link - mobilepay - oxxo - p24 - paynow - paypal - pix - promptpay - radar_options - revolut_pay - sepa_debit - sofort - swish - us_bank_account - wechat_pay - zip x-resourceId: payment_method payment_method_acss_debit: description: '' properties: bank_name: description: Name of the bank associated with the bank account. maxLength: 5000 nullable: true type: string fingerprint: description: >- Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same. maxLength: 5000 nullable: true type: string institution_number: description: Institution number of the bank account. maxLength: 5000 nullable: true type: string last4: description: Last four digits of the bank account number. maxLength: 5000 nullable: true type: string transit_number: description: Transit number of the bank account. maxLength: 5000 nullable: true type: string title: payment_method_acss_debit type: object x-expandableFields: [] payment_method_affirm: description: '' properties: {} title: payment_method_affirm type: object x-expandableFields: [] payment_method_afterpay_clearpay: description: '' properties: {} title: payment_method_afterpay_clearpay type: object x-expandableFields: [] payment_method_amazon_pay: description: '' properties: {} title: payment_method_amazon_pay type: object x-expandableFields: [] payment_method_au_becs_debit: description: '' properties: bsb_number: description: >- Six-digit number identifying bank and branch associated with this bank account. maxLength: 5000 nullable: true type: string fingerprint: description: >- Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same. maxLength: 5000 nullable: true type: string last4: description: Last four digits of the bank account number. maxLength: 5000 nullable: true type: string title: payment_method_au_becs_debit type: object x-expandableFields: [] payment_method_bacs_debit: description: '' properties: fingerprint: description: >- Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same. maxLength: 5000 nullable: true type: string last4: description: Last four digits of the bank account number. maxLength: 5000 nullable: true type: string sort_code: description: 'Sort code of the bank account. (e.g., `10-20-30`)' maxLength: 5000 nullable: true type: string title: payment_method_bacs_debit type: object x-expandableFields: [] payment_method_bancontact: description: '' properties: {} title: payment_method_bancontact type: object x-expandableFields: [] payment_method_blik: description: '' properties: {} title: payment_method_blik type: object x-expandableFields: [] payment_method_boleto: description: '' properties: tax_id: description: Uniquely identifies the customer tax id (CNPJ or CPF) maxLength: 5000 type: string required: - tax_id title: payment_method_boleto type: object x-expandableFields: [] payment_method_card: description: '' properties: brand: description: >- Card brand. Can be `amex`, `diners`, `discover`, `eftpos_au`, `jcb`, `mastercard`, `unionpay`, `visa`, or `unknown`. maxLength: 5000 type: string checks: anyOf: - $ref: '#/components/schemas/payment_method_card_checks' description: Checks on Card address and CVC if provided. nullable: true country: description: >- 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. maxLength: 5000 nullable: true type: string display_brand: description: >- 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. maxLength: 5000 nullable: true type: string exp_month: description: Two-digit number representing the card's expiration month. type: integer exp_year: description: Four-digit number representing the card's expiration year. type: integer fingerprint: description: >- 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.* maxLength: 5000 nullable: true type: string funding: description: >- Card funding type. Can be `credit`, `debit`, `prepaid`, or `unknown`. maxLength: 5000 type: string generated_from: anyOf: - $ref: '#/components/schemas/payment_method_card_generated_card' description: Details of the original PaymentMethod that created this object. nullable: true last4: description: The last four digits of the card. maxLength: 5000 type: string networks: anyOf: - $ref: '#/components/schemas/networks' description: >- Contains information about card networks that can be used to process the payment. nullable: true three_d_secure_usage: anyOf: - $ref: '#/components/schemas/three_d_secure_usage' description: >- Contains details on how this Card may be used for 3D Secure authentication. nullable: true wallet: anyOf: - $ref: '#/components/schemas/payment_method_card_wallet' description: >- If this Card is part of a card wallet, this contains the details of the card wallet. nullable: true required: - brand - exp_month - exp_year - funding - last4 title: payment_method_card type: object x-expandableFields: - checks - generated_from - networks - three_d_secure_usage - wallet payment_method_card_checks: description: '' properties: address_line1_check: description: >- If a address line1 was provided, results of the check, one of `pass`, `fail`, `unavailable`, or `unchecked`. maxLength: 5000 nullable: true type: string address_postal_code_check: description: >- If a address postal code was provided, results of the check, one of `pass`, `fail`, `unavailable`, or `unchecked`. maxLength: 5000 nullable: true type: string cvc_check: description: >- If a CVC was provided, results of the check, one of `pass`, `fail`, `unavailable`, or `unchecked`. maxLength: 5000 nullable: true type: string title: payment_method_card_checks type: object x-expandableFields: [] payment_method_card_generated_card: description: '' properties: charge: description: The charge that created this object. maxLength: 5000 nullable: true type: string payment_method_details: anyOf: - $ref: '#/components/schemas/card_generated_from_payment_method_details' description: >- Transaction-specific details of the payment method used in the payment. nullable: true setup_attempt: anyOf: - maxLength: 5000 type: string - $ref: '#/components/schemas/setup_attempt' description: >- The ID of the SetupAttempt that generated this PaymentMethod, if any. nullable: true x-expansionResources: oneOf: - $ref: '#/components/schemas/setup_attempt' title: payment_method_card_generated_card type: object x-expandableFields: - payment_method_details - setup_attempt payment_method_card_present: description: '' properties: brand: description: >- Card brand. Can be `amex`, `diners`, `discover`, `eftpos_au`, `jcb`, `mastercard`, `unionpay`, `visa`, or `unknown`. maxLength: 5000 nullable: true type: string cardholder_name: description: >- 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. maxLength: 5000 nullable: true type: string country: description: >- 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. maxLength: 5000 nullable: true type: string exp_month: description: Two-digit number representing the card's expiration month. type: integer exp_year: description: Four-digit number representing the card's expiration year. type: integer fingerprint: description: >- 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.* maxLength: 5000 nullable: true type: string funding: description: >- Card funding type. Can be `credit`, `debit`, `prepaid`, or `unknown`. maxLength: 5000 nullable: true type: string last4: description: The last four digits of the card. maxLength: 5000 nullable: true type: string networks: anyOf: - $ref: '#/components/schemas/payment_method_card_present_networks' description: >- Contains information about card networks that can be used to process the payment. nullable: true read_method: description: How card details were read in this transaction. enum: - contact_emv - contactless_emv - contactless_magstripe_mode - magnetic_stripe_fallback - magnetic_stripe_track2 nullable: true type: string required: - exp_month - exp_year title: payment_method_card_present type: object x-expandableFields: - networks payment_method_card_present_networks: description: '' properties: available: description: All available networks for the card. items: maxLength: 5000 type: string type: array preferred: description: The preferred network for the card. maxLength: 5000 nullable: true type: string required: - available title: payment_method_card_present_networks type: object x-expandableFields: [] payment_method_card_wallet: description: '' properties: amex_express_checkout: $ref: >- #/components/schemas/payment_method_card_wallet_amex_express_checkout apple_pay: $ref: '#/components/schemas/payment_method_card_wallet_apple_pay' dynamic_last4: description: >- (For tokenized numbers only.) The last four digits of the device account number. maxLength: 5000 nullable: true type: string google_pay: $ref: '#/components/schemas/payment_method_card_wallet_google_pay' link: $ref: '#/components/schemas/payment_method_card_wallet_link' masterpass: $ref: '#/components/schemas/payment_method_card_wallet_masterpass' samsung_pay: $ref: '#/components/schemas/payment_method_card_wallet_samsung_pay' type: description: >- 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. enum: - amex_express_checkout - apple_pay - google_pay - link - masterpass - samsung_pay - visa_checkout type: string visa_checkout: $ref: '#/components/schemas/payment_method_card_wallet_visa_checkout' required: - type title: payment_method_card_wallet type: object x-expandableFields: - amex_express_checkout - apple_pay - google_pay - link - masterpass - samsung_pay - visa_checkout payment_method_card_wallet_amex_express_checkout: description: '' properties: {} title: payment_method_card_wallet_amex_express_checkout type: object x-expandableFields: [] payment_method_card_wallet_apple_pay: description: '' properties: {} title: payment_method_card_wallet_apple_pay type: object x-expandableFields: [] payment_method_card_wallet_google_pay: description: '' properties: {} title: payment_method_card_wallet_google_pay type: object x-expandableFields: [] payment_method_card_wallet_link: description: '' properties: {} title: payment_method_card_wallet_link type: object x-expandableFields: [] payment_method_card_wallet_masterpass: description: '' properties: billing_address: anyOf: - $ref: '#/components/schemas/address' description: >- Owner's verified billing address. Values are verified or provided by the wallet directly (if supported) at the time of authorization or settlement. They cannot be set or mutated. nullable: true email: description: >- Owner's verified email. Values are verified or provided by the wallet directly (if supported) at the time of authorization or settlement. They cannot be set or mutated. maxLength: 5000 nullable: true type: string name: description: >- Owner's verified full name. Values are verified or provided by the wallet directly (if supported) at the time of authorization or settlement. They cannot be set or mutated. maxLength: 5000 nullable: true type: string shipping_address: anyOf: - $ref: '#/components/schemas/address' description: >- Owner's verified shipping address. Values are verified or provided by the wallet directly (if supported) at the time of authorization or settlement. They cannot be set or mutated. nullable: true title: payment_method_card_wallet_masterpass type: object x-expandableFields: - billing_address - shipping_address payment_method_card_wallet_samsung_pay: description: '' properties: {} title: payment_method_card_wallet_samsung_pay type: object x-expandableFields: [] payment_method_card_wallet_visa_checkout: description: '' properties: billing_address: anyOf: - $ref: '#/components/schemas/address' description: >- Owner's verified billing address. Values are verified or provided by the wallet directly (if supported) at the time of authorization or settlement. They cannot be set or mutated. nullable: true email: description: >- Owner's verified email. Values are verified or provided by the wallet directly (if supported) at the time of authorization or settlement. They cannot be set or mutated. maxLength: 5000 nullable: true type: string name: description: >- Owner's verified full name. Values are verified or provided by the wallet directly (if supported) at the time of authorization or settlement. They cannot be set or mutated. maxLength: 5000 nullable: true type: string shipping_address: anyOf: - $ref: '#/components/schemas/address' description: >- Owner's verified shipping address. Values are verified or provided by the wallet directly (if supported) at the time of authorization or settlement. They cannot be set or mutated. nullable: true title: payment_method_card_wallet_visa_checkout type: object x-expandableFields: - billing_address - shipping_address payment_method_cashapp: description: '' properties: buyer_id: description: >- A unique and immutable identifier assigned by Cash App to every buyer. maxLength: 5000 nullable: true type: string cashtag: description: A public identifier for buyers using Cash App. maxLength: 5000 nullable: true type: string title: payment_method_cashapp type: object x-expandableFields: [] payment_method_config_biz_payment_method_configuration_details: description: '' properties: id: description: ID of the payment method configuration used. maxLength: 5000 type: string parent: description: ID of the parent payment method configuration used. maxLength: 5000 nullable: true type: string required: - id title: PaymentMethodConfigBizPaymentMethodConfigurationDetails type: object x-expandableFields: [] payment_method_config_resource_display_preference: description: '' properties: overridable: description: >- For child configs, whether or not the account's preference will be observed. If `false`, the parent configuration's default is used. nullable: true type: boolean preference: description: The account's display preference. enum: - none - 'off' - 'on' type: string value: description: The effective display preference value. enum: - 'off' - 'on' type: string required: - preference - value title: PaymentMethodConfigResourceDisplayPreference type: object x-expandableFields: [] payment_method_config_resource_payment_method_properties: description: '' properties: available: description: >- Whether this payment method may be offered at checkout. True if `display_preference` is `on` and the payment method's capability is active. type: boolean display_preference: $ref: >- #/components/schemas/payment_method_config_resource_display_preference required: - available - display_preference title: PaymentMethodConfigResourcePaymentMethodProperties type: object x-expandableFields: - display_preference payment_method_configuration: description: >- PaymentMethodConfigurations control which payment methods are displayed to your customers when you don't explicitly specify payment method types. You can have multiple configurations with different sets of payment methods for different scenarios. There are two types of PaymentMethodConfigurations. Which is used depends on the [charge type](https://stripe.com/docs/connect/charges): **Direct** configurations apply to payments created on your account, including Connect destination charges, Connect separate charges and transfers, and payments not involving Connect. **Child** configurations apply to payments created on your connected accounts using direct charges, and charges with the on_behalf_of parameter. Child configurations have a `parent` that sets default values and controls which settings connected accounts may override. You can specify a parent ID at payment time, and Stripe will automatically resolve the connected account’s associated child configuration. Parent configurations are [managed in the dashboard](https://dashboard.stripe.com/settings/payment_methods/connected_accounts) and are not available in this API. Related guides: - [Payment Method Configurations API](https://stripe.com/docs/connect/payment-method-configurations) - [Multiple configurations on dynamic payment methods](https://stripe.com/docs/payments/multiple-payment-method-configs) - [Multiple configurations for your Connect accounts](https://stripe.com/docs/connect/multiple-payment-method-configurations) properties: acss_debit: $ref: >- #/components/schemas/payment_method_config_resource_payment_method_properties active: description: Whether the configuration can be used for new payments. type: boolean affirm: $ref: >- #/components/schemas/payment_method_config_resource_payment_method_properties afterpay_clearpay: $ref: >- #/components/schemas/payment_method_config_resource_payment_method_properties alipay: $ref: >- #/components/schemas/payment_method_config_resource_payment_method_properties amazon_pay: $ref: >- #/components/schemas/payment_method_config_resource_payment_method_properties apple_pay: $ref: >- #/components/schemas/payment_method_config_resource_payment_method_properties application: description: >- For child configs, the Connect application associated with the configuration. maxLength: 5000 nullable: true type: string au_becs_debit: $ref: >- #/components/schemas/payment_method_config_resource_payment_method_properties bacs_debit: $ref: >- #/components/schemas/payment_method_config_resource_payment_method_properties bancontact: $ref: >- #/components/schemas/payment_method_config_resource_payment_method_properties blik: $ref: >- #/components/schemas/payment_method_config_resource_payment_method_properties boleto: $ref: >- #/components/schemas/payment_method_config_resource_payment_method_properties card: $ref: >- #/components/schemas/payment_method_config_resource_payment_method_properties cartes_bancaires: $ref: >- #/components/schemas/payment_method_config_resource_payment_method_properties cashapp: $ref: >- #/components/schemas/payment_method_config_resource_payment_method_properties customer_balance: $ref: >- #/components/schemas/payment_method_config_resource_payment_method_properties eps: $ref: >- #/components/schemas/payment_method_config_resource_payment_method_properties fpx: $ref: >- #/components/schemas/payment_method_config_resource_payment_method_properties giropay: $ref: >- #/components/schemas/payment_method_config_resource_payment_method_properties google_pay: $ref: >- #/components/schemas/payment_method_config_resource_payment_method_properties grabpay: $ref: >- #/components/schemas/payment_method_config_resource_payment_method_properties id: description: Unique identifier for the object. maxLength: 5000 type: string ideal: $ref: >- #/components/schemas/payment_method_config_resource_payment_method_properties is_default: description: >- The default configuration is used whenever a payment method configuration is not specified. type: boolean jcb: $ref: >- #/components/schemas/payment_method_config_resource_payment_method_properties klarna: $ref: >- #/components/schemas/payment_method_config_resource_payment_method_properties konbini: $ref: >- #/components/schemas/payment_method_config_resource_payment_method_properties link: $ref: >- #/components/schemas/payment_method_config_resource_payment_method_properties livemode: description: >- Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. type: boolean name: description: The configuration's name. maxLength: 5000 type: string object: description: >- String representing the object's type. Objects of the same type share the same value. enum: - payment_method_configuration type: string oxxo: $ref: >- #/components/schemas/payment_method_config_resource_payment_method_properties p24: $ref: >- #/components/schemas/payment_method_config_resource_payment_method_properties parent: description: 'For child configs, the configuration''s parent configuration.' maxLength: 5000 nullable: true type: string paynow: $ref: >- #/components/schemas/payment_method_config_resource_payment_method_properties paypal: $ref: >- #/components/schemas/payment_method_config_resource_payment_method_properties promptpay: $ref: >- #/components/schemas/payment_method_config_resource_payment_method_properties revolut_pay: $ref: >- #/components/schemas/payment_method_config_resource_payment_method_properties sepa_debit: $ref: >- #/components/schemas/payment_method_config_resource_payment_method_properties sofort: $ref: >- #/components/schemas/payment_method_config_resource_payment_method_properties swish: $ref: >- #/components/schemas/payment_method_config_resource_payment_method_properties us_bank_account: $ref: >- #/components/schemas/payment_method_config_resource_payment_method_properties wechat_pay: $ref: >- #/components/schemas/payment_method_config_resource_payment_method_properties zip: $ref: >- #/components/schemas/payment_method_config_resource_payment_method_properties required: - active - id - is_default - livemode - name - object title: PaymentMethodConfigResourcePaymentMethodConfiguration type: object x-expandableFields: - acss_debit - affirm - afterpay_clearpay - alipay - amazon_pay - apple_pay - au_becs_debit - bacs_debit - bancontact - blik - boleto - card - cartes_bancaires - cashapp - customer_balance - eps - fpx - giropay - google_pay - grabpay - ideal - jcb - klarna - konbini - link - oxxo - p24 - paynow - paypal - promptpay - revolut_pay - sepa_debit - sofort - swish - us_bank_account - wechat_pay - zip x-resourceId: payment_method_configuration payment_method_customer_balance: description: '' properties: {} title: payment_method_customer_balance type: object x-expandableFields: [] payment_method_details: description: '' properties: ach_credit_transfer: $ref: '#/components/schemas/payment_method_details_ach_credit_transfer' ach_debit: $ref: '#/components/schemas/payment_method_details_ach_debit' acss_debit: $ref: '#/components/schemas/payment_method_details_acss_debit' affirm: $ref: '#/components/schemas/payment_method_details_affirm' afterpay_clearpay: $ref: '#/components/schemas/payment_method_details_afterpay_clearpay' alipay: $ref: >- #/components/schemas/payment_flows_private_payment_methods_alipay_details amazon_pay: $ref: '#/components/schemas/payment_method_details_amazon_pay' au_becs_debit: $ref: '#/components/schemas/payment_method_details_au_becs_debit' bacs_debit: $ref: '#/components/schemas/payment_method_details_bacs_debit' bancontact: $ref: '#/components/schemas/payment_method_details_bancontact' blik: $ref: '#/components/schemas/payment_method_details_blik' boleto: $ref: '#/components/schemas/payment_method_details_boleto' card: $ref: '#/components/schemas/payment_method_details_card' card_present: $ref: '#/components/schemas/payment_method_details_card_present' cashapp: $ref: '#/components/schemas/payment_method_details_cashapp' customer_balance: $ref: '#/components/schemas/payment_method_details_customer_balance' eps: $ref: '#/components/schemas/payment_method_details_eps' fpx: $ref: '#/components/schemas/payment_method_details_fpx' giropay: $ref: '#/components/schemas/payment_method_details_giropay' grabpay: $ref: '#/components/schemas/payment_method_details_grabpay' ideal: $ref: '#/components/schemas/payment_method_details_ideal' interac_present: $ref: '#/components/schemas/payment_method_details_interac_present' klarna: $ref: '#/components/schemas/payment_method_details_klarna' konbini: $ref: '#/components/schemas/payment_method_details_konbini' link: $ref: '#/components/schemas/payment_method_details_link' mobilepay: $ref: '#/components/schemas/payment_method_details_mobilepay' multibanco: $ref: '#/components/schemas/payment_method_details_multibanco' oxxo: $ref: '#/components/schemas/payment_method_details_oxxo' p24: $ref: '#/components/schemas/payment_method_details_p24' paynow: $ref: '#/components/schemas/payment_method_details_paynow' paypal: $ref: '#/components/schemas/payment_method_details_paypal' pix: $ref: '#/components/schemas/payment_method_details_pix' promptpay: $ref: '#/components/schemas/payment_method_details_promptpay' revolut_pay: $ref: '#/components/schemas/payment_method_details_revolut_pay' sepa_debit: $ref: '#/components/schemas/payment_method_details_sepa_debit' sofort: $ref: '#/components/schemas/payment_method_details_sofort' stripe_account: $ref: '#/components/schemas/payment_method_details_stripe_account' swish: $ref: '#/components/schemas/payment_method_details_swish' type: description: >- The type of transaction-specific details of the payment method used in the payment, one of `ach_credit_transfer`, `ach_debit`, `acss_debit`, `alipay`, `au_becs_debit`, `bancontact`, `card`, `card_present`, `eps`, `giropay`, `ideal`, `klarna`, `multibanco`, `p24`, `sepa_debit`, `sofort`, `stripe_account`, or `wechat`. An additional hash is included on `payment_method_details` with a name matching this value. It contains information specific to the payment method. maxLength: 5000 type: string us_bank_account: $ref: '#/components/schemas/payment_method_details_us_bank_account' wechat: $ref: '#/components/schemas/payment_method_details_wechat' wechat_pay: $ref: '#/components/schemas/payment_method_details_wechat_pay' zip: $ref: '#/components/schemas/payment_method_details_zip' required: - type title: payment_method_details type: object x-expandableFields: - ach_credit_transfer - ach_debit - acss_debit - affirm - afterpay_clearpay - alipay - amazon_pay - au_becs_debit - bacs_debit - bancontact - blik - boleto - card - card_present - cashapp - customer_balance - eps - fpx - giropay - grabpay - ideal - interac_present - klarna - konbini - link - mobilepay - multibanco - oxxo - p24 - paynow - paypal - pix - promptpay - revolut_pay - sepa_debit - sofort - stripe_account - swish - us_bank_account - wechat - wechat_pay - zip payment_method_details_ach_credit_transfer: description: '' properties: account_number: description: Account number to transfer funds to. maxLength: 5000 nullable: true type: string bank_name: description: Name of the bank associated with the routing number. maxLength: 5000 nullable: true type: string routing_number: description: Routing transit number for the bank account to transfer funds to. maxLength: 5000 nullable: true type: string swift_code: description: SWIFT code of the bank associated with the routing number. maxLength: 5000 nullable: true type: string title: payment_method_details_ach_credit_transfer type: object x-expandableFields: [] payment_method_details_ach_debit: description: '' properties: account_holder_type: description: >- Type of entity that holds the account. This can be either `individual` or `company`. enum: - company - individual nullable: true type: string bank_name: description: Name of the bank associated with the bank account. maxLength: 5000 nullable: true type: string country: description: >- Two-letter ISO code representing the country the bank account is located in. maxLength: 5000 nullable: true type: string fingerprint: description: >- Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same. maxLength: 5000 nullable: true type: string last4: description: Last four digits of the bank account number. maxLength: 5000 nullable: true type: string routing_number: description: Routing transit number of the bank account. maxLength: 5000 nullable: true type: string title: payment_method_details_ach_debit type: object x-expandableFields: [] payment_method_details_acss_debit: description: '' properties: bank_name: description: Name of the bank associated with the bank account. maxLength: 5000 nullable: true type: string fingerprint: description: >- Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same. maxLength: 5000 nullable: true type: string institution_number: description: Institution number of the bank account maxLength: 5000 nullable: true type: string last4: description: Last four digits of the bank account number. maxLength: 5000 nullable: true type: string mandate: description: ID of the mandate used to make this payment. maxLength: 5000 type: string transit_number: description: Transit number of the bank account. maxLength: 5000 nullable: true type: string title: payment_method_details_acss_debit type: object x-expandableFields: [] payment_method_details_affirm: description: '' properties: {} title: payment_method_details_affirm type: object x-expandableFields: [] payment_method_details_afterpay_clearpay: description: '' properties: order_id: description: The Afterpay order ID associated with this payment intent. maxLength: 5000 nullable: true type: string reference: description: Order identifier shown to the merchant in Afterpay’s online portal. maxLength: 5000 nullable: true type: string title: payment_method_details_afterpay_clearpay type: object x-expandableFields: [] payment_method_details_amazon_pay: description: '' properties: {} title: payment_method_details_amazon_pay type: object x-expandableFields: [] payment_method_details_au_becs_debit: description: '' properties: bsb_number: description: Bank-State-Branch number of the bank account. maxLength: 5000 nullable: true type: string fingerprint: description: >- Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same. maxLength: 5000 nullable: true type: string last4: description: Last four digits of the bank account number. maxLength: 5000 nullable: true type: string mandate: description: ID of the mandate used to make this payment. maxLength: 5000 type: string title: payment_method_details_au_becs_debit type: object x-expandableFields: [] payment_method_details_bacs_debit: description: '' properties: fingerprint: description: >- Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same. maxLength: 5000 nullable: true type: string last4: description: Last four digits of the bank account number. maxLength: 5000 nullable: true type: string mandate: description: ID of the mandate used to make this payment. maxLength: 5000 nullable: true type: string sort_code: description: 'Sort code of the bank account. (e.g., `10-20-30`)' maxLength: 5000 nullable: true type: string title: payment_method_details_bacs_debit type: object x-expandableFields: [] payment_method_details_bancontact: description: '' properties: bank_code: description: Bank code of bank associated with the bank account. maxLength: 5000 nullable: true type: string bank_name: description: Name of the bank associated with the bank account. maxLength: 5000 nullable: true type: string bic: description: Bank Identifier Code of the bank associated with the bank account. maxLength: 5000 nullable: true type: string generated_sepa_debit: anyOf: - maxLength: 5000 type: string - $ref: '#/components/schemas/payment_method' description: >- The ID of the SEPA Direct Debit PaymentMethod which was generated by this Charge. nullable: true x-expansionResources: oneOf: - $ref: '#/components/schemas/payment_method' generated_sepa_debit_mandate: anyOf: - maxLength: 5000 type: string - $ref: '#/components/schemas/mandate' description: >- The mandate for the SEPA Direct Debit PaymentMethod which was generated by this Charge. nullable: true x-expansionResources: oneOf: - $ref: '#/components/schemas/mandate' iban_last4: description: Last four characters of the IBAN. maxLength: 5000 nullable: true type: string preferred_language: description: >- Preferred language of the Bancontact authorization page that the customer is redirected to. Can be one of `en`, `de`, `fr`, or `nl` enum: - de - en - fr - nl nullable: true type: string verified_name: description: >- 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. maxLength: 5000 nullable: true type: string title: payment_method_details_bancontact type: object x-expandableFields: - generated_sepa_debit - generated_sepa_debit_mandate payment_method_details_blik: description: '' properties: {} title: payment_method_details_blik type: object x-expandableFields: [] payment_method_details_boleto: description: '' properties: tax_id: description: >- The tax ID of the customer (CPF for individuals consumers or CNPJ for businesses consumers) maxLength: 5000 type: string required: - tax_id title: payment_method_details_boleto type: object x-expandableFields: [] payment_method_details_card: description: '' properties: amount_authorized: description: The authorized amount. nullable: true type: integer brand: description: >- Card brand. Can be `amex`, `diners`, `discover`, `eftpos_au`, `jcb`, `mastercard`, `unionpay`, `visa`, or `unknown`. maxLength: 5000 nullable: true type: string capture_before: description: >- When using manual capture, a future timestamp at which the charge will be automatically refunded if uncaptured. format: unix-time type: integer checks: anyOf: - $ref: '#/components/schemas/payment_method_details_card_checks' description: >- Check results by Card networks on Card address and CVC at time of payment. nullable: true country: description: >- 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. maxLength: 5000 nullable: true type: string exp_month: description: Two-digit number representing the card's expiration month. type: integer exp_year: description: Four-digit number representing the card's expiration year. type: integer extended_authorization: $ref: >- #/components/schemas/payment_flows_private_payment_methods_card_details_api_resource_enterprise_features_extended_authorization_extended_authorization fingerprint: description: >- 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.* maxLength: 5000 nullable: true type: string funding: description: >- Card funding type. Can be `credit`, `debit`, `prepaid`, or `unknown`. maxLength: 5000 nullable: true type: string incremental_authorization: $ref: >- #/components/schemas/payment_flows_private_payment_methods_card_details_api_resource_enterprise_features_incremental_authorization_incremental_authorization installments: anyOf: - $ref: '#/components/schemas/payment_method_details_card_installments' description: >- Installment details for this payment (Mexico only). For more information, see the [installments integration guide](https://stripe.com/docs/payments/installments). nullable: true last4: description: The last four digits of the card. maxLength: 5000 nullable: true type: string mandate: description: ID of the mandate used to make this payment or created by it. maxLength: 5000 nullable: true type: string multicapture: $ref: >- #/components/schemas/payment_flows_private_payment_methods_card_details_api_resource_multicapture network: description: >- Identifies which network this charge was processed on. Can be `amex`, `cartes_bancaires`, `diners`, `discover`, `eftpos_au`, `interac`, `jcb`, `mastercard`, `unionpay`, `visa`, or `unknown`. maxLength: 5000 nullable: true type: string network_token: anyOf: - $ref: '#/components/schemas/payment_method_details_card_network_token' description: >- If this card has network token credentials, this contains the details of the network token credentials. nullable: true overcapture: $ref: >- #/components/schemas/payment_flows_private_payment_methods_card_details_api_resource_enterprise_features_overcapture_overcapture three_d_secure: anyOf: - $ref: '#/components/schemas/three_d_secure_details_charge' description: Populated if this transaction used 3D Secure authentication. nullable: true wallet: anyOf: - $ref: '#/components/schemas/payment_method_details_card_wallet' description: >- If this Card is part of a card wallet, this contains the details of the card wallet. nullable: true required: - exp_month - exp_year title: payment_method_details_card type: object x-expandableFields: - checks - extended_authorization - incremental_authorization - installments - multicapture - network_token - overcapture - three_d_secure - wallet payment_method_details_card_checks: description: '' properties: address_line1_check: description: >- If a address line1 was provided, results of the check, one of `pass`, `fail`, `unavailable`, or `unchecked`. maxLength: 5000 nullable: true type: string address_postal_code_check: description: >- If a address postal code was provided, results of the check, one of `pass`, `fail`, `unavailable`, or `unchecked`. maxLength: 5000 nullable: true type: string cvc_check: description: >- If a CVC was provided, results of the check, one of `pass`, `fail`, `unavailable`, or `unchecked`. maxLength: 5000 nullable: true type: string title: payment_method_details_card_checks type: object x-expandableFields: [] payment_method_details_card_installments: description: '' properties: plan: anyOf: - $ref: >- #/components/schemas/payment_method_details_card_installments_plan description: Installment plan selected for the payment. nullable: true title: payment_method_details_card_installments type: object x-expandableFields: - plan payment_method_details_card_installments_plan: description: '' properties: count: description: >- For `fixed_count` installment plans, this is the number of installment payments your customer will make to their credit card. nullable: true type: integer interval: description: >- For `fixed_count` installment plans, this is the interval between installment payments your customer will make to their credit card. One of `month`. enum: - month nullable: true type: string type: description: 'Type of installment plan, one of `fixed_count`.' enum: - fixed_count type: string required: - type title: payment_method_details_card_installments_plan type: object x-expandableFields: [] payment_method_details_card_network_token: description: '' properties: used: description: >- Indicates if Stripe used a network token, either user provided or Stripe managed when processing the transaction. type: boolean required: - used title: payment_method_details_card_network_token type: object x-expandableFields: [] payment_method_details_card_present: description: '' properties: amount_authorized: description: The authorized amount nullable: true type: integer brand: description: >- Card brand. Can be `amex`, `diners`, `discover`, `eftpos_au`, `jcb`, `mastercard`, `unionpay`, `visa`, or `unknown`. maxLength: 5000 nullable: true type: string capture_before: description: >- When using manual capture, a future timestamp after which the charge will be automatically refunded if uncaptured. format: unix-time type: integer cardholder_name: description: >- 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. maxLength: 5000 nullable: true type: string country: description: >- 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. maxLength: 5000 nullable: true type: string emv_auth_data: description: Authorization response cryptogram. maxLength: 5000 nullable: true type: string exp_month: description: Two-digit number representing the card's expiration month. type: integer exp_year: description: Four-digit number representing the card's expiration year. type: integer fingerprint: description: >- 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.* maxLength: 5000 nullable: true type: string funding: description: >- Card funding type. Can be `credit`, `debit`, `prepaid`, or `unknown`. maxLength: 5000 nullable: true type: string generated_card: description: >- ID of a card PaymentMethod generated from the card_present PaymentMethod that may be attached to a Customer for future transactions. Only present if it was possible to generate a card PaymentMethod. maxLength: 5000 nullable: true type: string incremental_authorization_supported: description: >- Whether this [PaymentIntent](https://stripe.com/docs/api/payment_intents) is eligible for incremental authorizations. Request support using [request_incremental_authorization_support](https://stripe.com/docs/api/payment_intents/create#create_payment_intent-payment_method_options-card_present-request_incremental_authorization_support). type: boolean last4: description: The last four digits of the card. maxLength: 5000 nullable: true type: string network: description: >- Identifies which network this charge was processed on. Can be `amex`, `cartes_bancaires`, `diners`, `discover`, `eftpos_au`, `interac`, `jcb`, `mastercard`, `unionpay`, `visa`, or `unknown`. maxLength: 5000 nullable: true type: string offline: anyOf: - $ref: '#/components/schemas/payment_method_details_card_present_offline' description: Details about payments collected offline. nullable: true overcapture_supported: description: Defines whether the authorized amount can be over-captured or not type: boolean read_method: description: How card details were read in this transaction. enum: - contact_emv - contactless_emv - contactless_magstripe_mode - magnetic_stripe_fallback - magnetic_stripe_track2 nullable: true type: string receipt: anyOf: - $ref: '#/components/schemas/payment_method_details_card_present_receipt' description: >- A collection of fields required to be displayed on receipts. Only required for EMV transactions. nullable: true required: - exp_month - exp_year - incremental_authorization_supported - overcapture_supported title: payment_method_details_card_present type: object x-expandableFields: - offline - receipt payment_method_details_card_present_offline: description: '' properties: stored_at: description: Time at which the payment was collected while offline format: unix-time nullable: true type: integer title: payment_method_details_card_present_offline type: object x-expandableFields: [] payment_method_details_card_present_receipt: description: '' properties: account_type: description: The type of account being debited or credited enum: - checking - credit - prepaid - unknown type: string x-stripeBypassValidation: true application_cryptogram: description: 'EMV tag 9F26, cryptogram generated by the integrated circuit chip.' maxLength: 5000 nullable: true type: string application_preferred_name: description: Mnenomic of the Application Identifier. maxLength: 5000 nullable: true type: string authorization_code: description: Identifier for this transaction. maxLength: 5000 nullable: true type: string authorization_response_code: description: EMV tag 8A. A code returned by the card issuer. maxLength: 5000 nullable: true type: string cardholder_verification_method: description: >- Describes the method used by the cardholder to verify ownership of the card. One of the following: `approval`, `failure`, `none`, `offline_pin`, `offline_pin_and_signature`, `online_pin`, or `signature`. maxLength: 5000 nullable: true type: string dedicated_file_name: description: >- EMV tag 84. Similar to the application identifier stored on the integrated circuit chip. maxLength: 5000 nullable: true type: string terminal_verification_results: description: >- The outcome of a series of EMV functions performed by the card reader. maxLength: 5000 nullable: true type: string transaction_status_information: description: >- An indication of various EMV functions performed during the transaction. maxLength: 5000 nullable: true type: string title: payment_method_details_card_present_receipt type: object x-expandableFields: [] payment_method_details_card_wallet: description: '' properties: amex_express_checkout: $ref: >- #/components/schemas/payment_method_details_card_wallet_amex_express_checkout apple_pay: $ref: '#/components/schemas/payment_method_details_card_wallet_apple_pay' dynamic_last4: description: >- (For tokenized numbers only.) The last four digits of the device account number. maxLength: 5000 nullable: true type: string google_pay: $ref: '#/components/schemas/payment_method_details_card_wallet_google_pay' link: $ref: '#/components/schemas/payment_method_details_card_wallet_link' masterpass: $ref: '#/components/schemas/payment_method_details_card_wallet_masterpass' samsung_pay: $ref: '#/components/schemas/payment_method_details_card_wallet_samsung_pay' type: description: >- 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. enum: - amex_express_checkout - apple_pay - google_pay - link - masterpass - samsung_pay - visa_checkout type: string visa_checkout: $ref: >- #/components/schemas/payment_method_details_card_wallet_visa_checkout required: - type title: payment_method_details_card_wallet type: object x-expandableFields: - amex_express_checkout - apple_pay - google_pay - link - masterpass - samsung_pay - visa_checkout payment_method_details_card_wallet_amex_express_checkout: description: '' properties: {} title: payment_method_details_card_wallet_amex_express_checkout type: object x-expandableFields: [] payment_method_details_card_wallet_apple_pay: description: '' properties: {} title: payment_method_details_card_wallet_apple_pay type: object x-expandableFields: [] payment_method_details_card_wallet_google_pay: description: '' properties: {} title: payment_method_details_card_wallet_google_pay type: object x-expandableFields: [] payment_method_details_card_wallet_link: description: '' properties: {} title: payment_method_details_card_wallet_link type: object x-expandableFields: [] payment_method_details_card_wallet_masterpass: description: '' properties: billing_address: anyOf: - $ref: '#/components/schemas/address' description: >- Owner's verified billing address. Values are verified or provided by the wallet directly (if supported) at the time of authorization or settlement. They cannot be set or mutated. nullable: true email: description: >- Owner's verified email. Values are verified or provided by the wallet directly (if supported) at the time of authorization or settlement. They cannot be set or mutated. maxLength: 5000 nullable: true type: string name: description: >- Owner's verified full name. Values are verified or provided by the wallet directly (if supported) at the time of authorization or settlement. They cannot be set or mutated. maxLength: 5000 nullable: true type: string shipping_address: anyOf: - $ref: '#/components/schemas/address' description: >- Owner's verified shipping address. Values are verified or provided by the wallet directly (if supported) at the time of authorization or settlement. They cannot be set or mutated. nullable: true title: payment_method_details_card_wallet_masterpass type: object x-expandableFields: - billing_address - shipping_address payment_method_details_card_wallet_samsung_pay: description: '' properties: {} title: payment_method_details_card_wallet_samsung_pay type: object x-expandableFields: [] payment_method_details_card_wallet_visa_checkout: description: '' properties: billing_address: anyOf: - $ref: '#/components/schemas/address' description: >- Owner's verified billing address. Values are verified or provided by the wallet directly (if supported) at the time of authorization or settlement. They cannot be set or mutated. nullable: true email: description: >- Owner's verified email. Values are verified or provided by the wallet directly (if supported) at the time of authorization or settlement. They cannot be set or mutated. maxLength: 5000 nullable: true type: string name: description: >- Owner's verified full name. Values are verified or provided by the wallet directly (if supported) at the time of authorization or settlement. They cannot be set or mutated. maxLength: 5000 nullable: true type: string shipping_address: anyOf: - $ref: '#/components/schemas/address' description: >- Owner's verified shipping address. Values are verified or provided by the wallet directly (if supported) at the time of authorization or settlement. They cannot be set or mutated. nullable: true title: payment_method_details_card_wallet_visa_checkout type: object x-expandableFields: - billing_address - shipping_address payment_method_details_cashapp: description: '' properties: buyer_id: description: >- A unique and immutable identifier assigned by Cash App to every buyer. maxLength: 5000 nullable: true type: string cashtag: description: A public identifier for buyers using Cash App. maxLength: 5000 nullable: true type: string title: payment_method_details_cashapp type: object x-expandableFields: [] payment_method_details_customer_balance: description: '' properties: {} title: payment_method_details_customer_balance type: object x-expandableFields: [] payment_method_details_eps: description: '' properties: bank: description: >- 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`. enum: - 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: true type: string verified_name: description: >- Owner's verified full name. Values are verified or provided by EPS directly (if supported) at the time of authorization or settlement. They cannot be set or mutated. EPS rarely provides this information so the attribute is usually empty. maxLength: 5000 nullable: true type: string title: payment_method_details_eps type: object x-expandableFields: [] payment_method_details_fpx: description: '' properties: bank: description: >- The customer's bank. 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`. enum: - 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 type: string transaction_id: description: >- Unique transaction id generated by FPX for every request from the merchant maxLength: 5000 nullable: true type: string required: - bank title: payment_method_details_fpx type: object x-expandableFields: [] payment_method_details_giropay: description: '' properties: bank_code: description: Bank code of bank associated with the bank account. maxLength: 5000 nullable: true type: string bank_name: description: Name of the bank associated with the bank account. maxLength: 5000 nullable: true type: string bic: description: Bank Identifier Code of the bank associated with the bank account. maxLength: 5000 nullable: true type: string verified_name: description: >- Owner's verified full name. Values are verified or provided by Giropay directly (if supported) at the time of authorization or settlement. They cannot be set or mutated. Giropay rarely provides this information so the attribute is usually empty. maxLength: 5000 nullable: true type: string title: payment_method_details_giropay type: object x-expandableFields: [] payment_method_details_grabpay: description: '' properties: transaction_id: description: Unique transaction id generated by GrabPay maxLength: 5000 nullable: true type: string title: payment_method_details_grabpay type: object x-expandableFields: [] payment_method_details_ideal: description: '' properties: bank: description: >- 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`. enum: - abn_amro - asn_bank - bunq - handelsbanken - ing - knab - moneyou - n26 - nn - rabobank - regiobank - revolut - sns_bank - triodos_bank - van_lanschot - yoursafe nullable: true type: string bic: description: The Bank Identifier Code of the customer's bank. enum: - ABNANL2A - ASNBNL21 - BITSNL2A - BUNQNL2A - FVLBNL22 - HANDNL2A - INGBNL2A - KNABNL2H - MOYONL21 - NNBANL2G - NTSBDEB1 - RABONL2U - RBRBNL21 - REVOIE23 - REVOLT21 - SNSBNL2A - TRIONL2U nullable: true type: string generated_sepa_debit: anyOf: - maxLength: 5000 type: string - $ref: '#/components/schemas/payment_method' description: >- The ID of the SEPA Direct Debit PaymentMethod which was generated by this Charge. nullable: true x-expansionResources: oneOf: - $ref: '#/components/schemas/payment_method' generated_sepa_debit_mandate: anyOf: - maxLength: 5000 type: string - $ref: '#/components/schemas/mandate' description: >- The mandate for the SEPA Direct Debit PaymentMethod which was generated by this Charge. nullable: true x-expansionResources: oneOf: - $ref: '#/components/schemas/mandate' iban_last4: description: Last four characters of the IBAN. maxLength: 5000 nullable: true type: string verified_name: description: >- 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. maxLength: 5000 nullable: true type: string title: payment_method_details_ideal type: object x-expandableFields: - generated_sepa_debit - generated_sepa_debit_mandate payment_method_details_interac_present: description: '' properties: brand: description: 'Card brand. Can be `interac`, `mastercard` or `visa`.' maxLength: 5000 nullable: true type: string cardholder_name: description: >- 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. maxLength: 5000 nullable: true type: string country: description: >- 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. maxLength: 5000 nullable: true type: string emv_auth_data: description: Authorization response cryptogram. maxLength: 5000 nullable: true type: string exp_month: description: Two-digit number representing the card's expiration month. type: integer exp_year: description: Four-digit number representing the card's expiration year. type: integer fingerprint: description: >- 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.* maxLength: 5000 nullable: true type: string funding: description: >- Card funding type. Can be `credit`, `debit`, `prepaid`, or `unknown`. maxLength: 5000 nullable: true type: string generated_card: description: >- ID of a card PaymentMethod generated from the card_present PaymentMethod that may be attached to a Customer for future transactions. Only present if it was possible to generate a card PaymentMethod. maxLength: 5000 nullable: true type: string last4: description: The last four digits of the card. maxLength: 5000 nullable: true type: string network: description: >- Identifies which network this charge was processed on. Can be `amex`, `cartes_bancaires`, `diners`, `discover`, `eftpos_au`, `interac`, `jcb`, `mastercard`, `unionpay`, `visa`, or `unknown`. maxLength: 5000 nullable: true type: string preferred_locales: description: >- EMV tag 5F2D. Preferred languages specified by the integrated circuit chip. items: maxLength: 5000 type: string nullable: true type: array read_method: description: How card details were read in this transaction. enum: - contact_emv - contactless_emv - contactless_magstripe_mode - magnetic_stripe_fallback - magnetic_stripe_track2 nullable: true type: string receipt: anyOf: - $ref: >- #/components/schemas/payment_method_details_interac_present_receipt description: >- A collection of fields required to be displayed on receipts. Only required for EMV transactions. nullable: true required: - exp_month - exp_year title: payment_method_details_interac_present type: object x-expandableFields: - receipt payment_method_details_interac_present_receipt: description: '' properties: account_type: description: The type of account being debited or credited enum: - checking - savings - unknown type: string x-stripeBypassValidation: true application_cryptogram: description: 'EMV tag 9F26, cryptogram generated by the integrated circuit chip.' maxLength: 5000 nullable: true type: string application_preferred_name: description: Mnenomic of the Application Identifier. maxLength: 5000 nullable: true type: string authorization_code: description: Identifier for this transaction. maxLength: 5000 nullable: true type: string authorization_response_code: description: EMV tag 8A. A code returned by the card issuer. maxLength: 5000 nullable: true type: string cardholder_verification_method: description: >- Describes the method used by the cardholder to verify ownership of the card. One of the following: `approval`, `failure`, `none`, `offline_pin`, `offline_pin_and_signature`, `online_pin`, or `signature`. maxLength: 5000 nullable: true type: string dedicated_file_name: description: >- EMV tag 84. Similar to the application identifier stored on the integrated circuit chip. maxLength: 5000 nullable: true type: string terminal_verification_results: description: >- The outcome of a series of EMV functions performed by the card reader. maxLength: 5000 nullable: true type: string transaction_status_information: description: >- An indication of various EMV functions performed during the transaction. maxLength: 5000 nullable: true type: string title: payment_method_details_interac_present_receipt type: object x-expandableFields: [] payment_method_details_klarna: description: '' properties: payment_method_category: description: >- The Klarna payment method used for this transaction. Can be one of `pay_later`, `pay_now`, `pay_with_financing`, or `pay_in_installments` maxLength: 5000 nullable: true type: string preferred_locale: description: >- Preferred language of the Klarna authorization page that the customer is redirected to. Can be one of `de-AT`, `en-AT`, `nl-BE`, `fr-BE`, `en-BE`, `de-DE`, `en-DE`, `da-DK`, `en-DK`, `es-ES`, `en-ES`, `fi-FI`, `sv-FI`, `en-FI`, `en-GB`, `en-IE`, `it-IT`, `en-IT`, `nl-NL`, `en-NL`, `nb-NO`, `en-NO`, `sv-SE`, `en-SE`, `en-US`, `es-US`, `fr-FR`, `en-FR`, `cs-CZ`, `en-CZ`, `el-GR`, `en-GR`, `en-AU`, `en-NZ`, `en-CA`, `fr-CA`, `pl-PL`, `en-PL`, `pt-PT`, `en-PT`, `de-CH`, `fr-CH`, `it-CH`, or `en-CH` maxLength: 5000 nullable: true type: string title: payment_method_details_klarna type: object x-expandableFields: [] payment_method_details_konbini: description: '' properties: store: anyOf: - $ref: '#/components/schemas/payment_method_details_konbini_store' description: >- If the payment succeeded, this contains the details of the convenience store where the payment was completed. nullable: true title: payment_method_details_konbini type: object x-expandableFields: - store payment_method_details_konbini_store: description: '' properties: chain: description: >- The name of the convenience store chain where the payment was completed. enum: - familymart - lawson - ministop - seicomart nullable: true type: string title: payment_method_details_konbini_store type: object x-expandableFields: [] payment_method_details_link: description: '' properties: country: description: >- Two-letter ISO code representing the funding source country beneath the Link payment. You could use this attribute to get a sense of international fees. maxLength: 5000 nullable: true type: string title: payment_method_details_link type: object x-expandableFields: [] payment_method_details_mobilepay: description: '' properties: card: anyOf: - $ref: '#/components/schemas/internal_card' nullable: true title: payment_method_details_mobilepay type: object x-expandableFields: - card payment_method_details_multibanco: description: '' properties: entity: description: Entity number associated with this Multibanco payment. maxLength: 5000 nullable: true type: string reference: description: Reference number associated with this Multibanco payment. maxLength: 5000 nullable: true type: string title: payment_method_details_multibanco type: object x-expandableFields: [] payment_method_details_oxxo: description: '' properties: number: description: OXXO reference number maxLength: 5000 nullable: true type: string title: payment_method_details_oxxo type: object x-expandableFields: [] payment_method_details_p24: description: '' properties: bank: description: >- The customer's bank. Can be one of `ing`, `citi_handlowy`, `tmobile_usbugi_bankowe`, `plus_bank`, `etransfer_pocztowy24`, `banki_spbdzielcze`, `bank_nowy_bfg_sa`, `getin_bank`, `velobank`, `blik`, `noble_pay`, `ideabank`, `envelobank`, `santander_przelew24`, `nest_przelew`, `mbank_mtransfer`, `inteligo`, `pbac_z_ipko`, `bnp_paribas`, `credit_agricole`, `toyota_bank`, `bank_pekao_sa`, `volkswagen_bank`, `bank_millennium`, `alior_bank`, or `boz`. enum: - 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: true type: string reference: description: Unique reference for this Przelewy24 payment. maxLength: 5000 nullable: true type: string verified_name: description: >- Owner's verified full name. Values are verified or provided by Przelewy24 directly (if supported) at the time of authorization or settlement. They cannot be set or mutated. Przelewy24 rarely provides this information so the attribute is usually empty. maxLength: 5000 nullable: true type: string title: payment_method_details_p24 type: object x-expandableFields: [] payment_method_details_paynow: description: '' properties: reference: description: Reference number associated with this PayNow payment maxLength: 5000 nullable: true type: string title: payment_method_details_paynow type: object x-expandableFields: [] payment_method_details_paypal: description: '' properties: payer_email: description: >- Owner's email. Values are provided by PayPal directly (if supported) at the time of authorization or settlement. They cannot be set or mutated. maxLength: 5000 nullable: true type: string payer_id: description: >- PayPal account PayerID. This identifier uniquely identifies the PayPal customer. maxLength: 5000 nullable: true type: string payer_name: description: >- Owner's full name. Values provided by PayPal directly (if supported) at the time of authorization or settlement. They cannot be set or mutated. maxLength: 5000 nullable: true type: string seller_protection: anyOf: - $ref: '#/components/schemas/paypal_seller_protection' description: >- The level of protection offered as defined by PayPal Seller Protection for Merchants, for this transaction. nullable: true transaction_id: description: A unique ID generated by PayPal for this transaction. maxLength: 5000 nullable: true type: string title: payment_method_details_paypal type: object x-expandableFields: - seller_protection payment_method_details_pix: description: '' properties: bank_transaction_id: description: Unique transaction id generated by BCB maxLength: 5000 nullable: true type: string title: payment_method_details_pix type: object x-expandableFields: [] payment_method_details_promptpay: description: '' properties: reference: description: Bill reference generated by PromptPay maxLength: 5000 nullable: true type: string title: payment_method_details_promptpay type: object x-expandableFields: [] payment_method_details_revolut_pay: description: '' properties: {} title: payment_method_details_revolut_pay type: object x-expandableFields: [] payment_method_details_sepa_debit: description: '' properties: bank_code: description: Bank code of bank associated with the bank account. maxLength: 5000 nullable: true type: string branch_code: description: Branch code of bank associated with the bank account. maxLength: 5000 nullable: true type: string country: description: >- Two-letter ISO code representing the country the bank account is located in. maxLength: 5000 nullable: true type: string fingerprint: description: >- Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same. maxLength: 5000 nullable: true type: string last4: description: Last four characters of the IBAN. maxLength: 5000 nullable: true type: string mandate: description: >- Find the ID of the mandate used for this payment under the [payment_method_details.sepa_debit.mandate](https://stripe.com/docs/api/charges/object#charge_object-payment_method_details-sepa_debit-mandate) property on the Charge. Use this mandate ID to [retrieve the Mandate](https://stripe.com/docs/api/mandates/retrieve). maxLength: 5000 nullable: true type: string title: payment_method_details_sepa_debit type: object x-expandableFields: [] payment_method_details_sofort: description: '' properties: bank_code: description: Bank code of bank associated with the bank account. maxLength: 5000 nullable: true type: string bank_name: description: Name of the bank associated with the bank account. maxLength: 5000 nullable: true type: string bic: description: Bank Identifier Code of the bank associated with the bank account. maxLength: 5000 nullable: true type: string country: description: >- Two-letter ISO code representing the country the bank account is located in. maxLength: 5000 nullable: true type: string generated_sepa_debit: anyOf: - maxLength: 5000 type: string - $ref: '#/components/schemas/payment_method' description: >- The ID of the SEPA Direct Debit PaymentMethod which was generated by this Charge. nullable: true x-expansionResources: oneOf: - $ref: '#/components/schemas/payment_method' generated_sepa_debit_mandate: anyOf: - maxLength: 5000 type: string - $ref: '#/components/schemas/mandate' description: >- The mandate for the SEPA Direct Debit PaymentMethod which was generated by this Charge. nullable: true x-expansionResources: oneOf: - $ref: '#/components/schemas/mandate' iban_last4: description: Last four characters of the IBAN. maxLength: 5000 nullable: true type: string preferred_language: description: >- Preferred language of the SOFORT authorization page that the customer is redirected to. Can be one of `de`, `en`, `es`, `fr`, `it`, `nl`, or `pl` enum: - de - en - es - fr - it - nl - pl nullable: true type: string verified_name: description: >- 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. maxLength: 5000 nullable: true type: string title: payment_method_details_sofort type: object x-expandableFields: - generated_sepa_debit - generated_sepa_debit_mandate payment_method_details_stripe_account: description: '' properties: {} title: payment_method_details_stripe_account type: object x-expandableFields: [] payment_method_details_swish: description: '' properties: fingerprint: description: >- Uniquely identifies the payer's Swish account. You can use this attribute to check whether two Swish transactions were paid for by the same payer maxLength: 5000 nullable: true type: string payment_reference: description: Payer bank reference number for the payment maxLength: 5000 nullable: true type: string verified_phone_last4: description: The last four digits of the Swish account phone number maxLength: 5000 nullable: true type: string title: payment_method_details_swish type: object x-expandableFields: [] payment_method_details_us_bank_account: description: '' properties: account_holder_type: description: 'Account holder type: individual or company.' enum: - company - individual nullable: true type: string account_type: description: 'Account type: checkings or savings. Defaults to checking if omitted.' enum: - checking - savings nullable: true type: string bank_name: description: Name of the bank associated with the bank account. maxLength: 5000 nullable: true type: string fingerprint: description: >- Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same. maxLength: 5000 nullable: true type: string last4: description: Last four digits of the bank account number. maxLength: 5000 nullable: true type: string mandate: anyOf: - maxLength: 5000 type: string - $ref: '#/components/schemas/mandate' description: ID of the mandate used to make this payment. x-expansionResources: oneOf: - $ref: '#/components/schemas/mandate' payment_reference: description: Reference number to locate ACH payments with customer's bank. maxLength: 5000 nullable: true type: string routing_number: description: Routing number of the bank account. maxLength: 5000 nullable: true type: string title: payment_method_details_us_bank_account type: object x-expandableFields: - mandate payment_method_details_wechat: description: '' properties: {} title: payment_method_details_wechat type: object x-expandableFields: [] payment_method_details_wechat_pay: description: '' properties: fingerprint: description: >- Uniquely identifies this particular WeChat Pay account. You can use this attribute to check whether two WeChat accounts are the same. maxLength: 5000 nullable: true type: string transaction_id: description: Transaction ID of this particular WeChat Pay transaction. maxLength: 5000 nullable: true type: string title: payment_method_details_wechat_pay type: object x-expandableFields: [] payment_method_details_zip: description: '' properties: {} title: payment_method_details_zip type: object x-expandableFields: [] payment_method_domain: description: >- A payment method domain represents a web domain that you have registered with Stripe. Stripe Elements use registered payment method domains to control where certain payment methods are shown. Related guides: [Payment method domains](https://stripe.com/docs/payments/payment-methods/pmd-registration). properties: apple_pay: $ref: >- #/components/schemas/payment_method_domain_resource_payment_method_status created: description: >- Time at which the object was created. Measured in seconds since the Unix epoch. format: unix-time type: integer domain_name: description: The domain name that this payment method domain object represents. maxLength: 5000 type: string enabled: description: >- Whether this payment method domain is enabled. If the domain is not enabled, payment methods that require a payment method domain will not appear in Elements. type: boolean google_pay: $ref: >- #/components/schemas/payment_method_domain_resource_payment_method_status id: description: Unique identifier for the object. maxLength: 5000 type: string link: $ref: >- #/components/schemas/payment_method_domain_resource_payment_method_status livemode: description: >- Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. type: boolean object: description: >- String representing the object's type. Objects of the same type share the same value. enum: - payment_method_domain type: string paypal: $ref: >- #/components/schemas/payment_method_domain_resource_payment_method_status required: - apple_pay - created - domain_name - enabled - google_pay - id - link - livemode - object - paypal title: PaymentMethodDomainResourcePaymentMethodDomain type: object x-expandableFields: - apple_pay - google_pay - link - paypal x-resourceId: payment_method_domain payment_method_domain_resource_payment_method_status: description: >- Indicates the status of a specific payment method on a payment method domain. properties: status: description: The status of the payment method on the domain. enum: - active - inactive type: string status_details: $ref: >- #/components/schemas/payment_method_domain_resource_payment_method_status_details required: - status title: PaymentMethodDomainResourcePaymentMethodStatus type: object x-expandableFields: - status_details payment_method_domain_resource_payment_method_status_details: description: >- Contains additional details about the status of a payment method for a specific payment method domain. properties: error_message: description: >- The error message associated with the status of the payment method on the domain. maxLength: 5000 type: string required: - error_message title: PaymentMethodDomainResourcePaymentMethodStatusDetails type: object x-expandableFields: [] payment_method_eps: description: '' properties: bank: description: >- 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`. enum: - 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: true type: string title: payment_method_eps type: object x-expandableFields: [] payment_method_fpx: description: '' properties: bank: description: >- 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`. enum: - 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 type: string required: - bank title: payment_method_fpx type: object x-expandableFields: [] payment_method_giropay: description: '' properties: {} title: payment_method_giropay type: object x-expandableFields: [] payment_method_grabpay: description: '' properties: {} title: payment_method_grabpay type: object x-expandableFields: [] payment_method_ideal: description: '' properties: bank: description: >- 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`. enum: - abn_amro - asn_bank - bunq - handelsbanken - ing - knab - moneyou - n26 - nn - rabobank - regiobank - revolut - sns_bank - triodos_bank - van_lanschot - yoursafe nullable: true type: string bic: description: >- The Bank Identifier Code of the customer's bank, if the bank was provided. enum: - ABNANL2A - ASNBNL21 - BITSNL2A - BUNQNL2A - FVLBNL22 - HANDNL2A - INGBNL2A - KNABNL2H - MOYONL21 - NNBANL2G - NTSBDEB1 - RABONL2U - RBRBNL21 - REVOIE23 - REVOLT21 - SNSBNL2A - TRIONL2U nullable: true type: string title: payment_method_ideal type: object x-expandableFields: [] payment_method_interac_present: description: '' properties: brand: description: 'Card brand. Can be `interac`, `mastercard` or `visa`.' maxLength: 5000 nullable: true type: string cardholder_name: description: >- 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. maxLength: 5000 nullable: true type: string country: description: >- 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. maxLength: 5000 nullable: true type: string exp_month: description: Two-digit number representing the card's expiration month. type: integer exp_year: description: Four-digit number representing the card's expiration year. type: integer fingerprint: description: >- 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.* maxLength: 5000 nullable: true type: string funding: description: >- Card funding type. Can be `credit`, `debit`, `prepaid`, or `unknown`. maxLength: 5000 nullable: true type: string last4: description: The last four digits of the card. maxLength: 5000 nullable: true type: string networks: anyOf: - $ref: '#/components/schemas/payment_method_card_present_networks' description: >- Contains information about card networks that can be used to process the payment. nullable: true preferred_locales: description: >- EMV tag 5F2D. Preferred languages specified by the integrated circuit chip. items: maxLength: 5000 type: string nullable: true type: array read_method: description: How card details were read in this transaction. enum: - contact_emv - contactless_emv - contactless_magstripe_mode - magnetic_stripe_fallback - magnetic_stripe_track2 nullable: true type: string required: - exp_month - exp_year title: payment_method_interac_present type: object x-expandableFields: - networks payment_method_klarna: description: '' properties: dob: anyOf: - $ref: >- #/components/schemas/payment_flows_private_payment_methods_klarna_dob description: 'The customer''s date of birth, if provided.' nullable: true title: payment_method_klarna type: object x-expandableFields: - dob payment_method_konbini: description: '' properties: {} title: payment_method_konbini type: object x-expandableFields: [] payment_method_link: description: '' properties: email: description: Account owner's email address. maxLength: 5000 nullable: true type: string title: payment_method_link type: object x-expandableFields: [] payment_method_mobilepay: description: '' properties: {} title: payment_method_mobilepay type: object x-expandableFields: [] payment_method_options_affirm: description: '' properties: capture_method: description: >- Controls when the funds will be captured from the customer's account. enum: - manual type: string preferred_locale: description: >- Preferred language of the Affirm authorization page that the customer is redirected to. maxLength: 30 type: string setup_future_usage: description: >- Indicates that you intend to make future payments with this PaymentIntent's payment method. Providing this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes. When processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication). enum: - none type: string title: payment_method_options_affirm type: object x-expandableFields: [] payment_method_options_afterpay_clearpay: description: '' properties: capture_method: description: >- Controls when the funds will be captured from the customer's account. enum: - manual type: string reference: description: >- An internal identifier or reference that this payment corresponds to. You must limit the identifier to 128 characters, and it can only contain letters, numbers, underscores, backslashes, and dashes. This field differs from the statement descriptor and item name. maxLength: 5000 nullable: true type: string setup_future_usage: description: >- Indicates that you intend to make future payments with this PaymentIntent's payment method. Providing this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes. When processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication). enum: - none type: string x-stripeBypassValidation: true title: payment_method_options_afterpay_clearpay type: object x-expandableFields: [] payment_method_options_alipay: description: '' properties: setup_future_usage: description: >- Indicates that you intend to make future payments with this PaymentIntent's payment method. Providing this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes. When processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication). enum: - none - off_session type: string title: payment_method_options_alipay type: object x-expandableFields: [] payment_method_options_amazon_pay: description: '' properties: capture_method: description: >- Controls when the funds will be captured from the customer's account. enum: - manual type: string title: payment_method_options_amazon_pay type: object x-expandableFields: [] payment_method_options_bacs_debit: description: '' properties: setup_future_usage: description: >- Indicates that you intend to make future payments with this PaymentIntent's payment method. Providing this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes. When processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication). enum: - none - off_session - on_session type: string title: payment_method_options_bacs_debit type: object x-expandableFields: [] payment_method_options_bancontact: description: '' properties: preferred_language: description: >- Preferred language of the Bancontact authorization page that the customer is redirected to. enum: - de - en - fr - nl type: string setup_future_usage: description: >- Indicates that you intend to make future payments with this PaymentIntent's payment method. Providing this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes. When processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication). enum: - none - off_session type: string required: - preferred_language title: payment_method_options_bancontact type: object x-expandableFields: [] payment_method_options_boleto: description: '' properties: expires_after_days: description: >- The number of calendar days before a Boleto voucher expires. For example, if you create a Boleto voucher on Monday and you set expires_after_days to 2, the Boleto voucher will expire on Wednesday at 23:59 America/Sao_Paulo time. type: integer setup_future_usage: description: >- Indicates that you intend to make future payments with this PaymentIntent's payment method. Providing this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes. When processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication). enum: - none - off_session - on_session type: string required: - expires_after_days title: payment_method_options_boleto type: object x-expandableFields: [] payment_method_options_card_installments: description: '' properties: available_plans: description: Installment plans that may be selected for this PaymentIntent. items: $ref: '#/components/schemas/payment_method_details_card_installments_plan' nullable: true type: array enabled: description: Whether Installments are enabled for this PaymentIntent. type: boolean plan: anyOf: - $ref: >- #/components/schemas/payment_method_details_card_installments_plan description: Installment plan selected for this PaymentIntent. nullable: true required: - enabled title: payment_method_options_card_installments type: object x-expandableFields: - available_plans - plan payment_method_options_card_mandate_options: description: '' properties: amount: description: Amount to be charged for future payments. type: integer amount_type: description: >- One of `fixed` or `maximum`. If `fixed`, the `amount` param refers to the exact amount to be charged in future payments. If `maximum`, the amount charged can be up to the value passed for the `amount` param. enum: - fixed - maximum type: string description: description: >- A description of the mandate or subscription that is meant to be displayed to the customer. maxLength: 200 nullable: true type: string end_date: description: >- End date of the mandate or subscription. If not provided, the mandate will be active until canceled. If provided, end date should be after start date. format: unix-time nullable: true type: integer interval: description: >- Specifies payment frequency. One of `day`, `week`, `month`, `year`, or `sporadic`. enum: - day - month - sporadic - week - year type: string interval_count: description: >- The number of intervals between payments. For example, `interval=month` and `interval_count=3` indicates one payment every three months. Maximum of one year interval allowed (1 year, 12 months, or 52 weeks). This parameter is optional when `interval=sporadic`. nullable: true type: integer reference: description: Unique identifier for the mandate or subscription. maxLength: 80 type: string start_date: description: >- Start date of the mandate or subscription. Start date should not be lesser than yesterday. format: unix-time type: integer supported_types: description: >- Specifies the type of mandates supported. Possible values are `india`. items: enum: - india type: string nullable: true type: array required: - amount - amount_type - interval - reference - start_date title: payment_method_options_card_mandate_options type: object x-expandableFields: [] payment_method_options_card_present: description: '' properties: request_extended_authorization: description: >- Request ability to capture this payment beyond the standard [authorization validity window](https://stripe.com/docs/terminal/features/extended-authorizations#authorization-validity) nullable: true type: boolean request_incremental_authorization_support: description: >- Request ability to [increment](https://stripe.com/docs/terminal/features/incremental-authorizations) this PaymentIntent if the combination of MCC and card brand is eligible. Check [incremental_authorization_supported](https://stripe.com/docs/api/charges/object#charge_object-payment_method_details-card_present-incremental_authorization_supported) in the [Confirm](https://stripe.com/docs/api/payment_intents/confirm) response to verify support. nullable: true type: boolean title: payment_method_options_card_present type: object x-expandableFields: [] payment_method_options_cashapp: description: '' properties: capture_method: description: >- Controls when the funds will be captured from the customer's account. enum: - manual type: string setup_future_usage: description: >- Indicates that you intend to make future payments with this PaymentIntent's payment method. Providing this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes. When processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication). enum: - none - off_session - on_session type: string title: payment_method_options_cashapp type: object x-expandableFields: [] payment_method_options_customer_balance: description: '' properties: bank_transfer: $ref: >- #/components/schemas/payment_method_options_customer_balance_bank_transfer funding_type: description: >- The funding method type to be used when there are not enough funds in the customer balance. Permitted values include: `bank_transfer`. enum: - bank_transfer nullable: true type: string setup_future_usage: description: >- Indicates that you intend to make future payments with this PaymentIntent's payment method. Providing this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes. When processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication). enum: - none type: string title: payment_method_options_customer_balance type: object x-expandableFields: - bank_transfer payment_method_options_customer_balance_bank_transfer: description: '' properties: eu_bank_transfer: $ref: >- #/components/schemas/payment_method_options_customer_balance_eu_bank_account requested_address_types: description: >- List of address types that should be returned in the financial_addresses response. If not specified, all valid types will be returned. Permitted values include: `sort_code`, `zengin`, `iban`, or `spei`. items: enum: - aba - iban - sepa - sort_code - spei - swift - zengin type: string x-stripeBypassValidation: true type: array type: description: >- The bank transfer type that this PaymentIntent is allowed to use for funding Permitted values include: `eu_bank_transfer`, `gb_bank_transfer`, `jp_bank_transfer`, `mx_bank_transfer`, or `us_bank_transfer`. enum: - eu_bank_transfer - gb_bank_transfer - jp_bank_transfer - mx_bank_transfer - us_bank_transfer nullable: true type: string x-stripeBypassValidation: true title: payment_method_options_customer_balance_bank_transfer type: object x-expandableFields: - eu_bank_transfer payment_method_options_customer_balance_eu_bank_account: description: '' properties: country: description: >- The desired country code of the bank account information. Permitted values include: `BE`, `DE`, `ES`, `FR`, `IE`, or `NL`. enum: - BE - DE - ES - FR - IE - NL type: string required: - country title: payment_method_options_customer_balance_eu_bank_account type: object x-expandableFields: [] payment_method_options_fpx: description: '' properties: setup_future_usage: description: >- Indicates that you intend to make future payments with this PaymentIntent's payment method. Providing this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes. When processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication). enum: - none type: string title: payment_method_options_fpx type: object x-expandableFields: [] payment_method_options_giropay: description: '' properties: setup_future_usage: description: >- Indicates that you intend to make future payments with this PaymentIntent's payment method. Providing this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes. When processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication). enum: - none type: string title: payment_method_options_giropay type: object x-expandableFields: [] payment_method_options_grabpay: description: '' properties: setup_future_usage: description: >- Indicates that you intend to make future payments with this PaymentIntent's payment method. Providing this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes. When processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication). enum: - none type: string title: payment_method_options_grabpay type: object x-expandableFields: [] payment_method_options_ideal: description: '' properties: setup_future_usage: description: >- Indicates that you intend to make future payments with this PaymentIntent's payment method. Providing this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes. When processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication). enum: - none - off_session type: string title: payment_method_options_ideal type: object x-expandableFields: [] payment_method_options_interac_present: description: '' properties: {} title: payment_method_options_interac_present type: object x-expandableFields: [] payment_method_options_klarna: description: '' properties: capture_method: description: >- Controls when the funds will be captured from the customer's account. enum: - manual type: string preferred_locale: description: >- Preferred locale of the Klarna checkout page that the customer is redirected to. maxLength: 5000 nullable: true type: string setup_future_usage: description: >- Indicates that you intend to make future payments with this PaymentIntent's payment method. Providing this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes. When processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication). enum: - none type: string x-stripeBypassValidation: true title: payment_method_options_klarna type: object x-expandableFields: [] payment_method_options_konbini: description: '' properties: confirmation_number: description: >- An optional 10 to 11 digit numeric-only string determining the confirmation code at applicable convenience stores. maxLength: 5000 nullable: true type: string expires_after_days: description: >- The number of calendar days (between 1 and 60) after which Konbini payment instructions will expire. For example, if a PaymentIntent is confirmed with Konbini and `expires_after_days` set to 2 on Monday JST, the instructions will expire on Wednesday 23:59:59 JST. nullable: true type: integer expires_at: description: >- The timestamp at which the Konbini payment instructions will expire. Only one of `expires_after_days` or `expires_at` may be set. format: unix-time nullable: true type: integer product_description: description: >- A product descriptor of up to 22 characters, which will appear to customers at the convenience store. maxLength: 5000 nullable: true type: string setup_future_usage: description: >- Indicates that you intend to make future payments with this PaymentIntent's payment method. Providing this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes. When processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication). enum: - none type: string title: payment_method_options_konbini type: object x-expandableFields: [] payment_method_options_oxxo: description: '' properties: expires_after_days: description: >- The number of calendar days before an OXXO invoice expires. For example, if you create an OXXO invoice on Monday and you set expires_after_days to 2, the OXXO invoice will expire on Wednesday at 23:59 America/Mexico_City time. type: integer setup_future_usage: description: >- Indicates that you intend to make future payments with this PaymentIntent's payment method. Providing this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes. When processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication). enum: - none type: string required: - expires_after_days title: payment_method_options_oxxo type: object x-expandableFields: [] payment_method_options_p24: description: '' properties: setup_future_usage: description: >- Indicates that you intend to make future payments with this PaymentIntent's payment method. Providing this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes. When processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication). enum: - none type: string title: payment_method_options_p24 type: object x-expandableFields: [] payment_method_options_paynow: description: '' properties: setup_future_usage: description: >- Indicates that you intend to make future payments with this PaymentIntent's payment method. Providing this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes. When processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication). enum: - none type: string title: payment_method_options_paynow type: object x-expandableFields: [] payment_method_options_paypal: description: '' properties: capture_method: description: >- Controls when the funds will be captured from the customer's account. enum: - manual type: string preferred_locale: description: >- Preferred locale of the PayPal checkout page that the customer is redirected to. maxLength: 5000 nullable: true type: string reference: description: >- A reference of the PayPal transaction visible to customer which is mapped to PayPal's invoice ID. This must be a globally unique ID if you have configured in your PayPal settings to block multiple payments per invoice ID. maxLength: 5000 nullable: true type: string setup_future_usage: description: >- Indicates that you intend to make future payments with this PaymentIntent's payment method. Providing this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes. When processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication). enum: - none - off_session type: string title: payment_method_options_paypal type: object x-expandableFields: [] payment_method_options_pix: description: '' properties: expires_after_seconds: description: >- The number of seconds (between 10 and 1209600) after which Pix payment will expire. nullable: true type: integer expires_at: description: The timestamp at which the Pix expires. nullable: true type: integer setup_future_usage: description: >- Indicates that you intend to make future payments with this PaymentIntent's payment method. Providing this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes. When processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication). enum: - none type: string title: payment_method_options_pix type: object x-expandableFields: [] payment_method_options_promptpay: description: '' properties: setup_future_usage: description: >- Indicates that you intend to make future payments with this PaymentIntent's payment method. Providing this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes. When processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication). enum: - none type: string title: payment_method_options_promptpay type: object x-expandableFields: [] payment_method_options_revolut_pay: description: '' properties: capture_method: description: >- Controls when the funds will be captured from the customer's account. enum: - manual type: string title: payment_method_options_revolut_pay type: object x-expandableFields: [] payment_method_options_sofort: description: '' properties: preferred_language: description: >- Preferred language of the SOFORT authorization page that the customer is redirected to. enum: - de - en - es - fr - it - nl - pl nullable: true type: string setup_future_usage: description: >- Indicates that you intend to make future payments with this PaymentIntent's payment method. Providing this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes. When processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication). enum: - none - off_session type: string title: payment_method_options_sofort type: object x-expandableFields: [] payment_method_options_us_bank_account_mandate_options: description: '' properties: collection_method: description: Mandate collection method enum: - paper type: string x-stripeBypassValidation: true title: payment_method_options_us_bank_account_mandate_options type: object x-expandableFields: [] payment_method_options_wechat_pay: description: '' properties: app_id: description: >- The app ID registered with WeChat Pay. Only required when client is ios or android. maxLength: 5000 nullable: true type: string client: description: The client type that the end customer will pay from enum: - android - ios - web nullable: true type: string x-stripeBypassValidation: true setup_future_usage: description: >- Indicates that you intend to make future payments with this PaymentIntent's payment method. Providing this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes. When processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication). enum: - none type: string title: payment_method_options_wechat_pay type: object x-expandableFields: [] payment_method_options_zip: description: '' properties: setup_future_usage: description: >- Indicates that you intend to make future payments with this PaymentIntent's payment method. Providing this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes. When processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication). enum: - none type: string title: payment_method_options_zip type: object x-expandableFields: [] payment_method_oxxo: description: '' properties: {} title: payment_method_oxxo type: object x-expandableFields: [] payment_method_p24: description: '' properties: bank: description: 'The customer''s bank, if provided.' enum: - 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: true type: string x-stripeBypassValidation: true title: payment_method_p24 type: object x-expandableFields: [] payment_method_paynow: description: '' properties: {} title: payment_method_paynow type: object x-expandableFields: [] payment_method_paypal: description: '' properties: payer_email: description: >- Owner's email. Values are provided by PayPal directly (if supported) at the time of authorization or settlement. They cannot be set or mutated. maxLength: 5000 nullable: true type: string payer_id: description: >- PayPal account PayerID. This identifier uniquely identifies the PayPal customer. maxLength: 5000 nullable: true type: string title: payment_method_paypal type: object x-expandableFields: [] payment_method_pix: description: '' properties: {} title: payment_method_pix type: object x-expandableFields: [] payment_method_promptpay: description: '' properties: {} title: payment_method_promptpay type: object x-expandableFields: [] payment_method_revolut_pay: description: '' properties: {} title: payment_method_revolut_pay type: object x-expandableFields: [] payment_method_sepa_debit: description: '' properties: bank_code: description: Bank code of bank associated with the bank account. maxLength: 5000 nullable: true type: string branch_code: description: Branch code of bank associated with the bank account. maxLength: 5000 nullable: true type: string country: description: >- Two-letter ISO code representing the country the bank account is located in. maxLength: 5000 nullable: true type: string fingerprint: description: >- Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same. maxLength: 5000 nullable: true type: string generated_from: anyOf: - $ref: '#/components/schemas/sepa_debit_generated_from' description: Information about the object that generated this PaymentMethod. nullable: true last4: description: Last four characters of the IBAN. maxLength: 5000 nullable: true type: string title: payment_method_sepa_debit type: object x-expandableFields: - generated_from payment_method_sofort: description: '' properties: country: description: >- Two-letter ISO code representing the country the bank account is located in. maxLength: 5000 nullable: true type: string title: payment_method_sofort type: object x-expandableFields: [] payment_method_swish: description: '' properties: {} title: payment_method_swish type: object x-expandableFields: [] payment_method_us_bank_account: description: '' properties: account_holder_type: description: 'Account holder type: individual or company.' enum: - company - individual nullable: true type: string account_type: description: 'Account type: checkings or savings. Defaults to checking if omitted.' enum: - checking - savings nullable: true type: string bank_name: description: The name of the bank. maxLength: 5000 nullable: true type: string financial_connections_account: description: >- The ID of the Financial Connections Account used to create the payment method. maxLength: 5000 nullable: true type: string fingerprint: description: >- Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same. maxLength: 5000 nullable: true type: string last4: description: Last four digits of the bank account number. maxLength: 5000 nullable: true type: string networks: anyOf: - $ref: '#/components/schemas/us_bank_account_networks' description: >- Contains information about US bank account networks that can be used. nullable: true routing_number: description: Routing number of the bank account. maxLength: 5000 nullable: true type: string status_details: anyOf: - $ref: >- #/components/schemas/payment_method_us_bank_account_status_details description: >- Contains information about the future reusability of this PaymentMethod. nullable: true title: payment_method_us_bank_account type: object x-expandableFields: - networks - status_details payment_method_us_bank_account_blocked: description: '' properties: network_code: description: The ACH network code that resulted in this block. enum: - R02 - R03 - R04 - R05 - R07 - R08 - R10 - R11 - R16 - R20 - R29 - R31 nullable: true type: string reason: description: The reason why this PaymentMethod's fingerprint has been blocked enum: - bank_account_closed - bank_account_frozen - bank_account_invalid_details - bank_account_restricted - bank_account_unusable - debit_not_authorized nullable: true type: string title: payment_method_us_bank_account_blocked type: object x-expandableFields: [] payment_method_us_bank_account_status_details: description: '' properties: blocked: $ref: '#/components/schemas/payment_method_us_bank_account_blocked' title: payment_method_us_bank_account_status_details type: object x-expandableFields: - blocked payment_method_wechat_pay: description: '' properties: {} title: payment_method_wechat_pay type: object x-expandableFields: [] payment_method_zip: description: '' properties: {} title: payment_method_zip type: object x-expandableFields: [] payment_pages_checkout_session_after_expiration: description: '' properties: recovery: anyOf: - $ref: >- #/components/schemas/payment_pages_checkout_session_after_expiration_recovery description: >- When set, configuration used to recover the Checkout Session on expiry. nullable: true title: PaymentPagesCheckoutSessionAfterExpiration type: object x-expandableFields: - recovery payment_pages_checkout_session_after_expiration_recovery: description: '' properties: allow_promotion_codes: description: >- Enables user redeemable promotion codes on the recovered Checkout Sessions. Defaults to `false` type: boolean enabled: description: >- If `true`, a recovery url will be generated to recover this Checkout Session if it expires before a transaction is completed. It will be attached to the Checkout Session object upon expiration. type: boolean expires_at: description: The timestamp at which the recovery URL will expire. format: unix-time nullable: true type: integer url: description: >- URL that creates a new Checkout Session when clicked that is a copy of this expired Checkout Session maxLength: 5000 nullable: true type: string required: - allow_promotion_codes - enabled title: PaymentPagesCheckoutSessionAfterExpirationRecovery type: object x-expandableFields: [] payment_pages_checkout_session_automatic_tax: description: '' properties: enabled: description: Indicates whether automatic tax is enabled for the session type: boolean liability: anyOf: - $ref: '#/components/schemas/connect_account_reference' description: >- The account that's liable for tax. If set, the business address and tax registrations required to perform the tax calculation are loaded from this account. The tax transaction is returned in the report of the connected account. nullable: true status: description: >- The status of the most recent automated tax calculation for this session. enum: - complete - failed - requires_location_inputs nullable: true type: string required: - enabled title: PaymentPagesCheckoutSessionAutomaticTax type: object x-expandableFields: - liability payment_pages_checkout_session_consent: description: '' properties: promotions: description: >- If `opt_in`, the customer consents to receiving promotional communications from the merchant about this Checkout Session. enum: - opt_in - opt_out nullable: true type: string terms_of_service: description: >- If `accepted`, the customer in this Checkout Session has agreed to the merchant's terms of service. enum: - accepted nullable: true type: string x-stripeBypassValidation: true title: PaymentPagesCheckoutSessionConsent type: object x-expandableFields: [] payment_pages_checkout_session_consent_collection: description: '' properties: payment_method_reuse_agreement: anyOf: - $ref: >- #/components/schemas/payment_pages_checkout_session_payment_method_reuse_agreement description: >- If set to `hidden`, it will hide legal text related to the reuse of a payment method. nullable: true promotions: description: >- If set to `auto`, enables the collection of customer consent for promotional communications. The Checkout Session will determine whether to display an option to opt into promotional communication from the merchant depending on the customer's locale. Only available to US merchants. enum: - auto - none nullable: true type: string terms_of_service: description: >- If set to `required`, it requires customers to accept the terms of service before being able to pay. enum: - none - required nullable: true type: string title: PaymentPagesCheckoutSessionConsentCollection type: object x-expandableFields: - payment_method_reuse_agreement payment_pages_checkout_session_currency_conversion: description: '' properties: amount_subtotal: description: >- Total of all items in source currency before discounts or taxes are applied. type: integer amount_total: description: >- Total of all items in source currency after discounts and taxes are applied. type: integer fx_rate: description: >- Exchange rate used to convert source currency amounts to customer currency amounts format: decimal type: string source_currency: description: Creation currency of the CheckoutSession before localization maxLength: 5000 type: string required: - amount_subtotal - amount_total - fx_rate - source_currency title: PaymentPagesCheckoutSessionCurrencyConversion type: object x-expandableFields: [] payment_pages_checkout_session_custom_fields: description: '' properties: dropdown: $ref: >- #/components/schemas/payment_pages_checkout_session_custom_fields_dropdown key: description: >- String of your choice that your integration can use to reconcile this field. Must be unique to this field, alphanumeric, and up to 200 characters. maxLength: 5000 type: string label: $ref: >- #/components/schemas/payment_pages_checkout_session_custom_fields_label numeric: $ref: >- #/components/schemas/payment_pages_checkout_session_custom_fields_numeric optional: description: >- Whether the customer is required to complete the field before completing the Checkout Session. Defaults to `false`. type: boolean text: $ref: >- #/components/schemas/payment_pages_checkout_session_custom_fields_text type: description: The type of the field. enum: - dropdown - numeric - text type: string required: - key - label - optional - type title: PaymentPagesCheckoutSessionCustomFields type: object x-expandableFields: - dropdown - label - numeric - text payment_pages_checkout_session_custom_fields_dropdown: description: '' properties: options: description: >- The options available for the customer to select. Up to 200 options allowed. items: $ref: >- #/components/schemas/payment_pages_checkout_session_custom_fields_option type: array value: description: >- The option selected by the customer. This will be the `value` for the option. maxLength: 5000 nullable: true type: string required: - options title: PaymentPagesCheckoutSessionCustomFieldsDropdown type: object x-expandableFields: - options payment_pages_checkout_session_custom_fields_label: description: '' properties: custom: description: >- Custom text for the label, displayed to the customer. Up to 50 characters. maxLength: 5000 nullable: true type: string type: description: The type of the label. enum: - custom type: string required: - type title: PaymentPagesCheckoutSessionCustomFieldsLabel type: object x-expandableFields: [] payment_pages_checkout_session_custom_fields_numeric: description: '' properties: maximum_length: description: The maximum character length constraint for the customer's input. nullable: true type: integer minimum_length: description: The minimum character length requirement for the customer's input. nullable: true type: integer value: description: 'The value entered by the customer, containing only digits.' maxLength: 5000 nullable: true type: string title: PaymentPagesCheckoutSessionCustomFieldsNumeric type: object x-expandableFields: [] payment_pages_checkout_session_custom_fields_option: description: '' properties: label: description: >- The label for the option, displayed to the customer. Up to 100 characters. maxLength: 5000 type: string value: description: >- The value for this option, not displayed to the customer, used by your integration to reconcile the option selected by the customer. Must be unique to this option, alphanumeric, and up to 100 characters. maxLength: 5000 type: string required: - label - value title: PaymentPagesCheckoutSessionCustomFieldsOption type: object x-expandableFields: [] payment_pages_checkout_session_custom_fields_text: description: '' properties: maximum_length: description: The maximum character length constraint for the customer's input. nullable: true type: integer minimum_length: description: The minimum character length requirement for the customer's input. nullable: true type: integer value: description: The value entered by the customer. maxLength: 5000 nullable: true type: string title: PaymentPagesCheckoutSessionCustomFieldsText type: object x-expandableFields: [] payment_pages_checkout_session_custom_text: description: '' properties: after_submit: anyOf: - $ref: >- #/components/schemas/payment_pages_checkout_session_custom_text_position description: >- Custom text that should be displayed after the payment confirmation button. nullable: true shipping_address: anyOf: - $ref: >- #/components/schemas/payment_pages_checkout_session_custom_text_position description: >- Custom text that should be displayed alongside shipping address collection. nullable: true submit: anyOf: - $ref: >- #/components/schemas/payment_pages_checkout_session_custom_text_position description: >- Custom text that should be displayed alongside the payment confirmation button. nullable: true terms_of_service_acceptance: anyOf: - $ref: >- #/components/schemas/payment_pages_checkout_session_custom_text_position description: >- Custom text that should be displayed in place of the default terms of service agreement text. nullable: true title: PaymentPagesCheckoutSessionCustomText type: object x-expandableFields: - after_submit - shipping_address - submit - terms_of_service_acceptance payment_pages_checkout_session_custom_text_position: description: '' properties: message: description: Text may be up to 1200 characters in length. maxLength: 500 type: string required: - message title: PaymentPagesCheckoutSessionCustomTextPosition type: object x-expandableFields: [] payment_pages_checkout_session_customer_details: description: '' properties: address: anyOf: - $ref: '#/components/schemas/address' description: >- The customer's address after a completed Checkout Session. Note: This property is populated only for sessions on or after March 30, 2022. nullable: true email: description: >- The email associated with the Customer, if one exists, on the Checkout Session after a completed Checkout Session or at time of session expiry. Otherwise, if the customer has consented to promotional content, this value is the most recent valid email provided by the customer on the Checkout form. maxLength: 5000 nullable: true type: string name: description: >- The customer's name after a completed Checkout Session. Note: This property is populated only for sessions on or after March 30, 2022. maxLength: 5000 nullable: true type: string phone: description: The customer's phone number after a completed Checkout Session. maxLength: 5000 nullable: true type: string tax_exempt: description: The customer’s tax exempt status after a completed Checkout Session. enum: - exempt - none - reverse nullable: true type: string tax_ids: description: The customer’s tax IDs after a completed Checkout Session. items: $ref: '#/components/schemas/payment_pages_checkout_session_tax_id' nullable: true type: array title: PaymentPagesCheckoutSessionCustomerDetails type: object x-expandableFields: - address - tax_ids payment_pages_checkout_session_invoice_creation: description: '' properties: enabled: description: >- Indicates whether invoice creation is enabled for the Checkout Session. type: boolean invoice_data: $ref: '#/components/schemas/payment_pages_checkout_session_invoice_settings' required: - enabled - invoice_data title: PaymentPagesCheckoutSessionInvoiceCreation type: object x-expandableFields: - invoice_data payment_pages_checkout_session_invoice_settings: description: '' properties: account_tax_ids: description: The account tax IDs associated with the invoice. items: anyOf: - maxLength: 5000 type: string - $ref: '#/components/schemas/tax_id' - $ref: '#/components/schemas/deleted_tax_id' x-expansionResources: oneOf: - $ref: '#/components/schemas/tax_id' - $ref: '#/components/schemas/deleted_tax_id' nullable: true type: array custom_fields: description: Custom fields displayed on the invoice. items: $ref: '#/components/schemas/invoice_setting_custom_field' nullable: true type: array description: description: >- An arbitrary string attached to the object. Often useful for displaying to users. maxLength: 5000 nullable: true type: string footer: description: Footer displayed on the invoice. maxLength: 5000 nullable: true type: string issuer: anyOf: - $ref: '#/components/schemas/connect_account_reference' description: >- The connected account that issues the invoice. The invoice is presented with the branding and support information of the specified account. nullable: true metadata: additionalProperties: maxLength: 500 type: string description: >- 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. nullable: true type: object rendering_options: anyOf: - $ref: '#/components/schemas/invoice_setting_rendering_options' description: Options for invoice PDF rendering. nullable: true title: PaymentPagesCheckoutSessionInvoiceSettings type: object x-expandableFields: - account_tax_ids - custom_fields - issuer - rendering_options payment_pages_checkout_session_payment_method_reuse_agreement: description: '' properties: position: description: >- Determines the position and visibility of the payment method reuse agreement in the UI. When set to `auto`, Stripe's defaults will be used. When set to `hidden`, the payment method reuse agreement text will always be hidden in the UI. enum: - auto - hidden type: string required: - position title: PaymentPagesCheckoutSessionPaymentMethodReuseAgreement type: object x-expandableFields: [] payment_pages_checkout_session_phone_number_collection: description: '' properties: enabled: description: Indicates whether phone number collection is enabled for the session type: boolean required: - enabled title: PaymentPagesCheckoutSessionPhoneNumberCollection type: object x-expandableFields: [] payment_pages_checkout_session_saved_payment_method_options: description: '' properties: allow_redisplay_filters: description: >- Controls which payment methods are eligible to be redisplayed to returning customers. Corresponds to `allow_redisplay` on the payment method. items: enum: - always - limited - unspecified type: string nullable: true type: array payment_method_save: description: >- Enable customers to choose if they wish to save their payment method for future use. enum: - disabled - enabled nullable: true type: string title: PaymentPagesCheckoutSessionSavedPaymentMethodOptions type: object x-expandableFields: [] payment_pages_checkout_session_shipping_address_collection: description: '' properties: allowed_countries: description: >- An array of two-letter ISO country codes representing which countries Checkout should provide as options for shipping locations. Unsupported country codes: `AS, CX, CC, CU, HM, IR, KP, MH, FM, NF, MP, PW, SD, SY, UM, VI`. items: enum: - AC - AD - AE - AF - AG - AI - AL - AM - AO - AQ - AR - AT - AU - AW - AX - AZ - BA - BB - BD - BE - BF - BG - BH - BI - BJ - BL - BM - BN - BO - BQ - BR - BS - BT - BV - BW - BY - BZ - CA - CD - CF - CG - CH - CI - CK - CL - CM - CN - CO - CR - CV - CW - CY - CZ - DE - DJ - DK - DM - DO - DZ - EC - EE - EG - EH - ER - ES - ET - FI - FJ - FK - FO - FR - GA - GB - GD - GE - GF - GG - GH - GI - GL - GM - GN - GP - GQ - GR - GS - GT - GU - GW - GY - HK - HN - HR - HT - HU - ID - IE - IL - IM - IN - IO - IQ - IS - IT - JE - JM - JO - JP - KE - KG - KH - KI - KM - KN - KR - KW - KY - KZ - LA - LB - LC - LI - LK - LR - LS - LT - LU - LV - LY - MA - MC - MD - ME - MF - MG - MK - ML - MM - MN - MO - MQ - MR - MS - MT - MU - MV - MW - MX - MY - MZ - NA - NC - NE - NG - NI - NL - 'NO' - NP - NR - NU - NZ - OM - PA - PE - PF - PG - PH - PK - PL - PM - PN - PR - PS - PT - PY - QA - RE - RO - RS - RU - RW - SA - SB - SC - SE - SG - SH - SI - SJ - SK - SL - SM - SN - SO - SR - SS - ST - SV - SX - SZ - TA - TC - TD - TF - TG - TH - TJ - TK - TL - TM - TN - TO - TR - TT - TV - TW - TZ - UA - UG - US - UY - UZ - VA - VC - VE - VG - VN - VU - WF - WS - XK - YE - YT - ZA - ZM - ZW - ZZ type: string type: array required: - allowed_countries title: PaymentPagesCheckoutSessionShippingAddressCollection type: object x-expandableFields: [] payment_pages_checkout_session_shipping_cost: description: '' properties: amount_subtotal: description: Total shipping cost before any discounts or taxes are applied. type: integer amount_tax: description: >- Total tax amount applied due to shipping costs. If no tax was applied, defaults to 0. type: integer amount_total: description: Total shipping cost after discounts and taxes are applied. type: integer shipping_rate: anyOf: - maxLength: 5000 type: string - $ref: '#/components/schemas/shipping_rate' description: The ID of the ShippingRate for this order. nullable: true x-expansionResources: oneOf: - $ref: '#/components/schemas/shipping_rate' taxes: description: The taxes applied to the shipping rate. items: $ref: '#/components/schemas/line_items_tax_amount' type: array required: - amount_subtotal - amount_tax - amount_total title: PaymentPagesCheckoutSessionShippingCost type: object x-expandableFields: - shipping_rate - taxes payment_pages_checkout_session_shipping_option: description: '' properties: shipping_amount: description: A non-negative integer in cents representing how much to charge. type: integer shipping_rate: anyOf: - maxLength: 5000 type: string - $ref: '#/components/schemas/shipping_rate' description: The shipping rate. x-expansionResources: oneOf: - $ref: '#/components/schemas/shipping_rate' required: - shipping_amount - shipping_rate title: PaymentPagesCheckoutSessionShippingOption type: object x-expandableFields: - shipping_rate payment_pages_checkout_session_tax_id: description: '' properties: type: description: >- The type of the tax ID, one of `ad_nrt`, `ar_cuit`, `eu_vat`, `bo_tin`, `br_cnpj`, `br_cpf`, `cn_tin`, `co_nit`, `cr_tin`, `do_rcn`, `ec_ruc`, `eu_oss_vat`, `pe_ruc`, `ro_tin`, `rs_pib`, `sv_nit`, `uy_ruc`, `ve_rif`, `vn_tin`, `gb_vat`, `nz_gst`, `au_abn`, `au_arn`, `in_gst`, `no_vat`, `no_voec`, `za_vat`, `ch_vat`, `mx_rfc`, `sg_uen`, `ru_inn`, `ru_kpp`, `ca_bn`, `hk_br`, `es_cif`, `tw_vat`, `th_vat`, `jp_cn`, `jp_rn`, `jp_trn`, `li_uid`, `my_itn`, `us_ein`, `kr_brn`, `ca_qst`, `ca_gst_hst`, `ca_pst_bc`, `ca_pst_mb`, `ca_pst_sk`, `my_sst`, `sg_gst`, `ae_trn`, `cl_tin`, `sa_vat`, `id_npwp`, `my_frp`, `il_vat`, `ge_vat`, `ua_vat`, `is_vat`, `bg_uic`, `hu_tin`, `si_tin`, `ke_pin`, `tr_tin`, `eg_tin`, `ph_tin`, `bh_vat`, `kz_bin`, `ng_tin`, `om_vat`, or `unknown` enum: - ad_nrt - ae_trn - ar_cuit - au_abn - au_arn - bg_uic - bh_vat - bo_tin - br_cnpj - br_cpf - ca_bn - ca_gst_hst - ca_pst_bc - ca_pst_mb - ca_pst_sk - ca_qst - ch_vat - cl_tin - cn_tin - co_nit - cr_tin - do_rcn - ec_ruc - eg_tin - es_cif - eu_oss_vat - eu_vat - gb_vat - ge_vat - hk_br - hu_tin - id_npwp - il_vat - in_gst - is_vat - jp_cn - jp_rn - jp_trn - ke_pin - kr_brn - kz_bin - li_uid - mx_rfc - my_frp - my_itn - my_sst - ng_tin - no_vat - no_voec - nz_gst - om_vat - pe_ruc - ph_tin - ro_tin - rs_pib - ru_inn - ru_kpp - sa_vat - sg_gst - sg_uen - si_tin - sv_nit - th_vat - tr_tin - tw_vat - ua_vat - unknown - us_ein - uy_ruc - ve_rif - vn_tin - za_vat type: string value: description: The value of the tax ID. maxLength: 5000 nullable: true type: string required: - type title: PaymentPagesCheckoutSessionTaxID type: object x-expandableFields: [] payment_pages_checkout_session_tax_id_collection: description: '' properties: enabled: description: Indicates whether tax ID collection is enabled for the session type: boolean required: - enabled title: PaymentPagesCheckoutSessionTaxIDCollection type: object x-expandableFields: [] payment_pages_checkout_session_total_details: description: '' properties: amount_discount: description: This is the sum of all the discounts. type: integer amount_shipping: description: This is the sum of all the shipping amounts. nullable: true type: integer amount_tax: description: This is the sum of all the tax amounts. type: integer breakdown: $ref: >- #/components/schemas/payment_pages_checkout_session_total_details_resource_breakdown required: - amount_discount - amount_tax title: PaymentPagesCheckoutSessionTotalDetails type: object x-expandableFields: - breakdown payment_pages_checkout_session_total_details_resource_breakdown: description: '' properties: discounts: description: The aggregated discounts. items: $ref: '#/components/schemas/line_items_discount_amount' type: array taxes: description: The aggregated tax amounts by rate. items: $ref: '#/components/schemas/line_items_tax_amount' type: array required: - discounts - taxes title: PaymentPagesCheckoutSessionTotalDetailsResourceBreakdown type: object x-expandableFields: - discounts - taxes payment_source: anyOf: - $ref: '#/components/schemas/account' - $ref: '#/components/schemas/bank_account' - $ref: '#/components/schemas/card' - $ref: '#/components/schemas/source' title: Polymorphic x-resourceId: payment_source x-stripeBypassValidation: true payout: description: >- A `Payout` object is created when you receive funds from Stripe, or when you initiate a payout to either a bank account or debit card of a [connected Stripe account](/docs/connect/bank-debit-card-payouts). You can retrieve individual payouts, and list all payouts. Payouts are made on [varying schedules](/docs/connect/manage-payout-schedule), depending on your country and industry. Related guide: [Receiving payouts](https://stripe.com/docs/payouts) properties: amount: description: >- The amount (in cents (or local equivalent)) that transfers to your bank account or debit card. type: integer arrival_date: description: >- Date that you can expect the payout to arrive in the bank. This factors in delays to account for weekends or bank holidays. format: unix-time type: integer automatic: description: >- Returns `true` if the payout is created by an [automated payout schedule](https://stripe.com/docs/payouts#payout-schedule) and `false` if it's [requested manually](https://stripe.com/docs/payouts#manual-payouts). type: boolean balance_transaction: anyOf: - maxLength: 5000 type: string - $ref: '#/components/schemas/balance_transaction' description: >- ID of the balance transaction that describes the impact of this payout on your account balance. nullable: true x-expansionResources: oneOf: - $ref: '#/components/schemas/balance_transaction' created: description: >- Time at which the object was created. Measured in seconds since the Unix epoch. format: unix-time type: integer currency: description: >- 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). type: string description: description: >- An arbitrary string attached to the object. Often useful for displaying to users. maxLength: 5000 nullable: true type: string destination: anyOf: - maxLength: 5000 type: string - $ref: '#/components/schemas/bank_account' - $ref: '#/components/schemas/card' - $ref: '#/components/schemas/deleted_bank_account' - $ref: '#/components/schemas/deleted_card' description: ID of the bank account or card the payout is sent to. nullable: true x-expansionResources: oneOf: - $ref: '#/components/schemas/bank_account' - $ref: '#/components/schemas/card' - $ref: '#/components/schemas/deleted_bank_account' - $ref: '#/components/schemas/deleted_card' x-stripeBypassValidation: true failure_balance_transaction: anyOf: - maxLength: 5000 type: string - $ref: '#/components/schemas/balance_transaction' description: >- If the payout fails or cancels, this is the ID of the balance transaction that reverses the initial balance transaction and returns the funds from the failed payout back in your balance. nullable: true x-expansionResources: oneOf: - $ref: '#/components/schemas/balance_transaction' failure_code: description: >- Error code that provides a reason for a payout failure, if available. View our [list of failure codes](https://stripe.com/docs/api#payout_failures). maxLength: 5000 nullable: true type: string failure_message: description: 'Message that provides the reason for a payout failure, if available.' maxLength: 5000 nullable: true type: string id: description: Unique identifier for the object. maxLength: 5000 type: string livemode: description: >- Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. type: boolean metadata: additionalProperties: maxLength: 500 type: string description: >- 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. nullable: true type: object method: description: >- The method used to send this payout, which can be `standard` or `instant`. `instant` is supported for payouts to debit cards and bank accounts in certain countries. Learn more about [bank support for Instant Payouts](https://stripe.com/docs/payouts/instant-payouts-banks). maxLength: 5000 type: string object: description: >- String representing the object's type. Objects of the same type share the same value. enum: - payout type: string original_payout: anyOf: - maxLength: 5000 type: string - $ref: '#/components/schemas/payout' description: >- If the payout reverses another, this is the ID of the original payout. nullable: true x-expansionResources: oneOf: - $ref: '#/components/schemas/payout' reconciliation_status: description: >- If `completed`, you can use the [Balance Transactions API](https://stripe.com/docs/api/balance_transactions/list#balance_transaction_list-payout) to list all balance transactions that are paid out in this payout. enum: - completed - in_progress - not_applicable type: string reversed_by: anyOf: - maxLength: 5000 type: string - $ref: '#/components/schemas/payout' description: >- If the payout reverses, this is the ID of the payout that reverses this payout. nullable: true x-expansionResources: oneOf: - $ref: '#/components/schemas/payout' source_type: description: >- The source balance this payout came from, which can be one of the following: `card`, `fpx`, or `bank_account`. maxLength: 5000 type: string statement_descriptor: description: >- Extra information about a payout that displays on the user's bank statement. maxLength: 5000 nullable: true type: string status: description: >- Current status of the payout: `paid`, `pending`, `in_transit`, `canceled` or `failed`. A payout is `pending` until it's submitted to the bank, when it becomes `in_transit`. The status changes to `paid` if the transaction succeeds, or to `failed` or `canceled` (within 5 business days). Some payouts that fail might initially show as `paid`, then change to `failed`. maxLength: 5000 type: string type: description: Can be `bank_account` or `card`. enum: - bank_account - card type: string x-stripeBypassValidation: true required: - amount - arrival_date - automatic - created - currency - id - livemode - method - object - reconciliation_status - source_type - status - type title: Payout type: object x-expandableFields: - balance_transaction - destination - failure_balance_transaction - original_payout - reversed_by x-resourceId: payout paypal_seller_protection: description: '' properties: dispute_categories: description: >- An array of conditions that are covered for the transaction, if applicable. items: enum: - fraudulent - product_not_received type: string x-stripeBypassValidation: true nullable: true type: array status: description: >- Indicates whether the transaction is eligible for PayPal's seller protection. enum: - eligible - not_eligible - partially_eligible type: string required: - status title: paypal_seller_protection type: object x-expandableFields: [] period: description: '' properties: end: description: >- The end date of this usage period. All usage up to and including this point in time is included. format: unix-time nullable: true type: integer start: description: >- The start date of this usage period. All usage after this point in time is included. format: unix-time nullable: true type: integer title: Period type: object x-expandableFields: [] person: description: >- This is an object representing a person associated with a Stripe account. A platform cannot access a Standard or Express account's persons after the account starts onboarding, such as after generating an account link for the account. See the [Standard onboarding](https://stripe.com/docs/connect/standard-accounts) or [Express onboarding documentation](https://stripe.com/docs/connect/express-accounts) for information about platform prefilling and account onboarding steps. Related guide: [Handling identity verification with the API](https://stripe.com/docs/connect/handling-api-verification#person-information) properties: account: description: The account the person is associated with. maxLength: 5000 type: string additional_tos_acceptances: $ref: '#/components/schemas/person_additional_tos_acceptances' address: $ref: '#/components/schemas/address' address_kana: anyOf: - $ref: '#/components/schemas/legal_entity_japan_address' nullable: true address_kanji: anyOf: - $ref: '#/components/schemas/legal_entity_japan_address' nullable: true created: description: >- Time at which the object was created. Measured in seconds since the Unix epoch. format: unix-time type: integer dob: $ref: '#/components/schemas/legal_entity_dob' email: description: The person's email address. maxLength: 5000 nullable: true type: string first_name: description: The person's first name. maxLength: 5000 nullable: true type: string first_name_kana: description: The Kana variation of the person's first name (Japan only). maxLength: 5000 nullable: true type: string first_name_kanji: description: The Kanji variation of the person's first name (Japan only). maxLength: 5000 nullable: true type: string full_name_aliases: description: A list of alternate names or aliases that the person is known by. items: maxLength: 5000 type: string type: array future_requirements: anyOf: - $ref: '#/components/schemas/person_future_requirements' nullable: true gender: description: >- The person's gender (International regulations require either "male" or "female"). nullable: true type: string id: description: Unique identifier for the object. maxLength: 5000 type: string id_number_provided: description: >- 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`). type: boolean id_number_secondary_provided: description: Whether the person's `id_number_secondary` was provided. type: boolean last_name: description: The person's last name. maxLength: 5000 nullable: true type: string last_name_kana: description: The Kana variation of the person's last name (Japan only). maxLength: 5000 nullable: true type: string last_name_kanji: description: The Kanji variation of the person's last name (Japan only). maxLength: 5000 nullable: true type: string maiden_name: description: The person's maiden name. maxLength: 5000 nullable: true type: string metadata: additionalProperties: maxLength: 500 type: string description: >- 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. type: object nationality: description: The country where the person is a national. maxLength: 5000 nullable: true type: string object: description: >- String representing the object's type. Objects of the same type share the same value. enum: - person type: string phone: description: The person's phone number. maxLength: 5000 nullable: true type: string political_exposure: description: >- 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. enum: - existing - none type: string registered_address: $ref: '#/components/schemas/address' relationship: $ref: '#/components/schemas/person_relationship' requirements: anyOf: - $ref: '#/components/schemas/person_requirements' nullable: true ssn_last_4_provided: description: >- Whether the last four digits of the person's Social Security number have been provided (U.S. only). type: boolean verification: $ref: '#/components/schemas/legal_entity_person_verification' required: - account - created - id - object title: Person type: object x-expandableFields: - additional_tos_acceptances - address - address_kana - address_kanji - dob - future_requirements - registered_address - relationship - requirements - verification x-resourceId: person person_additional_tos_acceptance: description: '' properties: date: description: >- The Unix timestamp marking when the legal guardian accepted the service agreement. format: unix-time nullable: true type: integer ip: description: >- The IP address from which the legal guardian accepted the service agreement. maxLength: 5000 nullable: true type: string user_agent: description: >- The user agent of the browser from which the legal guardian accepted the service agreement. maxLength: 5000 nullable: true type: string title: PersonAdditionalTOSAcceptance type: object x-expandableFields: [] person_additional_tos_acceptances: description: '' properties: account: $ref: '#/components/schemas/person_additional_tos_acceptance' required: - account title: PersonAdditionalTOSAcceptances type: object x-expandableFields: - account person_future_requirements: description: '' properties: alternatives: description: >- Fields that are due and can be satisfied by providing the corresponding alternative fields instead. items: $ref: '#/components/schemas/account_requirements_alternative' nullable: true type: array currently_due: description: >- 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. items: maxLength: 5000 type: string type: array errors: description: >- Fields that are `currently_due` and need to be collected again because validation or verification failed. items: $ref: '#/components/schemas/account_requirements_error' type: array eventually_due: description: >- Fields that need to be collected assuming all volume thresholds are reached. As they become required, they appear in `currently_due` as well, and the account's `future_requirements[current_deadline]` becomes set. items: maxLength: 5000 type: string type: array past_due: description: >- 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`. items: maxLength: 5000 type: string type: array pending_verification: description: >- 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. items: maxLength: 5000 type: string type: array required: - currently_due - errors - eventually_due - past_due - pending_verification title: PersonFutureRequirements type: object x-expandableFields: - alternatives - errors person_relationship: description: '' properties: director: description: >- 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. nullable: true type: boolean executive: description: >- Whether the person has significant responsibility to control, manage, or direct the organization. nullable: true type: boolean legal_guardian: description: >- Whether the person is the legal guardian of the account's representative. nullable: true type: boolean owner: description: Whether the person is an owner of the account’s legal entity. nullable: true type: boolean percent_ownership: description: The percent owned by the person of the account's legal entity. nullable: true type: number representative: description: >- 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. nullable: true type: boolean title: description: 'The person''s title (e.g., CEO, Support Engineer).' maxLength: 5000 nullable: true type: string title: PersonRelationship type: object x-expandableFields: [] person_requirements: description: '' properties: alternatives: description: >- Fields that are due and can be satisfied by providing the corresponding alternative fields instead. items: $ref: '#/components/schemas/account_requirements_alternative' nullable: true type: array currently_due: description: >- 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. items: maxLength: 5000 type: string type: array errors: description: >- Fields that are `currently_due` and need to be collected again because validation or verification failed. items: $ref: '#/components/schemas/account_requirements_error' type: array eventually_due: description: >- Fields that need to be collected assuming all volume thresholds are reached. As they become required, they appear in `currently_due` as well, and the account's `current_deadline` becomes set. items: maxLength: 5000 type: string type: array past_due: description: >- Fields that weren't collected by the account's `current_deadline`. These fields need to be collected to enable the person's account. items: maxLength: 5000 type: string type: array pending_verification: description: >- 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. items: maxLength: 5000 type: string type: array required: - currently_due - errors - eventually_due - past_due - pending_verification title: PersonRequirements type: object x-expandableFields: - alternatives - errors plan: description: >- You can now model subscriptions more flexibly using the [Prices API](https://stripe.com/docs/api#prices). It replaces the Plans API and is backwards compatible to simplify your migration. Plans define the base price, currency, and billing cycle for recurring purchases of products. [Products](https://stripe.com/docs/api#products) help you track inventory or provisioning, and plans help you track pricing. Different physical goods or levels of service should be represented by products, and pricing options should be represented by plans. This approach lets you change prices without having to change your provisioning scheme. For example, you might have a single "gold" product that has plans for $10/month, $100/year, €9/month, and €90/year. Related guides: [Set up a subscription](https://stripe.com/docs/billing/subscriptions/set-up-subscription) and more about [products and prices](https://stripe.com/docs/products-prices/overview). properties: active: description: Whether the plan can be used for new purchases. type: boolean aggregate_usage: description: >- Specifies a usage aggregation strategy for plans of `usage_type=metered`. Allowed values are `sum` for summing up all usage during a period, `last_during_period` for using the last usage record reported within a period, `last_ever` for using the last usage record ever (across period bounds) or `max` which uses the usage record with the maximum reported usage during a period. Defaults to `sum`. enum: - last_during_period - last_ever - max - sum nullable: true type: string amount: description: >- The unit amount in cents (or local equivalent) to be charged, represented as a whole integer if possible. Only set if `billing_scheme=per_unit`. nullable: true type: integer amount_decimal: description: >- The unit amount in cents (or local equivalent) to be charged, represented as a decimal string with at most 12 decimal places. Only set if `billing_scheme=per_unit`. format: decimal nullable: true type: string billing_scheme: description: >- Describes how to compute the price per period. Either `per_unit` or `tiered`. `per_unit` indicates that the fixed amount (specified in `amount`) will be charged per unit in `quantity` (for plans with `usage_type=licensed`), or per unit of total usage (for plans with `usage_type=metered`). `tiered` indicates that the unit pricing will be computed using a tiering strategy as defined using the `tiers` and `tiers_mode` attributes. enum: - per_unit - tiered type: string created: description: >- Time at which the object was created. Measured in seconds since the Unix epoch. format: unix-time type: integer currency: description: >- 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). type: string id: description: Unique identifier for the object. maxLength: 5000 type: string interval: description: >- The frequency at which a subscription is billed. One of `day`, `week`, `month` or `year`. enum: - day - month - week - year type: string interval_count: description: >- The number of intervals (specified in the `interval` attribute) between subscription billings. For example, `interval=month` and `interval_count=3` bills every 3 months. type: integer livemode: description: >- Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. type: boolean metadata: additionalProperties: maxLength: 500 type: string description: >- 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. nullable: true type: object meter: description: The meter tracking the usage of a metered price maxLength: 5000 nullable: true type: string nickname: description: 'A brief description of the plan, hidden from customers.' maxLength: 5000 nullable: true type: string object: description: >- String representing the object's type. Objects of the same type share the same value. enum: - plan type: string product: anyOf: - maxLength: 5000 type: string - $ref: '#/components/schemas/product' - $ref: '#/components/schemas/deleted_product' description: The product whose pricing this plan determines. nullable: true x-expansionResources: oneOf: - $ref: '#/components/schemas/product' - $ref: '#/components/schemas/deleted_product' tiers: description: >- Each element represents a pricing tier. This parameter requires `billing_scheme` to be set to `tiered`. See also the documentation for `billing_scheme`. items: $ref: '#/components/schemas/plan_tier' type: array tiers_mode: description: >- Defines if the tiering price should be `graduated` or `volume` based. In `volume`-based tiering, the maximum quantity within a period determines the per unit price. In `graduated` tiering, pricing can change as the quantity grows. enum: - graduated - volume nullable: true type: string transform_usage: anyOf: - $ref: '#/components/schemas/transform_usage' description: >- Apply a transformation to the reported usage or set quantity before computing the amount billed. Cannot be combined with `tiers`. nullable: true trial_period_days: description: >- Default number of trial days when subscribing a customer to this plan using [`trial_from_plan=true`](https://stripe.com/docs/api#create_subscription-trial_from_plan). nullable: true type: integer usage_type: description: >- Configures how the quantity per period should be determined. Can be either `metered` or `licensed`. `licensed` automatically bills the `quantity` set when adding it to a subscription. `metered` aggregates the total usage based on usage records. Defaults to `licensed`. enum: - licensed - metered type: string required: - active - billing_scheme - created - currency - id - interval - interval_count - livemode - object - usage_type title: Plan type: object x-expandableFields: - product - tiers - transform_usage x-resourceId: plan plan_tier: description: '' properties: flat_amount: description: Price for the entire tier. nullable: true type: integer flat_amount_decimal: description: >- Same as `flat_amount`, but contains a decimal value with at most 12 decimal places. format: decimal nullable: true type: string unit_amount: description: Per unit price for units relevant to the tier. nullable: true type: integer unit_amount_decimal: description: >- Same as `unit_amount`, but contains a decimal value with at most 12 decimal places. format: decimal nullable: true type: string up_to: description: Up to and including to this quantity will be contained in the tier. nullable: true type: integer title: PlanTier type: object x-expandableFields: [] platform_tax_fee: description: '' properties: account: description: The Connected account that incurred this charge. maxLength: 5000 type: string id: description: Unique identifier for the object. maxLength: 5000 type: string object: description: >- String representing the object's type. Objects of the same type share the same value. enum: - platform_tax_fee type: string source_transaction: description: The payment object that caused this tax to be inflicted. maxLength: 5000 type: string type: description: The type of tax (VAT). maxLength: 5000 type: string required: - account - id - object - source_transaction - type title: PlatformTax type: object x-expandableFields: [] portal_business_profile: description: '' properties: headline: description: The messaging shown to customers in the portal. maxLength: 5000 nullable: true type: string privacy_policy_url: description: A link to the business’s publicly available privacy policy. maxLength: 5000 nullable: true type: string terms_of_service_url: description: A link to the business’s publicly available terms of service. maxLength: 5000 nullable: true type: string title: PortalBusinessProfile type: object x-expandableFields: [] portal_customer_update: description: '' properties: allowed_updates: description: >- The types of customer updates that are supported. When empty, customers are not updateable. items: enum: - address - email - name - phone - shipping - tax_id type: string type: array enabled: description: Whether the feature is enabled. type: boolean required: - allowed_updates - enabled title: PortalCustomerUpdate type: object x-expandableFields: [] portal_features: description: '' properties: customer_update: $ref: '#/components/schemas/portal_customer_update' invoice_history: $ref: '#/components/schemas/portal_invoice_list' payment_method_update: $ref: '#/components/schemas/portal_payment_method_update' subscription_cancel: $ref: '#/components/schemas/portal_subscription_cancel' subscription_update: $ref: '#/components/schemas/portal_subscription_update' required: - customer_update - invoice_history - payment_method_update - subscription_cancel - subscription_update title: PortalFeatures type: object x-expandableFields: - customer_update - invoice_history - payment_method_update - subscription_cancel - subscription_update portal_flows_after_completion_hosted_confirmation: description: '' properties: custom_message: description: >- A custom message to display to the customer after the flow is completed. maxLength: 5000 nullable: true type: string title: PortalFlowsAfterCompletionHostedConfirmation type: object x-expandableFields: [] portal_flows_after_completion_redirect: description: '' properties: return_url: description: >- The URL the customer will be redirected to after the flow is completed. maxLength: 5000 type: string required: - return_url title: PortalFlowsAfterCompletionRedirect type: object x-expandableFields: [] portal_flows_coupon_offer: description: '' properties: coupon: description: The ID of the coupon to be offered. maxLength: 5000 type: string required: - coupon title: PortalFlowsCouponOffer type: object x-expandableFields: [] portal_flows_flow: description: '' properties: after_completion: $ref: '#/components/schemas/portal_flows_flow_after_completion' subscription_cancel: anyOf: - $ref: '#/components/schemas/portal_flows_flow_subscription_cancel' description: Configuration when `flow.type=subscription_cancel`. nullable: true subscription_update: anyOf: - $ref: '#/components/schemas/portal_flows_flow_subscription_update' description: Configuration when `flow.type=subscription_update`. nullable: true subscription_update_confirm: anyOf: - $ref: >- #/components/schemas/portal_flows_flow_subscription_update_confirm description: Configuration when `flow.type=subscription_update_confirm`. nullable: true type: description: Type of flow that the customer will go through. enum: - payment_method_update - subscription_cancel - subscription_update - subscription_update_confirm type: string required: - after_completion - type title: PortalFlowsFlow type: object x-expandableFields: - after_completion - subscription_cancel - subscription_update - subscription_update_confirm portal_flows_flow_after_completion: description: '' properties: hosted_confirmation: anyOf: - $ref: >- #/components/schemas/portal_flows_after_completion_hosted_confirmation description: Configuration when `after_completion.type=hosted_confirmation`. nullable: true redirect: anyOf: - $ref: '#/components/schemas/portal_flows_after_completion_redirect' description: Configuration when `after_completion.type=redirect`. nullable: true type: description: The specified type of behavior after the flow is completed. enum: - hosted_confirmation - portal_homepage - redirect type: string required: - type title: PortalFlowsFlowAfterCompletion type: object x-expandableFields: - hosted_confirmation - redirect portal_flows_flow_subscription_cancel: description: '' properties: retention: anyOf: - $ref: '#/components/schemas/portal_flows_retention' description: Specify a retention strategy to be used in the cancellation flow. nullable: true subscription: description: The ID of the subscription to be canceled. maxLength: 5000 type: string required: - subscription title: PortalFlowsFlowSubscriptionCancel type: object x-expandableFields: - retention portal_flows_flow_subscription_update: description: '' properties: subscription: description: The ID of the subscription to be updated. maxLength: 5000 type: string required: - subscription title: PortalFlowsFlowSubscriptionUpdate type: object x-expandableFields: [] portal_flows_flow_subscription_update_confirm: description: '' properties: discounts: description: >- The coupon or promotion code to apply to this subscription update. Currently, only up to one may be specified. items: $ref: >- #/components/schemas/portal_flows_subscription_update_confirm_discount nullable: true type: array items: description: >- The [subscription item](https://stripe.com/docs/api/subscription_items) to be updated through this flow. Currently, only up to one may be specified and subscriptions with multiple items are not updatable. items: $ref: '#/components/schemas/portal_flows_subscription_update_confirm_item' type: array subscription: description: The ID of the subscription to be updated. maxLength: 5000 type: string required: - items - subscription title: PortalFlowsFlowSubscriptionUpdateConfirm type: object x-expandableFields: - discounts - items portal_flows_retention: description: '' properties: coupon_offer: anyOf: - $ref: '#/components/schemas/portal_flows_coupon_offer' description: Configuration when `retention.type=coupon_offer`. nullable: true type: description: Type of retention strategy that will be used. enum: - coupon_offer type: string required: - type title: PortalFlowsRetention type: object x-expandableFields: - coupon_offer portal_flows_subscription_update_confirm_discount: description: '' properties: coupon: description: The ID of the coupon to apply to this subscription update. maxLength: 5000 nullable: true type: string promotion_code: description: The ID of a promotion code to apply to this subscription update. maxLength: 5000 nullable: true type: string title: PortalFlowsSubscriptionUpdateConfirmDiscount type: object x-expandableFields: [] portal_flows_subscription_update_confirm_item: description: '' properties: id: description: >- The ID of the [subscription item](https://stripe.com/docs/api/subscriptions/object#subscription_object-items-data-id) to be updated. maxLength: 5000 nullable: true type: string price: description: >- The price the customer should subscribe to through this flow. The price must also be included in the configuration's [`features.subscription_update.products`](https://stripe.com/docs/api/customer_portal/configuration#portal_configuration_object-features-subscription_update-products). maxLength: 5000 nullable: true type: string quantity: description: >- [Quantity](https://stripe.com/docs/subscriptions/quantities) for this item that the customer should subscribe to through this flow. type: integer title: PortalFlowsSubscriptionUpdateConfirmItem type: object x-expandableFields: [] portal_invoice_list: description: '' properties: enabled: description: Whether the feature is enabled. type: boolean required: - enabled title: PortalInvoiceList type: object x-expandableFields: [] portal_login_page: description: '' properties: enabled: description: >- If `true`, a shareable `url` will be generated that will take your customers to a hosted login page for the customer portal. If `false`, the previously generated `url`, if any, will be deactivated. type: boolean url: description: >- A shareable URL to the hosted portal login page. Your customers will be able to log in with their [email](https://stripe.com/docs/api/customers/object#customer_object-email) and receive a link to their customer portal. maxLength: 5000 nullable: true type: string required: - enabled title: PortalLoginPage type: object x-expandableFields: [] portal_payment_method_update: description: '' properties: enabled: description: Whether the feature is enabled. type: boolean required: - enabled title: PortalPaymentMethodUpdate type: object x-expandableFields: [] portal_subscription_cancel: description: '' properties: cancellation_reason: $ref: '#/components/schemas/portal_subscription_cancellation_reason' enabled: description: Whether the feature is enabled. type: boolean mode: description: >- Whether to cancel subscriptions immediately or at the end of the billing period. enum: - at_period_end - immediately type: string proration_behavior: description: >- Whether to create prorations when canceling subscriptions. Possible values are `none` and `create_prorations`. enum: - always_invoice - create_prorations - none type: string required: - cancellation_reason - enabled - mode - proration_behavior title: PortalSubscriptionCancel type: object x-expandableFields: - cancellation_reason portal_subscription_cancellation_reason: description: '' properties: enabled: description: Whether the feature is enabled. type: boolean options: description: Which cancellation reasons will be given as options to the customer. items: enum: - customer_service - low_quality - missing_features - other - switched_service - too_complex - too_expensive - unused type: string type: array required: - enabled - options title: PortalSubscriptionCancellationReason type: object x-expandableFields: [] portal_subscription_update: description: '' properties: default_allowed_updates: description: >- The types of subscription updates that are supported for items listed in the `products` attribute. When empty, subscriptions are not updateable. items: enum: - price - promotion_code - quantity type: string type: array enabled: description: Whether the feature is enabled. type: boolean products: description: The list of up to 10 products that support subscription updates. items: $ref: '#/components/schemas/portal_subscription_update_product' nullable: true type: array proration_behavior: description: >- Determines how to handle prorations resulting from subscription updates. Valid values are `none`, `create_prorations`, and `always_invoice`. Defaults to a value of `none` if you don't set it during creation. enum: - always_invoice - create_prorations - none type: string required: - default_allowed_updates - enabled - proration_behavior title: PortalSubscriptionUpdate type: object x-expandableFields: - products portal_subscription_update_product: description: '' properties: prices: description: >- The list of price IDs which, when subscribed to, a subscription can be updated. items: maxLength: 5000 type: string type: array product: description: The product ID. maxLength: 5000 type: string required: - prices - product title: PortalSubscriptionUpdateProduct type: object x-expandableFields: [] price: description: >- Prices define the unit cost, currency, and (optional) billing cycle for both recurring and one-time purchases of products. [Products](https://stripe.com/docs/api#products) help you track inventory or provisioning, and prices help you track payment terms. Different physical goods or levels of service should be represented by products, and pricing options should be represented by prices. This approach lets you change prices without having to change your provisioning scheme. For example, you might have a single "gold" product that has prices for $10/month, $100/year, and €9 once. Related guides: [Set up a subscription](https://stripe.com/docs/billing/subscriptions/set-up-subscription), [create an invoice](https://stripe.com/docs/billing/invoices/create), and more about [products and prices](https://stripe.com/docs/products-prices/overview). properties: active: description: Whether the price can be used for new purchases. type: boolean billing_scheme: description: >- Describes how to compute the price per period. Either `per_unit` or `tiered`. `per_unit` indicates that the fixed amount (specified in `unit_amount` or `unit_amount_decimal`) will be charged per unit in `quantity` (for prices with `usage_type=licensed`), or per unit of total usage (for prices with `usage_type=metered`). `tiered` indicates that the unit pricing will be computed using a tiering strategy as defined using the `tiers` and `tiers_mode` attributes. enum: - per_unit - tiered type: string created: description: >- Time at which the object was created. Measured in seconds since the Unix epoch. format: unix-time type: integer currency: description: >- 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). type: string currency_options: additionalProperties: $ref: '#/components/schemas/currency_option' description: >- Prices defined in each available currency option. Each key must be a three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html) and a [supported currency](https://stripe.com/docs/currencies). type: object custom_unit_amount: anyOf: - $ref: '#/components/schemas/custom_unit_amount' description: >- When set, provides configuration for the amount to be adjusted by the customer during Checkout Sessions and Payment Links. nullable: true id: description: Unique identifier for the object. maxLength: 5000 type: string livemode: description: >- Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. type: boolean lookup_key: description: >- A lookup key used to retrieve prices dynamically from a static string. This may be up to 200 characters. maxLength: 5000 nullable: true type: string metadata: additionalProperties: maxLength: 500 type: string description: >- 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. type: object nickname: description: 'A brief description of the price, hidden from customers.' maxLength: 5000 nullable: true type: string object: description: >- String representing the object's type. Objects of the same type share the same value. enum: - price type: string product: anyOf: - maxLength: 5000 type: string - $ref: '#/components/schemas/product' - $ref: '#/components/schemas/deleted_product' description: The ID of the product this price is associated with. x-expansionResources: oneOf: - $ref: '#/components/schemas/product' - $ref: '#/components/schemas/deleted_product' recurring: anyOf: - $ref: '#/components/schemas/recurring' description: >- The recurring components of a price such as `interval` and `usage_type`. nullable: true tax_behavior: description: >- Only required if a [default tax behavior](https://stripe.com/docs/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)) was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. Once specified as either `inclusive` or `exclusive`, it cannot be changed. enum: - exclusive - inclusive - unspecified nullable: true type: string tiers: description: >- Each element represents a pricing tier. This parameter requires `billing_scheme` to be set to `tiered`. See also the documentation for `billing_scheme`. items: $ref: '#/components/schemas/price_tier' type: array tiers_mode: description: >- Defines if the tiering price should be `graduated` or `volume` based. In `volume`-based tiering, the maximum quantity within a period determines the per unit price. In `graduated` tiering, pricing can change as the quantity grows. enum: - graduated - volume nullable: true type: string transform_quantity: anyOf: - $ref: '#/components/schemas/transform_quantity' description: >- Apply a transformation to the reported usage or set quantity before computing the amount billed. Cannot be combined with `tiers`. nullable: true type: description: >- One of `one_time` or `recurring` depending on whether the price is for a one-time purchase or a recurring (subscription) purchase. enum: - one_time - recurring type: string unit_amount: description: >- The unit amount in cents (or local equivalent) to be charged, represented as a whole integer if possible. Only set if `billing_scheme=per_unit`. nullable: true type: integer unit_amount_decimal: description: >- The unit amount in cents (or local equivalent) to be charged, represented as a decimal string with at most 12 decimal places. Only set if `billing_scheme=per_unit`. format: decimal nullable: true type: string required: - active - billing_scheme - created - currency - id - livemode - metadata - object - product - type title: Price type: object x-expandableFields: - currency_options - custom_unit_amount - product - recurring - tiers - transform_quantity x-resourceId: price price_tier: description: '' properties: flat_amount: description: Price for the entire tier. nullable: true type: integer flat_amount_decimal: description: >- Same as `flat_amount`, but contains a decimal value with at most 12 decimal places. format: decimal nullable: true type: string unit_amount: description: Per unit price for units relevant to the tier. nullable: true type: integer unit_amount_decimal: description: >- Same as `unit_amount`, but contains a decimal value with at most 12 decimal places. format: decimal nullable: true type: string up_to: description: Up to and including to this quantity will be contained in the tier. nullable: true type: integer title: PriceTier type: object x-expandableFields: [] product: description: >- Products describe the specific goods or services you offer to your customers. For example, you might offer a Standard and Premium version of your goods or service; each version would be a separate Product. They can be used in conjunction with [Prices](https://stripe.com/docs/api#prices) to configure pricing in Payment Links, Checkout, and Subscriptions. Related guides: [Set up a subscription](https://stripe.com/docs/billing/subscriptions/set-up-subscription), [share a Payment Link](https://stripe.com/docs/payment-links), [accept payments with Checkout](https://stripe.com/docs/payments/accept-a-payment#create-product-prices-upfront), and more about [Products and Prices](https://stripe.com/docs/products-prices/overview) properties: active: description: Whether the product is currently available for purchase. type: boolean created: description: >- Time at which the object was created. Measured in seconds since the Unix epoch. format: unix-time type: integer default_price: anyOf: - maxLength: 5000 type: string - $ref: '#/components/schemas/price' description: >- The ID of the [Price](https://stripe.com/docs/api/prices) object that is the default price for this product. nullable: true x-expansionResources: oneOf: - $ref: '#/components/schemas/price' description: description: >- The product's description, meant to be displayable to the customer. Use this field to optionally store a long form explanation of the product being sold for your own rendering purposes. maxLength: 5000 nullable: true type: string id: description: Unique identifier for the object. maxLength: 5000 type: string images: description: >- A list of up to 8 URLs of images for this product, meant to be displayable to the customer. items: maxLength: 5000 type: string type: array livemode: description: >- Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. type: boolean marketing_features: description: >- A list of up to 15 marketing features for this product. These are displayed in [pricing tables](https://stripe.com/docs/payments/checkout/pricing-table). items: $ref: '#/components/schemas/product_marketing_feature' type: array metadata: additionalProperties: maxLength: 500 type: string description: >- 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. type: object name: description: 'The product''s name, meant to be displayable to the customer.' maxLength: 5000 type: string object: description: >- String representing the object's type. Objects of the same type share the same value. enum: - product type: string package_dimensions: anyOf: - $ref: '#/components/schemas/package_dimensions' description: The dimensions of this product for shipping purposes. nullable: true shippable: description: 'Whether this product is shipped (i.e., physical goods).' nullable: true type: boolean statement_descriptor: description: >- Extra information about a product which will appear on your customer's credit card statement. In the case that multiple products are billed at once, the first statement descriptor will be used. maxLength: 5000 nullable: true type: string tax_code: anyOf: - maxLength: 5000 type: string - $ref: '#/components/schemas/tax_code' description: 'A [tax code](https://stripe.com/docs/tax/tax-categories) ID.' nullable: true x-expansionResources: oneOf: - $ref: '#/components/schemas/tax_code' unit_label: description: >- A label that represents units of this product. When set, this will be included in customers' receipts, invoices, Checkout, and the customer portal. maxLength: 5000 nullable: true type: string updated: description: >- Time at which the object was last updated. Measured in seconds since the Unix epoch. format: unix-time type: integer url: description: A URL of a publicly-accessible webpage for this product. maxLength: 2048 nullable: true type: string required: - active - created - id - images - livemode - marketing_features - metadata - name - object - updated title: Product type: object x-expandableFields: - default_price - marketing_features - package_dimensions - tax_code x-resourceId: product product_feature: description: >- A product_feature represents an attachment between a feature and a product. When a product is purchased that has a feature attached, Stripe will create an entitlement to the feature for the purchasing customer. properties: entitlement_feature: $ref: '#/components/schemas/entitlements.feature' id: description: Unique identifier for the object. maxLength: 5000 type: string livemode: description: >- Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. type: boolean object: description: >- String representing the object's type. Objects of the same type share the same value. enum: - product_feature type: string required: - entitlement_feature - id - livemode - object title: ProductFeature type: object x-expandableFields: - entitlement_feature x-resourceId: product_feature product_marketing_feature: description: '' properties: name: description: The marketing feature name. Up to 80 characters long. maxLength: 5000 type: string title: ProductMarketingFeature type: object x-expandableFields: [] promotion_code: description: >- 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. properties: active: description: >- Whether the promotion code is currently active. A promotion code is only active if the coupon is also valid. type: boolean code: description: >- The customer-facing code. Regardless of case, this code must be unique across all active promotion codes for each customer. maxLength: 5000 type: string coupon: $ref: '#/components/schemas/coupon' created: description: >- Time at which the object was created. Measured in seconds since the Unix epoch. format: unix-time type: integer customer: anyOf: - maxLength: 5000 type: string - $ref: '#/components/schemas/customer' - $ref: '#/components/schemas/deleted_customer' description: The customer that this promotion code can be used by. nullable: true x-expansionResources: oneOf: - $ref: '#/components/schemas/customer' - $ref: '#/components/schemas/deleted_customer' expires_at: description: Date at which the promotion code can no longer be redeemed. format: unix-time nullable: true type: integer id: description: Unique identifier for the object. maxLength: 5000 type: string livemode: description: >- Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. type: boolean max_redemptions: description: Maximum number of times this promotion code can be redeemed. nullable: true type: integer metadata: additionalProperties: maxLength: 500 type: string description: >- 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. nullable: true type: object object: description: >- String representing the object's type. Objects of the same type share the same value. enum: - promotion_code type: string restrictions: $ref: '#/components/schemas/promotion_codes_resource_restrictions' times_redeemed: description: Number of times this promotion code has been used. type: integer required: - active - code - coupon - created - id - livemode - object - restrictions - times_redeemed title: PromotionCode type: object x-expandableFields: - coupon - customer - restrictions x-resourceId: promotion_code promotion_code_currency_option: description: '' properties: minimum_amount: description: >- Minimum amount required to redeem this Promotion Code into a Coupon (e.g., a purchase must be $100 or more to work). type: integer required: - minimum_amount title: PromotionCodeCurrencyOption type: object x-expandableFields: [] promotion_codes_resource_restrictions: description: '' properties: currency_options: additionalProperties: $ref: '#/components/schemas/promotion_code_currency_option' description: >- Promotion code restrictions 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). type: object first_time_transaction: description: >- A Boolean indicating if the Promotion Code should only be redeemed for Customers without any successful payments or invoices type: boolean minimum_amount: description: >- Minimum amount required to redeem this Promotion Code into a Coupon (e.g., a purchase must be $100 or more to work). nullable: true type: integer minimum_amount_currency: description: >- Three-letter [ISO code](https://stripe.com/docs/currencies) for minimum_amount maxLength: 5000 nullable: true type: string required: - first_time_transaction title: PromotionCodesResourceRestrictions type: object x-expandableFields: - currency_options quote: description: >- A Quote is a way to model prices that you'd like to provide to a customer. Once accepted, it will automatically create an invoice, subscription or subscription schedule. properties: amount_subtotal: description: Total before any discounts or taxes are applied. type: integer amount_total: description: Total after discounts and taxes are applied. type: integer application: anyOf: - maxLength: 5000 type: string - $ref: '#/components/schemas/application' - $ref: '#/components/schemas/deleted_application' description: ID of the Connect Application that created the quote. nullable: true x-expansionResources: oneOf: - $ref: '#/components/schemas/application' - $ref: '#/components/schemas/deleted_application' application_fee_amount: description: >- 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. Only applicable if there are no line items with recurring prices on the quote. nullable: true type: integer application_fee_percent: description: >- 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. Only applicable if there are line items with recurring prices on the quote. nullable: true type: number automatic_tax: $ref: '#/components/schemas/quotes_resource_automatic_tax' collection_method: description: >- Either `charge_automatically`, or `send_invoice`. When charging automatically, Stripe will attempt to pay invoices at the end of the subscription cycle or on finalization using the default payment method attached to the subscription or customer. When sending an invoice, Stripe will email your customer an invoice with payment instructions and mark the subscription as `active`. Defaults to `charge_automatically`. enum: - charge_automatically - send_invoice type: string computed: $ref: '#/components/schemas/quotes_resource_computed' created: description: >- Time at which the object was created. Measured in seconds since the Unix epoch. format: unix-time type: integer currency: description: >- 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). maxLength: 5000 nullable: true type: string customer: anyOf: - maxLength: 5000 type: string - $ref: '#/components/schemas/customer' - $ref: '#/components/schemas/deleted_customer' description: >- The customer which this quote belongs to. A customer is required before finalizing the quote. Once specified, it cannot be changed. nullable: true x-expansionResources: oneOf: - $ref: '#/components/schemas/customer' - $ref: '#/components/schemas/deleted_customer' default_tax_rates: description: The tax rates applied to this quote. items: anyOf: - maxLength: 5000 type: string - $ref: '#/components/schemas/tax_rate' x-expansionResources: oneOf: - $ref: '#/components/schemas/tax_rate' type: array description: description: A description that will be displayed on the quote PDF. maxLength: 5000 nullable: true type: string discounts: description: The discounts applied to this quote. items: anyOf: - maxLength: 5000 type: string - $ref: '#/components/schemas/discount' x-expansionResources: oneOf: - $ref: '#/components/schemas/discount' type: array expires_at: description: >- The date on which the quote will be canceled if in `open` or `draft` status. Measured in seconds since the Unix epoch. format: unix-time type: integer footer: description: A footer that will be displayed on the quote PDF. maxLength: 5000 nullable: true type: string from_quote: anyOf: - $ref: '#/components/schemas/quotes_resource_from_quote' description: >- Details of the quote that was cloned. See the [cloning documentation](https://stripe.com/docs/quotes/clone) for more details. nullable: true header: description: A header that will be displayed on the quote PDF. maxLength: 5000 nullable: true type: string id: description: Unique identifier for the object. maxLength: 5000 type: string invoice: anyOf: - maxLength: 5000 type: string - $ref: '#/components/schemas/invoice' - $ref: '#/components/schemas/deleted_invoice' description: The invoice that was created from this quote. nullable: true x-expansionResources: oneOf: - $ref: '#/components/schemas/invoice' - $ref: '#/components/schemas/deleted_invoice' invoice_settings: $ref: '#/components/schemas/invoice_setting_quote_setting' line_items: description: A list of items the customer is being quoted for. properties: data: description: Details about each object. items: $ref: '#/components/schemas/item' type: array has_more: description: >- True if this list has another page of items after this one that can be fetched. type: boolean object: description: >- String representing the object's type. Objects of the same type share the same value. Always has the value `list`. enum: - list type: string url: description: The URL where this list can be accessed. maxLength: 5000 type: string required: - data - has_more - object - url title: QuotesResourceListLineItems type: object x-expandableFields: - data livemode: description: >- Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. type: boolean metadata: additionalProperties: maxLength: 500 type: string description: >- 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. type: object number: description: >- A unique number that identifies this particular quote. This number is assigned once the quote is [finalized](https://stripe.com/docs/quotes/overview#finalize). maxLength: 5000 nullable: true type: string object: description: >- String representing the object's type. Objects of the same type share the same value. enum: - quote type: string on_behalf_of: anyOf: - maxLength: 5000 type: string - $ref: '#/components/schemas/account' description: >- The account on behalf of which to charge. See the [Connect documentation](https://support.stripe.com/questions/sending-invoices-on-behalf-of-connected-accounts) for details. nullable: true x-expansionResources: oneOf: - $ref: '#/components/schemas/account' status: description: The status of the quote. enum: - accepted - canceled - draft - open type: string x-stripeBypassValidation: true status_transitions: $ref: '#/components/schemas/quotes_resource_status_transitions' subscription: anyOf: - maxLength: 5000 type: string - $ref: '#/components/schemas/subscription' description: The subscription that was created or updated from this quote. nullable: true x-expansionResources: oneOf: - $ref: '#/components/schemas/subscription' subscription_data: $ref: >- #/components/schemas/quotes_resource_subscription_data_subscription_data subscription_schedule: anyOf: - maxLength: 5000 type: string - $ref: '#/components/schemas/subscription_schedule' description: >- The subscription schedule that was created or updated from this quote. nullable: true x-expansionResources: oneOf: - $ref: '#/components/schemas/subscription_schedule' test_clock: anyOf: - maxLength: 5000 type: string - $ref: '#/components/schemas/test_helpers.test_clock' description: ID of the test clock this quote belongs to. nullable: true x-expansionResources: oneOf: - $ref: '#/components/schemas/test_helpers.test_clock' total_details: $ref: '#/components/schemas/quotes_resource_total_details' transfer_data: anyOf: - $ref: '#/components/schemas/quotes_resource_transfer_data' description: >- The account (if any) the payments will be attributed to for tax reporting, and where funds from each payment will be transferred to for each of the invoices. nullable: true required: - amount_subtotal - amount_total - automatic_tax - collection_method - computed - created - discounts - expires_at - id - invoice_settings - livemode - metadata - object - status - status_transitions - subscription_data - total_details title: Quote type: object x-expandableFields: - application - automatic_tax - computed - customer - default_tax_rates - discounts - from_quote - invoice - invoice_settings - line_items - on_behalf_of - status_transitions - subscription - subscription_data - subscription_schedule - test_clock - total_details - transfer_data x-resourceId: quote quotes_resource_automatic_tax: description: '' properties: enabled: description: Automatically calculate taxes type: boolean liability: anyOf: - $ref: '#/components/schemas/connect_account_reference' description: >- The account that's liable for tax. If set, the business address and tax registrations required to perform the tax calculation are loaded from this account. The tax transaction is returned in the report of the connected account. nullable: true status: description: >- The status of the most recent automated tax calculation for this quote. enum: - complete - failed - requires_location_inputs nullable: true type: string required: - enabled title: QuotesResourceAutomaticTax type: object x-expandableFields: - liability quotes_resource_computed: description: '' properties: recurring: anyOf: - $ref: '#/components/schemas/quotes_resource_recurring' description: >- The definitive totals and line items the customer will be charged on a recurring basis. Takes into account the line items with recurring prices and discounts with `duration=forever` coupons only. Defaults to `null` if no inputted line items with recurring prices. nullable: true upfront: $ref: '#/components/schemas/quotes_resource_upfront' required: - upfront title: QuotesResourceComputed type: object x-expandableFields: - recurring - upfront quotes_resource_from_quote: description: '' properties: is_revision: description: Whether this quote is a revision of a different quote. type: boolean quote: anyOf: - maxLength: 5000 type: string - $ref: '#/components/schemas/quote' description: The quote that was cloned. x-expansionResources: oneOf: - $ref: '#/components/schemas/quote' required: - is_revision - quote title: QuotesResourceFromQuote type: object x-expandableFields: - quote quotes_resource_recurring: description: '' properties: amount_subtotal: description: Total before any discounts or taxes are applied. type: integer amount_total: description: Total after discounts and taxes are applied. type: integer interval: description: >- The frequency at which a subscription is billed. One of `day`, `week`, `month` or `year`. enum: - day - month - week - year type: string interval_count: description: >- The number of intervals (specified in the `interval` attribute) between subscription billings. For example, `interval=month` and `interval_count=3` bills every 3 months. type: integer total_details: $ref: '#/components/schemas/quotes_resource_total_details' required: - amount_subtotal - amount_total - interval - interval_count - total_details title: QuotesResourceRecurring type: object x-expandableFields: - total_details quotes_resource_status_transitions: description: '' properties: accepted_at: description: >- The time that the quote was accepted. Measured in seconds since Unix epoch. format: unix-time nullable: true type: integer canceled_at: description: >- The time that the quote was canceled. Measured in seconds since Unix epoch. format: unix-time nullable: true type: integer finalized_at: description: >- The time that the quote was finalized. Measured in seconds since Unix epoch. format: unix-time nullable: true type: integer title: QuotesResourceStatusTransitions type: object x-expandableFields: [] quotes_resource_subscription_data_subscription_data: description: '' properties: description: description: >- 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. maxLength: 5000 nullable: true type: string effective_date: description: >- When creating a new subscription, the date of which the subscription schedule will start after the quote is accepted. This date is ignored if it is in the past when the quote is accepted. Measured in seconds since the Unix epoch. format: unix-time nullable: true type: integer metadata: additionalProperties: maxLength: 500 type: string description: >- Set of [key-value pairs](https://stripe.com/docs/api/metadata) that will set metadata on the subscription or subscription schedule when the quote is accepted. If a recurring price is included in `line_items`, this field will be passed to the resulting subscription's `metadata` field. If `subscription_data.effective_date` is used, this field will be passed to the resulting subscription schedule's `phases.metadata` field. Unlike object-level metadata, this field is declarative. Updates will clear prior values. nullable: true type: object trial_period_days: description: >- Integer representing the number of trial period days before the customer is charged for the first time. nullable: true type: integer title: QuotesResourceSubscriptionDataSubscriptionData type: object x-expandableFields: [] quotes_resource_total_details: description: '' properties: amount_discount: description: This is the sum of all the discounts. type: integer amount_shipping: description: This is the sum of all the shipping amounts. nullable: true type: integer amount_tax: description: This is the sum of all the tax amounts. type: integer breakdown: $ref: >- #/components/schemas/quotes_resource_total_details_resource_breakdown required: - amount_discount - amount_tax title: QuotesResourceTotalDetails type: object x-expandableFields: - breakdown quotes_resource_total_details_resource_breakdown: description: '' properties: discounts: description: The aggregated discounts. items: $ref: '#/components/schemas/line_items_discount_amount' type: array taxes: description: The aggregated tax amounts by rate. items: $ref: '#/components/schemas/line_items_tax_amount' type: array required: - discounts - taxes title: QuotesResourceTotalDetailsResourceBreakdown type: object x-expandableFields: - discounts - taxes quotes_resource_transfer_data: description: '' properties: amount: description: >- The amount in cents (or local equivalent) that will be transferred to the destination account when the invoice is paid. By default, the entire amount is transferred to the destination. nullable: true type: integer amount_percent: description: >- A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice total that will be transferred to the destination account. By default, the entire amount will be transferred to the destination. nullable: true type: number destination: anyOf: - maxLength: 5000 type: string - $ref: '#/components/schemas/account' description: >- The account where funds from the payment will be transferred to upon payment success. x-expansionResources: oneOf: - $ref: '#/components/schemas/account' required: - destination title: QuotesResourceTransferData type: object x-expandableFields: - destination quotes_resource_upfront: description: '' properties: amount_subtotal: description: Total before any discounts or taxes are applied. type: integer amount_total: description: Total after discounts and taxes are applied. type: integer line_items: description: >- The line items that will appear on the next invoice after this quote is accepted. This does not include pending invoice items that exist on the customer but may still be included in the next invoice. properties: data: description: Details about each object. items: $ref: '#/components/schemas/item' type: array has_more: description: >- True if this list has another page of items after this one that can be fetched. type: boolean object: description: >- String representing the object's type. Objects of the same type share the same value. Always has the value `list`. enum: - list type: string url: description: The URL where this list can be accessed. maxLength: 5000 type: string required: - data - has_more - object - url title: QuotesResourceListLineItems type: object x-expandableFields: - data total_details: $ref: '#/components/schemas/quotes_resource_total_details' required: - amount_subtotal - amount_total - total_details title: QuotesResourceUpfront type: object x-expandableFields: - line_items - total_details radar.early_fraud_warning: description: >- An early fraud warning indicates that the card issuer has notified us that a charge may be fraudulent. Related guide: [Early fraud warnings](https://stripe.com/docs/disputes/measuring#early-fraud-warnings) properties: actionable: description: >- An EFW is actionable if it has not received a dispute and has not been fully refunded. You may wish to proactively refund a charge that receives an EFW, in order to avoid receiving a dispute later. type: boolean charge: anyOf: - maxLength: 5000 type: string - $ref: '#/components/schemas/charge' description: >- ID of the charge this early fraud warning is for, optionally expanded. x-expansionResources: oneOf: - $ref: '#/components/schemas/charge' created: description: >- Time at which the object was created. Measured in seconds since the Unix epoch. format: unix-time type: integer fraud_type: description: >- The type of fraud labelled by the issuer. One of `card_never_received`, `fraudulent_card_application`, `made_with_counterfeit_card`, `made_with_lost_card`, `made_with_stolen_card`, `misc`, `unauthorized_use_of_card`. maxLength: 5000 type: string id: description: Unique identifier for the object. maxLength: 5000 type: string livemode: description: >- Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. type: boolean object: description: >- String representing the object's type. Objects of the same type share the same value. enum: - radar.early_fraud_warning type: string payment_intent: anyOf: - maxLength: 5000 type: string - $ref: '#/components/schemas/payment_intent' description: >- ID of the Payment Intent this early fraud warning is for, optionally expanded. x-expansionResources: oneOf: - $ref: '#/components/schemas/payment_intent' required: - actionable - charge - created - fraud_type - id - livemode - object title: RadarEarlyFraudWarning type: object x-expandableFields: - charge - payment_intent x-resourceId: radar.early_fraud_warning radar.value_list: description: >- Value lists allow you to group values together which can then be referenced in rules. Related guide: [Default Stripe lists](https://stripe.com/docs/radar/lists#managing-list-items) properties: alias: description: The name of the value list for use in rules. maxLength: 5000 type: string created: description: >- Time at which the object was created. Measured in seconds since the Unix epoch. format: unix-time type: integer created_by: description: The name or email address of the user who created this value list. maxLength: 5000 type: string id: description: Unique identifier for the object. maxLength: 5000 type: string item_type: description: >- The type of items in the value list. One of `card_fingerprint`, `us_bank_account_fingerprint`, `sepa_debit_fingerprint`, `card_bin`, `email`, `ip_address`, `country`, `string`, `case_sensitive_string`, or `customer_id`. enum: - card_bin - card_fingerprint - case_sensitive_string - country - customer_id - email - ip_address - sepa_debit_fingerprint - string - us_bank_account_fingerprint type: string list_items: description: List of items contained within this value list. properties: data: description: Details about each object. items: $ref: '#/components/schemas/radar.value_list_item' type: array has_more: description: >- True if this list has another page of items after this one that can be fetched. type: boolean object: description: >- String representing the object's type. Objects of the same type share the same value. Always has the value `list`. enum: - list type: string url: description: The URL where this list can be accessed. maxLength: 5000 type: string required: - data - has_more - object - url title: RadarListListItemList type: object x-expandableFields: - data livemode: description: >- Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. type: boolean metadata: additionalProperties: maxLength: 500 type: string description: >- 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. type: object name: description: The name of the value list. maxLength: 5000 type: string object: description: >- String representing the object's type. Objects of the same type share the same value. enum: - radar.value_list type: string required: - alias - created - created_by - id - item_type - list_items - livemode - metadata - name - object title: RadarListList type: object x-expandableFields: - list_items x-resourceId: radar.value_list radar.value_list_item: description: >- Value list items allow you to add specific values to a given Radar value list, which can then be used in rules. Related guide: [Managing list items](https://stripe.com/docs/radar/lists#managing-list-items) properties: created: description: >- Time at which the object was created. Measured in seconds since the Unix epoch. format: unix-time type: integer created_by: description: >- The name or email address of the user who added this item to the value list. maxLength: 5000 type: string id: description: Unique identifier for the object. maxLength: 5000 type: string livemode: description: >- Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. type: boolean object: description: >- String representing the object's type. Objects of the same type share the same value. enum: - radar.value_list_item type: string value: description: The value of the item. maxLength: 5000 type: string value_list: description: The identifier of the value list this item belongs to. maxLength: 5000 type: string required: - created - created_by - id - livemode - object - value - value_list title: RadarListListItem type: object x-expandableFields: [] x-resourceId: radar.value_list_item radar_radar_options: description: >- Options to configure Radar. See [Radar Session](https://stripe.com/docs/radar/radar-session) for more information. properties: session: description: >- 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. maxLength: 5000 type: string title: RadarRadarOptions type: object x-expandableFields: [] radar_review_resource_location: description: '' properties: city: description: The city where the payment originated. maxLength: 5000 nullable: true type: string country: description: >- Two-letter ISO code representing the country where the payment originated. maxLength: 5000 nullable: true type: string latitude: description: The geographic latitude where the payment originated. nullable: true type: number longitude: description: The geographic longitude where the payment originated. nullable: true type: number region: description: The state/county/province/region where the payment originated. maxLength: 5000 nullable: true type: string title: RadarReviewResourceLocation type: object x-expandableFields: [] radar_review_resource_session: description: '' properties: browser: description: 'The browser used in this browser session (e.g., `Chrome`).' maxLength: 5000 nullable: true type: string device: description: >- Information about the device used for the browser session (e.g., `Samsung SM-G930T`). maxLength: 5000 nullable: true type: string platform: description: 'The platform for the browser session (e.g., `Macintosh`).' maxLength: 5000 nullable: true type: string version: description: 'The version for the browser session (e.g., `61.0.3163.100`).' maxLength: 5000 nullable: true type: string title: RadarReviewResourceSession type: object x-expandableFields: [] received_payment_method_details_financial_account: description: '' properties: id: description: The FinancialAccount ID. maxLength: 5000 type: string network: description: >- The rails the ReceivedCredit was sent over. A FinancialAccount can only send funds over `stripe`. enum: - stripe type: string required: - id - network title: received_payment_method_details_financial_account type: object x-expandableFields: [] recurring: description: '' properties: aggregate_usage: description: >- Specifies a usage aggregation strategy for prices of `usage_type=metered`. Defaults to `sum`. enum: - last_during_period - last_ever - max - sum nullable: true type: string interval: description: >- The frequency at which a subscription is billed. One of `day`, `week`, `month` or `year`. enum: - day - month - week - year type: string interval_count: description: >- The number of intervals (specified in the `interval` attribute) between subscription billings. For example, `interval=month` and `interval_count=3` bills every 3 months. type: integer meter: description: The meter tracking the usage of a metered price maxLength: 5000 nullable: true type: string usage_type: description: >- Configures how the quantity per period should be determined. Can be either `metered` or `licensed`. `licensed` automatically bills the `quantity` set when adding it to a subscription. `metered` aggregates the total usage based on usage records. Defaults to `licensed`. enum: - licensed - metered type: string required: - interval - interval_count - usage_type title: Recurring type: object x-expandableFields: [] refund: description: >- Refund objects allow you to refund a previously created charge that isn't refunded yet. Funds are refunded to the credit or debit card that's initially charged. Related guide: [Refunds](https://stripe.com/docs/refunds) properties: amount: description: 'Amount, in cents (or local equivalent).' type: integer balance_transaction: anyOf: - maxLength: 5000 type: string - $ref: '#/components/schemas/balance_transaction' description: >- Balance transaction that describes the impact on your account balance. nullable: true x-expansionResources: oneOf: - $ref: '#/components/schemas/balance_transaction' charge: anyOf: - maxLength: 5000 type: string - $ref: '#/components/schemas/charge' description: ID of the charge that's refunded. nullable: true x-expansionResources: oneOf: - $ref: '#/components/schemas/charge' created: description: >- Time at which the object was created. Measured in seconds since the Unix epoch. format: unix-time type: integer currency: description: >- 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). type: string description: description: >- An arbitrary string attached to the object. You can use this for displaying to users (available on non-card refunds only). maxLength: 5000 type: string destination_details: $ref: '#/components/schemas/refund_destination_details' failure_balance_transaction: anyOf: - maxLength: 5000 type: string - $ref: '#/components/schemas/balance_transaction' description: >- After the refund fails, this balance transaction describes the adjustment made on your account balance that reverses the initial balance transaction. x-expansionResources: oneOf: - $ref: '#/components/schemas/balance_transaction' failure_reason: description: >- Provides the reason for the refund failure. Possible values are: `lost_or_stolen_card`, `expired_or_canceled_card`, `charge_for_pending_refund_disputed`, `insufficient_funds`, `declined`, `merchant_request`, or `unknown`. maxLength: 5000 type: string id: description: Unique identifier for the object. maxLength: 5000 type: string instructions_email: description: >- For payment methods without native refund support (for example, Konbini, PromptPay), provide an email address for the customer to receive refund instructions. maxLength: 5000 type: string metadata: additionalProperties: maxLength: 500 type: string description: >- 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. nullable: true type: object next_action: $ref: '#/components/schemas/refund_next_action' object: description: >- String representing the object's type. Objects of the same type share the same value. enum: - refund type: string payment_intent: anyOf: - maxLength: 5000 type: string - $ref: '#/components/schemas/payment_intent' description: ID of the PaymentIntent that's refunded. nullable: true x-expansionResources: oneOf: - $ref: '#/components/schemas/payment_intent' reason: description: >- Reason for the refund, which is either user-provided (`duplicate`, `fraudulent`, or `requested_by_customer`) or generated by Stripe internally (`expired_uncaptured_charge`). enum: - duplicate - expired_uncaptured_charge - fraudulent - requested_by_customer nullable: true type: string x-stripeBypassValidation: true receipt_number: description: >- This is the transaction number that appears on email receipts sent for this refund. maxLength: 5000 nullable: true type: string source_transfer_reversal: anyOf: - maxLength: 5000 type: string - $ref: '#/components/schemas/transfer_reversal' description: >- The transfer reversal that's associated with the refund. Only present if the charge came from another Stripe account. nullable: true x-expansionResources: oneOf: - $ref: '#/components/schemas/transfer_reversal' status: description: >- Status of the refund. This can be `pending`, `requires_action`, `succeeded`, `failed`, or `canceled`. Learn more about [failed refunds](https://stripe.com/docs/refunds#failed-refunds). maxLength: 5000 nullable: true type: string transfer_reversal: anyOf: - maxLength: 5000 type: string - $ref: '#/components/schemas/transfer_reversal' description: >- This refers to the transfer reversal object if the accompanying transfer reverses. This is only applicable if the charge was created using the destination parameter. nullable: true x-expansionResources: oneOf: - $ref: '#/components/schemas/transfer_reversal' required: - amount - created - currency - id - object title: Refund type: object x-expandableFields: - balance_transaction - charge - destination_details - failure_balance_transaction - next_action - payment_intent - source_transfer_reversal - transfer_reversal x-resourceId: refund refund_destination_details: description: '' properties: affirm: $ref: '#/components/schemas/destination_details_unimplemented' afterpay_clearpay: $ref: '#/components/schemas/destination_details_unimplemented' alipay: $ref: '#/components/schemas/destination_details_unimplemented' amazon_pay: $ref: '#/components/schemas/destination_details_unimplemented' au_bank_transfer: $ref: '#/components/schemas/destination_details_unimplemented' blik: $ref: '#/components/schemas/refund_destination_details_generic' br_bank_transfer: $ref: '#/components/schemas/refund_destination_details_generic' card: $ref: '#/components/schemas/refund_destination_details_card' cashapp: $ref: '#/components/schemas/destination_details_unimplemented' customer_cash_balance: $ref: '#/components/schemas/destination_details_unimplemented' eps: $ref: '#/components/schemas/destination_details_unimplemented' eu_bank_transfer: $ref: '#/components/schemas/refund_destination_details_generic' gb_bank_transfer: $ref: '#/components/schemas/refund_destination_details_generic' giropay: $ref: '#/components/schemas/destination_details_unimplemented' grabpay: $ref: '#/components/schemas/destination_details_unimplemented' jp_bank_transfer: $ref: '#/components/schemas/refund_destination_details_generic' klarna: $ref: '#/components/schemas/destination_details_unimplemented' mx_bank_transfer: $ref: '#/components/schemas/refund_destination_details_generic' p24: $ref: '#/components/schemas/refund_destination_details_generic' paynow: $ref: '#/components/schemas/destination_details_unimplemented' paypal: $ref: '#/components/schemas/destination_details_unimplemented' pix: $ref: '#/components/schemas/destination_details_unimplemented' revolut: $ref: '#/components/schemas/destination_details_unimplemented' sofort: $ref: '#/components/schemas/destination_details_unimplemented' swish: $ref: '#/components/schemas/refund_destination_details_generic' th_bank_transfer: $ref: '#/components/schemas/refund_destination_details_generic' type: description: >- The type of transaction-specific details of the payment method used in the refund (e.g., `card`). An additional hash is included on `destination_details` with a name matching this value. It contains information specific to the refund transaction. maxLength: 5000 type: string us_bank_transfer: $ref: '#/components/schemas/refund_destination_details_generic' wechat_pay: $ref: '#/components/schemas/destination_details_unimplemented' zip: $ref: '#/components/schemas/destination_details_unimplemented' required: - type title: refund_destination_details type: object x-expandableFields: - affirm - afterpay_clearpay - alipay - amazon_pay - au_bank_transfer - blik - br_bank_transfer - card - cashapp - customer_cash_balance - eps - eu_bank_transfer - gb_bank_transfer - giropay - grabpay - jp_bank_transfer - klarna - mx_bank_transfer - p24 - paynow - paypal - pix - revolut - sofort - swish - th_bank_transfer - us_bank_transfer - wechat_pay - zip refund_destination_details_card: description: '' properties: reference: description: Value of the reference number assigned to the refund. maxLength: 5000 type: string reference_status: description: >- Status of the reference number on the refund. This can be `pending`, `available` or `unavailable`. maxLength: 5000 type: string reference_type: description: Type of the reference number assigned to the refund. maxLength: 5000 type: string type: description: 'The type of refund. This can be `refund`, `reversal`, or `pending`.' enum: - pending - refund - reversal type: string required: - type title: refund_destination_details_card type: object x-expandableFields: [] refund_destination_details_generic: description: '' properties: reference: description: The reference assigned to the refund. maxLength: 5000 nullable: true type: string reference_status: description: >- Status of the reference on the refund. This can be `pending`, `available` or `unavailable`. maxLength: 5000 nullable: true type: string title: refund_destination_details_generic type: object x-expandableFields: [] refund_next_action: description: '' properties: display_details: anyOf: - $ref: '#/components/schemas/refund_next_action_display_details' description: Contains the refund details. nullable: true type: description: Type of the next action to perform. maxLength: 5000 type: string required: - type title: RefundNextAction type: object x-expandableFields: - display_details refund_next_action_display_details: description: '' properties: email_sent: $ref: '#/components/schemas/email_sent' expires_at: description: The expiry timestamp. format: unix-time type: integer required: - email_sent - expires_at title: RefundNextActionDisplayDetails type: object x-expandableFields: - email_sent reporting.report_run: description: >- The Report Run object represents an instance of a report type generated with specific run parameters. Once the object is created, Stripe begins processing the report. When the report has finished running, it will give you a reference to a file where you can retrieve your results. For an overview, see [API Access to Reports](https://stripe.com/docs/reporting/statements/api). Note that certain report types can only be run based on your live-mode data (not test-mode data), and will error when queried without a [live-mode API key](https://stripe.com/docs/keys#test-live-modes). properties: created: description: >- Time at which the object was created. Measured in seconds since the Unix epoch. format: unix-time type: integer error: description: >- If something should go wrong during the run, a message about the failure (populated when `status=failed`). maxLength: 5000 nullable: true type: string id: description: Unique identifier for the object. maxLength: 5000 type: string livemode: description: >- `true` if the report is run on live mode data and `false` if it is run on test mode data. type: boolean object: description: >- String representing the object's type. Objects of the same type share the same value. enum: - reporting.report_run type: string parameters: $ref: >- #/components/schemas/financial_reporting_finance_report_run_run_parameters report_type: description: >- The ID of the [report type](https://stripe.com/docs/reports/report-types) to run, such as `"balance.summary.1"`. maxLength: 5000 type: string result: anyOf: - $ref: '#/components/schemas/file' description: >- The file object representing the result of the report run (populated when `status=succeeded`). nullable: true status: description: >- Status of this report run. This will be `pending` when the run is initially created. When the run finishes, this will be set to `succeeded` and the `result` field will be populated. Rarely, we may encounter an error, at which point this will be set to `failed` and the `error` field will be populated. maxLength: 5000 type: string succeeded_at: description: |- Timestamp at which this run successfully finished (populated when `status=succeeded`). Measured in seconds since the Unix epoch. format: unix-time nullable: true type: integer required: - created - id - livemode - object - parameters - report_type - status title: reporting_report_run type: object x-expandableFields: - parameters - result x-resourceId: reporting.report_run reporting.report_type: description: >- The Report Type resource corresponds to a particular type of report, such as the "Activity summary" or "Itemized payouts" reports. These objects are identified by an ID belonging to a set of enumerated values. See [API Access to Reports documentation](https://stripe.com/docs/reporting/statements/api) for those Report Type IDs, along with required and optional parameters. Note that certain report types can only be run based on your live-mode data (not test-mode data), and will error when queried without a [live-mode API key](https://stripe.com/docs/keys#test-live-modes). properties: data_available_end: description: >- Most recent time for which this Report Type is available. Measured in seconds since the Unix epoch. format: unix-time type: integer data_available_start: description: >- Earliest time for which this Report Type is available. Measured in seconds since the Unix epoch. format: unix-time type: integer default_columns: description: >- List of column names that are included by default when this Report Type gets run. (If the Report Type doesn't support the `columns` parameter, this will be null.) items: maxLength: 5000 type: string nullable: true type: array id: description: >- The [ID of the Report Type](https://stripe.com/docs/reporting/statements/api#available-report-types), such as `balance.summary.1`. maxLength: 5000 type: string livemode: description: >- Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. type: boolean name: description: Human-readable name of the Report Type maxLength: 5000 type: string object: description: >- String representing the object's type. Objects of the same type share the same value. enum: - reporting.report_type type: string updated: description: >- When this Report Type was latest updated. Measured in seconds since the Unix epoch. format: unix-time type: integer version: description: >- Version of the Report Type. Different versions report with the same ID will have the same purpose, but may take different run parameters or have different result schemas. type: integer required: - data_available_end - data_available_start - id - livemode - name - object - updated - version title: reporting_report_type type: object x-expandableFields: [] x-resourceId: reporting.report_type reserve_transaction: description: '' properties: amount: type: integer currency: description: >- 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). type: string description: description: >- An arbitrary string attached to the object. Often useful for displaying to users. maxLength: 5000 nullable: true type: string id: description: Unique identifier for the object. maxLength: 5000 type: string object: description: >- String representing the object's type. Objects of the same type share the same value. enum: - reserve_transaction type: string required: - amount - currency - id - object title: ReserveTransaction type: object x-expandableFields: [] review: description: >- Reviews can be used to supplement automated fraud detection with human expertise. Learn more about [Radar](/radar) and reviewing payments [here](https://stripe.com/docs/radar/reviews). properties: billing_zip: description: 'The ZIP or postal code of the card used, if applicable.' maxLength: 5000 nullable: true type: string charge: anyOf: - maxLength: 5000 type: string - $ref: '#/components/schemas/charge' description: The charge associated with this review. nullable: true x-expansionResources: oneOf: - $ref: '#/components/schemas/charge' closed_reason: description: >- The reason the review was closed, or null if it has not yet been closed. One of `approved`, `refunded`, `refunded_as_fraud`, `disputed`, or `redacted`. enum: - approved - disputed - redacted - refunded - refunded_as_fraud nullable: true type: string created: description: >- Time at which the object was created. Measured in seconds since the Unix epoch. format: unix-time type: integer id: description: Unique identifier for the object. maxLength: 5000 type: string ip_address: description: The IP address where the payment originated. maxLength: 5000 nullable: true type: string ip_address_location: anyOf: - $ref: '#/components/schemas/radar_review_resource_location' description: >- Information related to the location of the payment. Note that this information is an approximation and attempts to locate the nearest population center - it should not be used to determine a specific address. nullable: true livemode: description: >- Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. type: boolean object: description: >- String representing the object's type. Objects of the same type share the same value. enum: - review type: string open: description: 'If `true`, the review needs action.' type: boolean opened_reason: description: The reason the review was opened. One of `rule` or `manual`. enum: - manual - rule type: string payment_intent: anyOf: - maxLength: 5000 type: string - $ref: '#/components/schemas/payment_intent' description: 'The PaymentIntent ID associated with this review, if one exists.' x-expansionResources: oneOf: - $ref: '#/components/schemas/payment_intent' reason: description: >- The reason the review is currently open or closed. One of `rule`, `manual`, `approved`, `refunded`, `refunded_as_fraud`, `disputed`, or `redacted`. maxLength: 5000 type: string session: anyOf: - $ref: '#/components/schemas/radar_review_resource_session' description: >- Information related to the browsing session of the user who initiated the payment. nullable: true required: - created - id - livemode - object - open - opened_reason - reason title: RadarReview type: object x-expandableFields: - charge - ip_address_location - payment_intent - session x-resourceId: review rule: description: '' properties: action: description: The action taken on the payment. maxLength: 5000 type: string id: description: Unique identifier for the object. maxLength: 5000 type: string predicate: description: The predicate to evaluate the payment against. maxLength: 5000 type: string required: - action - id - predicate title: RadarRule type: object x-expandableFields: [] scheduled_query_run: description: >- If you have [scheduled a Sigma query](https://stripe.com/docs/sigma/scheduled-queries), you'll receive a `sigma.scheduled_query_run.created` webhook each time the query runs. The webhook contains a `ScheduledQueryRun` object, which you can use to retrieve the query results. properties: created: description: >- Time at which the object was created. Measured in seconds since the Unix epoch. format: unix-time type: integer data_load_time: description: >- When the query was run, Sigma contained a snapshot of your Stripe data at this time. format: unix-time type: integer error: $ref: '#/components/schemas/sigma_scheduled_query_run_error' file: anyOf: - $ref: '#/components/schemas/file' description: The file object representing the results of the query. nullable: true id: description: Unique identifier for the object. maxLength: 5000 type: string livemode: description: >- Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. type: boolean object: description: >- String representing the object's type. Objects of the same type share the same value. enum: - scheduled_query_run type: string result_available_until: description: >- Time at which the result expires and is no longer available for download. format: unix-time type: integer sql: description: SQL for the query. maxLength: 100000 type: string status: description: >- The query's execution status, which will be `completed` for successful runs, and `canceled`, `failed`, or `timed_out` otherwise. maxLength: 5000 type: string title: description: Title of the query. maxLength: 5000 type: string required: - created - data_load_time - id - livemode - object - result_available_until - sql - status - title title: ScheduledQueryRun type: object x-expandableFields: - error - file x-resourceId: scheduled_query_run schedules_phase_automatic_tax: description: '' properties: enabled: description: >- Whether Stripe automatically computes tax on invoices created during this phase. type: boolean liability: anyOf: - $ref: '#/components/schemas/connect_account_reference' description: >- The account that's liable for tax. If set, the business address and tax registrations required to perform the tax calculation are loaded from this account. The tax transaction is returned in the report of the connected account. nullable: true required: - enabled title: SchedulesPhaseAutomaticTax type: object x-expandableFields: - liability secret_service_resource_scope: description: '' properties: type: description: The secret scope type. enum: - account - user type: string user: description: 'The user ID, if type is set to "user"' maxLength: 5000 type: string required: - type title: SecretServiceResourceScope type: object x-expandableFields: [] sepa_debit_generated_from: description: '' properties: charge: anyOf: - maxLength: 5000 type: string - $ref: '#/components/schemas/charge' description: 'The ID of the Charge that generated this PaymentMethod, if any.' nullable: true x-expansionResources: oneOf: - $ref: '#/components/schemas/charge' setup_attempt: anyOf: - maxLength: 5000 type: string - $ref: '#/components/schemas/setup_attempt' description: >- The ID of the SetupAttempt that generated this PaymentMethod, if any. nullable: true x-expansionResources: oneOf: - $ref: '#/components/schemas/setup_attempt' title: sepa_debit_generated_from type: object x-expandableFields: - charge - setup_attempt setup_attempt: description: |- A SetupAttempt describes one attempted confirmation of a SetupIntent, whether that confirmation is successful or unsuccessful. You can use SetupAttempts to inspect details of a specific attempt at setting up a payment method using a SetupIntent. properties: application: anyOf: - maxLength: 5000 type: string - $ref: '#/components/schemas/application' description: >- 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. nullable: true x-expansionResources: oneOf: - $ref: '#/components/schemas/application' attach_to_self: description: >- 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. type: boolean created: description: >- Time at which the object was created. Measured in seconds since the Unix epoch. format: unix-time type: integer customer: anyOf: - maxLength: 5000 type: string - $ref: '#/components/schemas/customer' - $ref: '#/components/schemas/deleted_customer' description: >- 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. nullable: true x-expansionResources: oneOf: - $ref: '#/components/schemas/customer' - $ref: '#/components/schemas/deleted_customer' flow_directions: description: >- 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. items: enum: - inbound - outbound type: string nullable: true type: array id: description: Unique identifier for the object. maxLength: 5000 type: string livemode: description: >- Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. type: boolean object: description: >- String representing the object's type. Objects of the same type share the same value. enum: - setup_attempt type: string on_behalf_of: anyOf: - maxLength: 5000 type: string - $ref: '#/components/schemas/account' description: >- 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. nullable: true x-expansionResources: oneOf: - $ref: '#/components/schemas/account' payment_method: anyOf: - maxLength: 5000 type: string - $ref: '#/components/schemas/payment_method' description: ID of the payment method used with this SetupAttempt. x-expansionResources: oneOf: - $ref: '#/components/schemas/payment_method' payment_method_details: $ref: '#/components/schemas/setup_attempt_payment_method_details' setup_error: anyOf: - $ref: '#/components/schemas/api_errors' description: >- The error encountered during this attempt to confirm the SetupIntent, if any. nullable: true setup_intent: anyOf: - maxLength: 5000 type: string - $ref: '#/components/schemas/setup_intent' description: ID of the SetupIntent that this attempt belongs to. x-expansionResources: oneOf: - $ref: '#/components/schemas/setup_intent' status: description: >- Status of this SetupAttempt, one of `requires_confirmation`, `requires_action`, `processing`, `succeeded`, `failed`, or `abandoned`. maxLength: 5000 type: string usage: description: >- The value of [usage](https://stripe.com/docs/api/setup_intents/object#setup_intent_object-usage) on the SetupIntent at the time of this confirmation, one of `off_session` or `on_session`. maxLength: 5000 type: string required: - created - id - livemode - object - payment_method - payment_method_details - setup_intent - status - usage title: PaymentFlowsSetupIntentSetupAttempt type: object x-expandableFields: - application - customer - on_behalf_of - payment_method - payment_method_details - setup_error - setup_intent x-resourceId: setup_attempt setup_attempt_payment_method_details: description: '' properties: acss_debit: $ref: '#/components/schemas/setup_attempt_payment_method_details_acss_debit' au_becs_debit: $ref: >- #/components/schemas/setup_attempt_payment_method_details_au_becs_debit bacs_debit: $ref: '#/components/schemas/setup_attempt_payment_method_details_bacs_debit' bancontact: $ref: '#/components/schemas/setup_attempt_payment_method_details_bancontact' boleto: $ref: '#/components/schemas/setup_attempt_payment_method_details_boleto' card: $ref: '#/components/schemas/setup_attempt_payment_method_details_card' card_present: $ref: >- #/components/schemas/setup_attempt_payment_method_details_card_present cashapp: $ref: '#/components/schemas/setup_attempt_payment_method_details_cashapp' ideal: $ref: '#/components/schemas/setup_attempt_payment_method_details_ideal' klarna: $ref: '#/components/schemas/setup_attempt_payment_method_details_klarna' link: $ref: '#/components/schemas/setup_attempt_payment_method_details_link' paypal: $ref: '#/components/schemas/setup_attempt_payment_method_details_paypal' sepa_debit: $ref: '#/components/schemas/setup_attempt_payment_method_details_sepa_debit' sofort: $ref: '#/components/schemas/setup_attempt_payment_method_details_sofort' type: description: >- 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. maxLength: 5000 type: string us_bank_account: $ref: >- #/components/schemas/setup_attempt_payment_method_details_us_bank_account required: - type title: SetupAttemptPaymentMethodDetails type: object x-expandableFields: - acss_debit - au_becs_debit - bacs_debit - bancontact - boleto - card - card_present - cashapp - ideal - klarna - link - paypal - sepa_debit - sofort - us_bank_account setup_attempt_payment_method_details_acss_debit: description: '' properties: {} title: setup_attempt_payment_method_details_acss_debit type: object x-expandableFields: [] setup_attempt_payment_method_details_au_becs_debit: description: '' properties: {} title: setup_attempt_payment_method_details_au_becs_debit type: object x-expandableFields: [] setup_attempt_payment_method_details_bacs_debit: description: '' properties: {} title: setup_attempt_payment_method_details_bacs_debit type: object x-expandableFields: [] setup_attempt_payment_method_details_bancontact: description: '' properties: bank_code: description: Bank code of bank associated with the bank account. maxLength: 5000 nullable: true type: string bank_name: description: Name of the bank associated with the bank account. maxLength: 5000 nullable: true type: string bic: description: Bank Identifier Code of the bank associated with the bank account. maxLength: 5000 nullable: true type: string generated_sepa_debit: anyOf: - maxLength: 5000 type: string - $ref: '#/components/schemas/payment_method' description: >- The ID of the SEPA Direct Debit PaymentMethod which was generated by this SetupAttempt. nullable: true x-expansionResources: oneOf: - $ref: '#/components/schemas/payment_method' generated_sepa_debit_mandate: anyOf: - maxLength: 5000 type: string - $ref: '#/components/schemas/mandate' description: >- The mandate for the SEPA Direct Debit PaymentMethod which was generated by this SetupAttempt. nullable: true x-expansionResources: oneOf: - $ref: '#/components/schemas/mandate' iban_last4: description: Last four characters of the IBAN. maxLength: 5000 nullable: true type: string preferred_language: description: >- Preferred language of the Bancontact authorization page that the customer is redirected to. Can be one of `en`, `de`, `fr`, or `nl` enum: - de - en - fr - nl nullable: true type: string verified_name: description: >- 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. maxLength: 5000 nullable: true type: string title: setup_attempt_payment_method_details_bancontact type: object x-expandableFields: - generated_sepa_debit - generated_sepa_debit_mandate setup_attempt_payment_method_details_boleto: description: '' properties: {} title: setup_attempt_payment_method_details_boleto type: object x-expandableFields: [] setup_attempt_payment_method_details_card: description: '' properties: brand: description: >- Card brand. Can be `amex`, `diners`, `discover`, `eftpos_au`, `jcb`, `mastercard`, `unionpay`, `visa`, or `unknown`. maxLength: 5000 nullable: true type: string checks: anyOf: - $ref: >- #/components/schemas/setup_attempt_payment_method_details_card_checks description: >- Check results by Card networks on Card address and CVC at the time of authorization nullable: true country: description: >- 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. maxLength: 5000 nullable: true type: string exp_month: description: Two-digit number representing the card's expiration month. nullable: true type: integer exp_year: description: Four-digit number representing the card's expiration year. nullable: true type: integer fingerprint: description: >- 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.* maxLength: 5000 nullable: true type: string funding: description: >- Card funding type. Can be `credit`, `debit`, `prepaid`, or `unknown`. maxLength: 5000 nullable: true type: string last4: description: The last four digits of the card. maxLength: 5000 nullable: true type: string network: description: >- Identifies which network this charge was processed on. Can be `amex`, `cartes_bancaires`, `diners`, `discover`, `eftpos_au`, `interac`, `jcb`, `mastercard`, `unionpay`, `visa`, or `unknown`. maxLength: 5000 nullable: true type: string three_d_secure: anyOf: - $ref: '#/components/schemas/three_d_secure_details' description: Populated if this authorization used 3D Secure authentication. nullable: true wallet: anyOf: - $ref: >- #/components/schemas/setup_attempt_payment_method_details_card_wallet description: >- If this Card is part of a card wallet, this contains the details of the card wallet. nullable: true title: setup_attempt_payment_method_details_card type: object x-expandableFields: - checks - three_d_secure - wallet setup_attempt_payment_method_details_card_checks: description: '' properties: address_line1_check: description: >- If a address line1 was provided, results of the check, one of `pass`, `fail`, `unavailable`, or `unchecked`. maxLength: 5000 nullable: true type: string address_postal_code_check: description: >- If a address postal code was provided, results of the check, one of `pass`, `fail`, `unavailable`, or `unchecked`. maxLength: 5000 nullable: true type: string cvc_check: description: >- If a CVC was provided, results of the check, one of `pass`, `fail`, `unavailable`, or `unchecked`. maxLength: 5000 nullable: true type: string title: setup_attempt_payment_method_details_card_checks type: object x-expandableFields: [] setup_attempt_payment_method_details_card_present: description: '' properties: generated_card: anyOf: - maxLength: 5000 type: string - $ref: '#/components/schemas/payment_method' description: >- The ID of the Card PaymentMethod which was generated by this SetupAttempt. nullable: true x-expansionResources: oneOf: - $ref: '#/components/schemas/payment_method' offline: anyOf: - $ref: '#/components/schemas/payment_method_details_card_present_offline' description: Details about payments collected offline. nullable: true title: setup_attempt_payment_method_details_card_present type: object x-expandableFields: - generated_card - offline setup_attempt_payment_method_details_card_wallet: description: '' properties: apple_pay: $ref: '#/components/schemas/payment_method_details_card_wallet_apple_pay' google_pay: $ref: '#/components/schemas/payment_method_details_card_wallet_google_pay' type: description: >- 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. enum: - apple_pay - google_pay - link type: string required: - type title: setup_attempt_payment_method_details_card_wallet type: object x-expandableFields: - apple_pay - google_pay setup_attempt_payment_method_details_cashapp: description: '' properties: {} title: setup_attempt_payment_method_details_cashapp type: object x-expandableFields: [] setup_attempt_payment_method_details_ideal: description: '' properties: bank: description: >- 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`. enum: - abn_amro - asn_bank - bunq - handelsbanken - ing - knab - moneyou - n26 - nn - rabobank - regiobank - revolut - sns_bank - triodos_bank - van_lanschot - yoursafe nullable: true type: string bic: description: The Bank Identifier Code of the customer's bank. enum: - ABNANL2A - ASNBNL21 - BITSNL2A - BUNQNL2A - FVLBNL22 - HANDNL2A - INGBNL2A - KNABNL2H - MOYONL21 - NNBANL2G - NTSBDEB1 - RABONL2U - RBRBNL21 - REVOIE23 - REVOLT21 - SNSBNL2A - TRIONL2U nullable: true type: string generated_sepa_debit: anyOf: - maxLength: 5000 type: string - $ref: '#/components/schemas/payment_method' description: >- The ID of the SEPA Direct Debit PaymentMethod which was generated by this SetupAttempt. nullable: true x-expansionResources: oneOf: - $ref: '#/components/schemas/payment_method' generated_sepa_debit_mandate: anyOf: - maxLength: 5000 type: string - $ref: '#/components/schemas/mandate' description: >- The mandate for the SEPA Direct Debit PaymentMethod which was generated by this SetupAttempt. nullable: true x-expansionResources: oneOf: - $ref: '#/components/schemas/mandate' iban_last4: description: Last four characters of the IBAN. maxLength: 5000 nullable: true type: string verified_name: description: >- 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. maxLength: 5000 nullable: true type: string title: setup_attempt_payment_method_details_ideal type: object x-expandableFields: - generated_sepa_debit - generated_sepa_debit_mandate setup_attempt_payment_method_details_klarna: description: '' properties: {} title: setup_attempt_payment_method_details_klarna type: object x-expandableFields: [] setup_attempt_payment_method_details_link: description: '' properties: {} title: setup_attempt_payment_method_details_link type: object x-expandableFields: [] setup_attempt_payment_method_details_paypal: description: '' properties: {} title: setup_attempt_payment_method_details_paypal type: object x-expandableFields: [] setup_attempt_payment_method_details_sepa_debit: description: '' properties: {} title: setup_attempt_payment_method_details_sepa_debit type: object x-expandableFields: [] setup_attempt_payment_method_details_sofort: description: '' properties: bank_code: description: Bank code of bank associated with the bank account. maxLength: 5000 nullable: true type: string bank_name: description: Name of the bank associated with the bank account. maxLength: 5000 nullable: true type: string bic: description: Bank Identifier Code of the bank associated with the bank account. maxLength: 5000 nullable: true type: string generated_sepa_debit: anyOf: - maxLength: 5000 type: string - $ref: '#/components/schemas/payment_method' description: >- The ID of the SEPA Direct Debit PaymentMethod which was generated by this SetupAttempt. nullable: true x-expansionResources: oneOf: - $ref: '#/components/schemas/payment_method' generated_sepa_debit_mandate: anyOf: - maxLength: 5000 type: string - $ref: '#/components/schemas/mandate' description: >- The mandate for the SEPA Direct Debit PaymentMethod which was generated by this SetupAttempt. nullable: true x-expansionResources: oneOf: - $ref: '#/components/schemas/mandate' iban_last4: description: Last four characters of the IBAN. maxLength: 5000 nullable: true type: string preferred_language: description: >- Preferred language of the Sofort authorization page that the customer is redirected to. Can be one of `en`, `de`, `fr`, or `nl` enum: - de - en - fr - nl nullable: true type: string verified_name: description: >- 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. maxLength: 5000 nullable: true type: string title: setup_attempt_payment_method_details_sofort type: object x-expandableFields: - generated_sepa_debit - generated_sepa_debit_mandate setup_attempt_payment_method_details_us_bank_account: description: '' properties: {} title: setup_attempt_payment_method_details_us_bank_account type: object x-expandableFields: [] setup_intent: description: >- A SetupIntent guides you through the process of setting up and saving a customer's payment credentials for future payments. For example, you can use a SetupIntent to set up and save your customer's card without immediately collecting a payment. Later, you can use [PaymentIntents](https://stripe.com/docs/api#payment_intents) to drive the payment flow. Create a SetupIntent when you're ready to collect your customer's payment credentials. Don't maintain long-lived, unconfirmed SetupIntents because they might not be valid. The SetupIntent transitions through multiple [statuses](https://docs.stripe.com/payments/intents#intent-statuses) as it guides you through the setup process. Successful SetupIntents result in payment credentials that are optimized for future payments. For example, cardholders in [certain regions](https://stripe.com/guides/strong-customer-authentication) might need to be run through [Strong Customer Authentication](https://docs.stripe.com/strong-customer-authentication) during payment method collection to streamline later [off-session payments](https://docs.stripe.com/payments/setup-intents). If you use the SetupIntent with a [Customer](https://stripe.com/docs/api#setup_intent_object-customer), it automatically attaches the resulting payment method to that Customer after successful setup. We recommend using SetupIntents or [setup_future_usage](https://stripe.com/docs/api#payment_intent_object-setup_future_usage) on PaymentIntents to save payment methods to prevent saving invalid or unoptimized payment methods. By using SetupIntents, you can reduce friction for your customers, even as regulations change over time. Related guide: [Setup Intents API](https://docs.stripe.com/payments/setup-intents) properties: application: anyOf: - maxLength: 5000 type: string - $ref: '#/components/schemas/application' description: ID of the Connect application that created the SetupIntent. nullable: true x-expansionResources: oneOf: - $ref: '#/components/schemas/application' attach_to_self: description: >- 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. type: boolean automatic_payment_methods: anyOf: - $ref: >- #/components/schemas/payment_flows_automatic_payment_methods_setup_intent description: >- Settings for dynamic payment methods compatible with this Setup Intent nullable: true cancellation_reason: description: >- Reason for cancellation of this SetupIntent, one of `abandoned`, `requested_by_customer`, or `duplicate`. enum: - abandoned - duplicate - requested_by_customer nullable: true type: string client_secret: description: >- The client secret of this SetupIntent. Used for client-side retrieval using a publishable key. The client secret can be used to complete payment setup from your frontend. It should not be stored, logged, or exposed to anyone other than the customer. Make sure that you have TLS enabled on any page that includes the client secret. maxLength: 5000 nullable: true type: string created: description: >- Time at which the object was created. Measured in seconds since the Unix epoch. format: unix-time type: integer customer: anyOf: - maxLength: 5000 type: string - $ref: '#/components/schemas/customer' - $ref: '#/components/schemas/deleted_customer' description: >- ID of the Customer this SetupIntent belongs to, if one exists. If present, the SetupIntent's payment method will be attached to the Customer on successful setup. Payment methods attached to other Customers cannot be used with this SetupIntent. nullable: true x-expansionResources: oneOf: - $ref: '#/components/schemas/customer' - $ref: '#/components/schemas/deleted_customer' description: description: >- An arbitrary string attached to the object. Often useful for displaying to users. maxLength: 5000 nullable: true type: string flow_directions: description: >- 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. items: enum: - inbound - outbound type: string nullable: true type: array id: description: Unique identifier for the object. maxLength: 5000 type: string last_setup_error: anyOf: - $ref: '#/components/schemas/api_errors' description: The error encountered in the previous SetupIntent confirmation. nullable: true latest_attempt: anyOf: - maxLength: 5000 type: string - $ref: '#/components/schemas/setup_attempt' description: The most recent SetupAttempt for this SetupIntent. nullable: true x-expansionResources: oneOf: - $ref: '#/components/schemas/setup_attempt' livemode: description: >- Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. type: boolean mandate: anyOf: - maxLength: 5000 type: string - $ref: '#/components/schemas/mandate' description: ID of the multi use Mandate generated by the SetupIntent. nullable: true x-expansionResources: oneOf: - $ref: '#/components/schemas/mandate' metadata: additionalProperties: maxLength: 500 type: string description: >- 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. nullable: true type: object next_action: anyOf: - $ref: '#/components/schemas/setup_intent_next_action' description: >- If present, this property tells you what actions you need to take in order for your customer to continue payment setup. nullable: true object: description: >- String representing the object's type. Objects of the same type share the same value. enum: - setup_intent type: string on_behalf_of: anyOf: - maxLength: 5000 type: string - $ref: '#/components/schemas/account' description: The account (if any) for which the setup is intended. nullable: true x-expansionResources: oneOf: - $ref: '#/components/schemas/account' payment_method: anyOf: - maxLength: 5000 type: string - $ref: '#/components/schemas/payment_method' description: ID of the payment method used with this SetupIntent. nullable: true x-expansionResources: oneOf: - $ref: '#/components/schemas/payment_method' payment_method_configuration_details: anyOf: - $ref: >- #/components/schemas/payment_method_config_biz_payment_method_configuration_details description: >- Information about the payment method configuration used for this Setup Intent. nullable: true payment_method_options: anyOf: - $ref: '#/components/schemas/setup_intent_payment_method_options' description: Payment method-specific configuration for this SetupIntent. nullable: true payment_method_types: description: >- The list of payment method types (e.g. card) that this SetupIntent is allowed to set up. items: maxLength: 5000 type: string type: array single_use_mandate: anyOf: - maxLength: 5000 type: string - $ref: '#/components/schemas/mandate' description: ID of the single_use Mandate generated by the SetupIntent. nullable: true x-expansionResources: oneOf: - $ref: '#/components/schemas/mandate' status: description: >- [Status](https://stripe.com/docs/payments/intents#intent-statuses) of this SetupIntent, one of `requires_payment_method`, `requires_confirmation`, `requires_action`, `processing`, `canceled`, or `succeeded`. enum: - canceled - processing - requires_action - requires_confirmation - requires_payment_method - succeeded type: string usage: description: >- Indicates how the payment method is intended to be used in the future. Use `on_session` if you intend to only reuse the payment method when the customer is in your checkout flow. Use `off_session` if your customer may or may not be in your checkout flow. If not provided, this value defaults to `off_session`. maxLength: 5000 type: string required: - created - id - livemode - object - payment_method_types - status - usage title: SetupIntent type: object x-expandableFields: - application - automatic_payment_methods - customer - last_setup_error - latest_attempt - mandate - next_action - on_behalf_of - payment_method - payment_method_configuration_details - payment_method_options - single_use_mandate x-resourceId: setup_intent setup_intent_next_action: description: '' properties: cashapp_handle_redirect_or_display_qr_code: $ref: >- #/components/schemas/payment_intent_next_action_cashapp_handle_redirect_or_display_qr_code redirect_to_url: $ref: '#/components/schemas/setup_intent_next_action_redirect_to_url' type: description: >- 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`. maxLength: 5000 type: string use_stripe_sdk: description: >- When confirming a SetupIntent with Stripe.js, Stripe.js depends on the contents of this dictionary to invoke authentication flows. The shape of the contents is subject to change and is only intended to be used by Stripe.js. type: object verify_with_microdeposits: $ref: >- #/components/schemas/setup_intent_next_action_verify_with_microdeposits required: - type title: SetupIntentNextAction type: object x-expandableFields: - cashapp_handle_redirect_or_display_qr_code - redirect_to_url - verify_with_microdeposits setup_intent_next_action_redirect_to_url: description: '' properties: return_url: description: >- If the customer does not exit their browser while authenticating, they will be redirected to this specified URL after completion. maxLength: 5000 nullable: true type: string url: description: The URL you must redirect your customer to in order to authenticate. maxLength: 5000 nullable: true type: string title: SetupIntentNextActionRedirectToUrl type: object x-expandableFields: [] setup_intent_next_action_verify_with_microdeposits: description: '' properties: arrival_date: description: The timestamp when the microdeposits are expected to land. format: unix-time type: integer hosted_verification_url: description: >- The URL for the hosted verification page, which allows customers to verify their bank account. maxLength: 5000 type: string microdeposit_type: description: >- The type of the microdeposit sent to the customer. Used to distinguish between different verification methods. enum: - amounts - descriptor_code nullable: true type: string required: - arrival_date - hosted_verification_url title: SetupIntentNextActionVerifyWithMicrodeposits type: object x-expandableFields: [] setup_intent_payment_method_options: description: '' properties: acss_debit: anyOf: - $ref: >- #/components/schemas/setup_intent_payment_method_options_acss_debit - $ref: >- #/components/schemas/setup_intent_type_specific_payment_method_options_client amazon_pay: anyOf: - $ref: >- #/components/schemas/setup_intent_payment_method_options_amazon_pay - $ref: >- #/components/schemas/setup_intent_type_specific_payment_method_options_client card: $ref: '#/components/schemas/setup_intent_payment_method_options_card' card_present: anyOf: - $ref: >- #/components/schemas/setup_intent_payment_method_options_card_present - $ref: >- #/components/schemas/setup_intent_type_specific_payment_method_options_client link: anyOf: - $ref: '#/components/schemas/setup_intent_payment_method_options_link' - $ref: >- #/components/schemas/setup_intent_type_specific_payment_method_options_client paypal: anyOf: - $ref: '#/components/schemas/setup_intent_payment_method_options_paypal' - $ref: >- #/components/schemas/setup_intent_type_specific_payment_method_options_client sepa_debit: anyOf: - $ref: >- #/components/schemas/setup_intent_payment_method_options_sepa_debit - $ref: >- #/components/schemas/setup_intent_type_specific_payment_method_options_client us_bank_account: anyOf: - $ref: >- #/components/schemas/setup_intent_payment_method_options_us_bank_account - $ref: >- #/components/schemas/setup_intent_type_specific_payment_method_options_client title: SetupIntentPaymentMethodOptions type: object x-expandableFields: - acss_debit - amazon_pay - card - card_present - link - paypal - sepa_debit - us_bank_account setup_intent_payment_method_options_acss_debit: description: '' properties: currency: description: Currency supported by the bank account enum: - cad - usd nullable: true type: string mandate_options: $ref: >- #/components/schemas/setup_intent_payment_method_options_mandate_options_acss_debit verification_method: description: Bank account verification method. enum: - automatic - instant - microdeposits type: string x-stripeBypassValidation: true title: setup_intent_payment_method_options_acss_debit type: object x-expandableFields: - mandate_options setup_intent_payment_method_options_amazon_pay: description: '' properties: {} title: setup_intent_payment_method_options_amazon_pay type: object x-expandableFields: [] setup_intent_payment_method_options_card: description: '' properties: mandate_options: anyOf: - $ref: >- #/components/schemas/setup_intent_payment_method_options_card_mandate_options description: >- Configuration options for setting up an eMandate for cards issued in India. nullable: true network: description: >- Selected network to process this SetupIntent on. Depends on the available networks of the card attached to the setup intent. Can be only set confirm-time. enum: - amex - cartes_bancaires - diners - discover - eftpos_au - interac - jcb - mastercard - unionpay - unknown - visa nullable: true type: string request_three_d_secure: description: >- We strongly recommend that you rely on our SCA Engine to automatically prompt your customers for authentication based on risk level and [other requirements](https://stripe.com/docs/strong-customer-authentication). However, if you wish to request 3D Secure based on logic from your own fraud engine, provide this option. If not provided, this value defaults to `automatic`. Read our guide on [manually requesting 3D Secure](https://stripe.com/docs/payments/3d-secure/authentication-flow#manual-three-ds) for more information on how this configuration interacts with Radar and our SCA Engine. enum: - any - automatic - challenge nullable: true type: string x-stripeBypassValidation: true title: setup_intent_payment_method_options_card type: object x-expandableFields: - mandate_options setup_intent_payment_method_options_card_mandate_options: description: '' properties: amount: description: Amount to be charged for future payments. type: integer amount_type: description: >- One of `fixed` or `maximum`. If `fixed`, the `amount` param refers to the exact amount to be charged in future payments. If `maximum`, the amount charged can be up to the value passed for the `amount` param. enum: - fixed - maximum type: string currency: description: >- 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). type: string description: description: >- A description of the mandate or subscription that is meant to be displayed to the customer. maxLength: 200 nullable: true type: string end_date: description: >- End date of the mandate or subscription. If not provided, the mandate will be active until canceled. If provided, end date should be after start date. format: unix-time nullable: true type: integer interval: description: >- Specifies payment frequency. One of `day`, `week`, `month`, `year`, or `sporadic`. enum: - day - month - sporadic - week - year type: string interval_count: description: >- The number of intervals between payments. For example, `interval=month` and `interval_count=3` indicates one payment every three months. Maximum of one year interval allowed (1 year, 12 months, or 52 weeks). This parameter is optional when `interval=sporadic`. nullable: true type: integer reference: description: Unique identifier for the mandate or subscription. maxLength: 80 type: string start_date: description: >- Start date of the mandate or subscription. Start date should not be lesser than yesterday. format: unix-time type: integer supported_types: description: >- Specifies the type of mandates supported. Possible values are `india`. items: enum: - india type: string nullable: true type: array required: - amount - amount_type - currency - interval - reference - start_date title: setup_intent_payment_method_options_card_mandate_options type: object x-expandableFields: [] setup_intent_payment_method_options_card_present: description: '' properties: {} title: setup_intent_payment_method_options_card_present type: object x-expandableFields: [] setup_intent_payment_method_options_link: description: '' properties: {} title: setup_intent_payment_method_options_link type: object x-expandableFields: [] setup_intent_payment_method_options_mandate_options_acss_debit: description: '' properties: custom_mandate_url: description: A URL for custom mandate text maxLength: 5000 type: string default_for: description: >- List of Stripe products where this mandate can be selected automatically. items: enum: - invoice - subscription type: string type: array interval_description: description: >- Description of the interval. Only required if the 'payment_schedule' parameter is 'interval' or 'combined'. maxLength: 5000 nullable: true type: string payment_schedule: description: Payment schedule for the mandate. enum: - combined - interval - sporadic nullable: true type: string transaction_type: description: Transaction type of the mandate. enum: - business - personal nullable: true type: string title: setup_intent_payment_method_options_mandate_options_acss_debit type: object x-expandableFields: [] setup_intent_payment_method_options_mandate_options_sepa_debit: description: '' properties: {} title: setup_intent_payment_method_options_mandate_options_sepa_debit type: object x-expandableFields: [] setup_intent_payment_method_options_paypal: description: '' properties: billing_agreement_id: description: >- The PayPal Billing Agreement ID (BAID). This is an ID generated by PayPal which represents the mandate between the merchant and the customer. maxLength: 5000 nullable: true type: string title: setup_intent_payment_method_options_paypal type: object x-expandableFields: [] setup_intent_payment_method_options_sepa_debit: description: '' properties: mandate_options: $ref: >- #/components/schemas/setup_intent_payment_method_options_mandate_options_sepa_debit title: setup_intent_payment_method_options_sepa_debit type: object x-expandableFields: - mandate_options setup_intent_payment_method_options_us_bank_account: description: '' properties: financial_connections: $ref: '#/components/schemas/linked_account_options_us_bank_account' mandate_options: $ref: >- #/components/schemas/payment_method_options_us_bank_account_mandate_options verification_method: description: Bank account verification method. enum: - automatic - instant - microdeposits type: string x-stripeBypassValidation: true title: setup_intent_payment_method_options_us_bank_account type: object x-expandableFields: - financial_connections - mandate_options setup_intent_type_specific_payment_method_options_client: description: '' properties: verification_method: description: Bank account verification method. enum: - automatic - instant - microdeposits type: string x-stripeBypassValidation: true title: SetupIntentTypeSpecificPaymentMethodOptionsClient type: object x-expandableFields: [] shipping: description: '' properties: address: $ref: '#/components/schemas/address' carrier: description: >- The delivery service that shipped a physical product, such as Fedex, UPS, USPS, etc. maxLength: 5000 nullable: true type: string name: description: Recipient name. maxLength: 5000 type: string phone: description: Recipient phone (including extension). maxLength: 5000 nullable: true type: string tracking_number: description: >- 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. maxLength: 5000 nullable: true type: string title: Shipping type: object x-expandableFields: - address shipping_rate: description: >- Shipping rates describe the price of shipping presented to your customers and applied to a purchase. For more information, see [Charge for shipping](https://stripe.com/docs/payments/during-payment/charge-shipping). properties: active: description: >- Whether the shipping rate can be used for new purchases. Defaults to `true`. type: boolean created: description: >- Time at which the object was created. Measured in seconds since the Unix epoch. format: unix-time type: integer delivery_estimate: anyOf: - $ref: '#/components/schemas/shipping_rate_delivery_estimate' description: >- The estimated range for how long shipping will take, meant to be displayable to the customer. This will appear on CheckoutSessions. nullable: true display_name: description: >- The name of the shipping rate, meant to be displayable to the customer. This will appear on CheckoutSessions. maxLength: 5000 nullable: true type: string fixed_amount: $ref: '#/components/schemas/shipping_rate_fixed_amount' id: description: Unique identifier for the object. maxLength: 5000 type: string livemode: description: >- Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. type: boolean metadata: additionalProperties: maxLength: 500 type: string description: >- 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. type: object object: description: >- String representing the object's type. Objects of the same type share the same value. enum: - shipping_rate type: string tax_behavior: description: >- Specifies whether the rate is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. enum: - exclusive - inclusive - unspecified nullable: true type: string tax_code: anyOf: - maxLength: 5000 type: string - $ref: '#/components/schemas/tax_code' description: >- A [tax code](https://stripe.com/docs/tax/tax-categories) ID. The Shipping tax code is `txcd_92010001`. nullable: true x-expansionResources: oneOf: - $ref: '#/components/schemas/tax_code' type: description: >- The type of calculation to use on the shipping rate. Can only be `fixed_amount` for now. enum: - fixed_amount type: string required: - active - created - id - livemode - metadata - object - type title: ShippingRate type: object x-expandableFields: - delivery_estimate - fixed_amount - tax_code x-resourceId: shipping_rate shipping_rate_currency_option: description: '' properties: amount: description: A non-negative integer in cents representing how much to charge. type: integer tax_behavior: description: >- Specifies whether the rate is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. enum: - exclusive - inclusive - unspecified type: string required: - amount - tax_behavior title: ShippingRateCurrencyOption type: object x-expandableFields: [] shipping_rate_delivery_estimate: description: '' properties: maximum: anyOf: - $ref: '#/components/schemas/shipping_rate_delivery_estimate_bound' description: >- The upper bound of the estimated range. If empty, represents no upper bound i.e., infinite. nullable: true minimum: anyOf: - $ref: '#/components/schemas/shipping_rate_delivery_estimate_bound' description: >- The lower bound of the estimated range. If empty, represents no lower bound. nullable: true title: ShippingRateDeliveryEstimate type: object x-expandableFields: - maximum - minimum shipping_rate_delivery_estimate_bound: description: '' properties: unit: description: A unit of time. enum: - business_day - day - hour - month - week type: string value: description: Must be greater than 0. type: integer required: - unit - value title: ShippingRateDeliveryEstimateBound type: object x-expandableFields: [] shipping_rate_fixed_amount: description: '' properties: amount: description: A non-negative integer in cents representing how much to charge. type: integer currency: description: >- 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). type: string currency_options: additionalProperties: $ref: '#/components/schemas/shipping_rate_currency_option' description: >- Shipping rates 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). type: object required: - amount - currency title: ShippingRateFixedAmount type: object x-expandableFields: - currency_options sigma_scheduled_query_run_error: description: '' properties: message: description: Information about the run failure. maxLength: 5000 type: string required: - message title: SigmaScheduledQueryRunError type: object x-expandableFields: [] source: description: >- `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). properties: ach_credit_transfer: $ref: '#/components/schemas/source_type_ach_credit_transfer' ach_debit: $ref: '#/components/schemas/source_type_ach_debit' acss_debit: $ref: '#/components/schemas/source_type_acss_debit' alipay: $ref: '#/components/schemas/source_type_alipay' amount: description: >- 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. nullable: true type: integer au_becs_debit: $ref: '#/components/schemas/source_type_au_becs_debit' bancontact: $ref: '#/components/schemas/source_type_bancontact' card: $ref: '#/components/schemas/source_type_card' card_present: $ref: '#/components/schemas/source_type_card_present' client_secret: description: >- The client secret of the source. Used for client-side retrieval using a publishable key. maxLength: 5000 type: string code_verification: $ref: '#/components/schemas/source_code_verification_flow' created: description: >- Time at which the object was created. Measured in seconds since the Unix epoch. format: unix-time type: integer currency: description: >- 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. nullable: true type: string customer: description: >- 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. maxLength: 5000 type: string eps: $ref: '#/components/schemas/source_type_eps' flow: description: >- The authentication `flow` of the source. `flow` is one of `redirect`, `receiver`, `code_verification`, `none`. maxLength: 5000 type: string giropay: $ref: '#/components/schemas/source_type_giropay' id: description: Unique identifier for the object. maxLength: 5000 type: string ideal: $ref: '#/components/schemas/source_type_ideal' klarna: $ref: '#/components/schemas/source_type_klarna' livemode: description: >- Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. type: boolean metadata: additionalProperties: maxLength: 500 type: string description: >- 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. nullable: true type: object multibanco: $ref: '#/components/schemas/source_type_multibanco' object: description: >- String representing the object's type. Objects of the same type share the same value. enum: - source type: string owner: anyOf: - $ref: '#/components/schemas/source_owner' description: >- Information about the owner of the payment instrument that may be used or required by particular source types. nullable: true p24: $ref: '#/components/schemas/source_type_p24' receiver: $ref: '#/components/schemas/source_receiver_flow' redirect: $ref: '#/components/schemas/source_redirect_flow' sepa_debit: $ref: '#/components/schemas/source_type_sepa_debit' sofort: $ref: '#/components/schemas/source_type_sofort' source_order: $ref: '#/components/schemas/source_order' statement_descriptor: description: >- Extra information about a source. This will appear on your customer's statement every time you charge the source. maxLength: 5000 nullable: true type: string status: description: >- The status of the source, one of `canceled`, `chargeable`, `consumed`, `failed`, or `pending`. Only `chargeable` sources can be used to create a charge. maxLength: 5000 type: string three_d_secure: $ref: '#/components/schemas/source_type_three_d_secure' type: description: >- 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. enum: - 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 type: string x-stripeBypassValidation: true usage: description: >- 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. maxLength: 5000 nullable: true type: string wechat: $ref: '#/components/schemas/source_type_wechat' required: - client_secret - created - flow - id - livemode - object - status - type title: Source type: object x-expandableFields: - code_verification - owner - receiver - redirect - source_order x-resourceId: source source_code_verification_flow: description: '' properties: attempts_remaining: description: >- The number of attempts remaining to authenticate the source object with a verification code. type: integer status: description: >- The status of the code verification, either `pending` (awaiting verification, `attempts_remaining` should be greater than 0), `succeeded` (successful verification) or `failed` (failed verification, cannot be verified anymore as `attempts_remaining` should be 0). maxLength: 5000 type: string required: - attempts_remaining - status title: SourceCodeVerificationFlow type: object x-expandableFields: [] source_mandate_notification: description: >- Source mandate notifications should be created when a notification related to a source mandate must be sent to the payer. They will trigger a webhook or deliver an email to the customer. properties: acss_debit: $ref: '#/components/schemas/source_mandate_notification_acss_debit_data' amount: description: >- 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 amount associated with the mandate notification. The amount is expressed in the currency of the underlying source. Required if the notification type is `debit_initiated`. nullable: true type: integer bacs_debit: $ref: '#/components/schemas/source_mandate_notification_bacs_debit_data' created: description: >- Time at which the object was created. Measured in seconds since the Unix epoch. format: unix-time type: integer id: description: Unique identifier for the object. maxLength: 5000 type: string livemode: description: >- Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. type: boolean object: description: >- String representing the object's type. Objects of the same type share the same value. enum: - source_mandate_notification type: string reason: description: >- The reason of the mandate notification. Valid reasons are `mandate_confirmed` or `debit_initiated`. maxLength: 5000 type: string sepa_debit: $ref: '#/components/schemas/source_mandate_notification_sepa_debit_data' source: $ref: '#/components/schemas/source' status: description: >- The status of the mandate notification. Valid statuses are `pending` or `submitted`. maxLength: 5000 type: string type: description: >- The type of source this mandate notification is attached to. Should be the source type identifier code for the payment method, such as `three_d_secure`. maxLength: 5000 type: string required: - created - id - livemode - object - reason - source - status - type title: SourceMandateNotification type: object x-expandableFields: - acss_debit - bacs_debit - sepa_debit - source x-resourceId: source_mandate_notification source_mandate_notification_acss_debit_data: description: '' properties: statement_descriptor: description: The statement descriptor associate with the debit. maxLength: 5000 type: string title: SourceMandateNotificationAcssDebitData type: object x-expandableFields: [] source_mandate_notification_bacs_debit_data: description: '' properties: last4: description: Last 4 digits of the account number associated with the debit. maxLength: 5000 type: string title: SourceMandateNotificationBacsDebitData type: object x-expandableFields: [] source_mandate_notification_sepa_debit_data: description: '' properties: creditor_identifier: description: SEPA creditor ID. maxLength: 5000 type: string last4: description: Last 4 digits of the account number associated with the debit. maxLength: 5000 type: string mandate_reference: description: Mandate reference associated with the debit. maxLength: 5000 type: string title: SourceMandateNotificationSepaDebitData type: object x-expandableFields: [] source_order: description: '' properties: amount: description: >- A positive integer in the smallest currency unit (that is, 100 cents for $1.00, or 1 for ¥1, Japanese Yen being a zero-decimal currency) representing the total amount for the order. type: integer currency: description: >- 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). type: string email: description: The email address of the customer placing the order. maxLength: 5000 type: string items: description: List of items constituting the order. items: $ref: '#/components/schemas/source_order_item' nullable: true type: array shipping: $ref: '#/components/schemas/shipping' required: - amount - currency title: SourceOrder type: object x-expandableFields: - items - shipping source_order_item: description: '' properties: amount: description: The amount (price) for this order item. nullable: true type: integer currency: description: This currency of this order item. Required when `amount` is present. maxLength: 5000 nullable: true type: string description: description: Human-readable description for this order item. maxLength: 5000 nullable: true type: string parent: description: >- The ID of the associated object for this line item. Expandable if not null (e.g., expandable to a SKU). maxLength: 5000 nullable: true type: string quantity: description: >- The quantity of this order item. When type is `sku`, this is the number of instances of the SKU to be ordered. type: integer type: description: 'The type of this order item. Must be `sku`, `tax`, or `shipping`.' maxLength: 5000 nullable: true type: string title: SourceOrderItem type: object x-expandableFields: [] source_owner: description: '' properties: address: anyOf: - $ref: '#/components/schemas/address' description: Owner's address. nullable: true email: description: Owner's email address. maxLength: 5000 nullable: true type: string name: description: Owner's full name. maxLength: 5000 nullable: true type: string phone: description: Owner's phone number (including extension). maxLength: 5000 nullable: true type: string verified_address: anyOf: - $ref: '#/components/schemas/address' description: >- Verified owner's address. Verified values are verified or provided by the payment method directly (and if supported) at the time of authorization or settlement. They cannot be set or mutated. nullable: true verified_email: description: >- Verified owner's email address. Verified values are verified or provided by the payment method directly (and if supported) at the time of authorization or settlement. They cannot be set or mutated. maxLength: 5000 nullable: true type: string verified_name: description: >- Verified owner's full name. Verified values are verified or provided by the payment method directly (and if supported) at the time of authorization or settlement. They cannot be set or mutated. maxLength: 5000 nullable: true type: string verified_phone: description: >- Verified owner's phone number (including extension). Verified values are verified or provided by the payment method directly (and if supported) at the time of authorization or settlement. They cannot be set or mutated. maxLength: 5000 nullable: true type: string title: SourceOwner type: object x-expandableFields: - address - verified_address source_receiver_flow: description: '' properties: address: description: >- The address of the receiver source. This is the value that should be communicated to the customer to send their funds to. maxLength: 5000 nullable: true type: string amount_charged: description: >- The total amount that was moved to your balance. This is almost always equal to the amount charged. In rare cases when customers deposit excess funds and we are unable to refund those, those funds get moved to your balance and show up in amount_charged as well. The amount charged is expressed in the source's currency. type: integer amount_received: description: >- The total amount received by the receiver source. `amount_received = amount_returned + amount_charged` should be true for consumed sources unless customers deposit excess funds. The amount received is expressed in the source's currency. type: integer amount_returned: description: >- The total amount that was returned to the customer. The amount returned is expressed in the source's currency. type: integer refund_attributes_method: description: >- Type of refund attribute method, one of `email`, `manual`, or `none`. maxLength: 5000 type: string refund_attributes_status: description: >- Type of refund attribute status, one of `missing`, `requested`, or `available`. maxLength: 5000 type: string required: - amount_charged - amount_received - amount_returned - refund_attributes_method - refund_attributes_status title: SourceReceiverFlow type: object x-expandableFields: [] source_redirect_flow: description: '' properties: failure_reason: description: >- The failure reason for the redirect, either `user_abort` (the customer aborted or dropped out of the redirect flow), `declined` (the authentication failed or the transaction was declined), or `processing_error` (the redirect failed due to a technical error). Present only if the redirect status is `failed`. maxLength: 5000 nullable: true type: string return_url: description: >- The URL you provide to redirect the customer to after they authenticated their payment. maxLength: 5000 type: string status: description: >- The status of the redirect, either `pending` (ready to be used by your customer to authenticate the transaction), `succeeded` (succesful authentication, cannot be reused) or `not_required` (redirect should not be used) or `failed` (failed authentication, cannot be reused). maxLength: 5000 type: string url: description: >- The URL provided to you to redirect a customer to as part of a `redirect` authentication flow. maxLength: 2048 type: string required: - return_url - status - url title: SourceRedirectFlow type: object x-expandableFields: [] source_transaction: description: |- Some payment methods have no required amount that a customer must send. Customers can be instructed to send any amount, and it can be made up of multiple transactions. As such, sources can have multiple associated transactions. properties: ach_credit_transfer: $ref: '#/components/schemas/source_transaction_ach_credit_transfer_data' amount: description: >- 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 amount your customer has pushed to the receiver. type: integer chf_credit_transfer: $ref: '#/components/schemas/source_transaction_chf_credit_transfer_data' created: description: >- Time at which the object was created. Measured in seconds since the Unix epoch. format: unix-time type: integer currency: description: >- 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). type: string gbp_credit_transfer: $ref: '#/components/schemas/source_transaction_gbp_credit_transfer_data' id: description: Unique identifier for the object. maxLength: 5000 type: string livemode: description: >- Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. type: boolean object: description: >- String representing the object's type. Objects of the same type share the same value. enum: - source_transaction type: string paper_check: $ref: '#/components/schemas/source_transaction_paper_check_data' sepa_credit_transfer: $ref: '#/components/schemas/source_transaction_sepa_credit_transfer_data' source: description: The ID of the source this transaction is attached to. maxLength: 5000 type: string status: description: >- The status of the transaction, one of `succeeded`, `pending`, or `failed`. maxLength: 5000 type: string type: description: The type of source this transaction is attached to. enum: - ach_credit_transfer - ach_debit - alipay - bancontact - card - card_present - eps - giropay - ideal - klarna - multibanco - p24 - sepa_debit - sofort - three_d_secure - wechat type: string required: - amount - created - currency - id - livemode - object - source - status - type title: SourceTransaction type: object x-expandableFields: - ach_credit_transfer - chf_credit_transfer - gbp_credit_transfer - paper_check - sepa_credit_transfer x-resourceId: source_transaction source_transaction_ach_credit_transfer_data: description: '' properties: customer_data: description: Customer data associated with the transfer. maxLength: 5000 type: string fingerprint: description: Bank account fingerprint associated with the transfer. maxLength: 5000 type: string last4: description: Last 4 digits of the account number associated with the transfer. maxLength: 5000 type: string routing_number: description: Routing number associated with the transfer. maxLength: 5000 type: string title: SourceTransactionAchCreditTransferData type: object x-expandableFields: [] source_transaction_chf_credit_transfer_data: description: '' properties: reference: description: Reference associated with the transfer. maxLength: 5000 type: string sender_address_country: description: Sender's country address. maxLength: 5000 type: string sender_address_line1: description: Sender's line 1 address. maxLength: 5000 type: string sender_iban: description: Sender's bank account IBAN. maxLength: 5000 type: string sender_name: description: Sender's name. maxLength: 5000 type: string title: SourceTransactionChfCreditTransferData type: object x-expandableFields: [] source_transaction_gbp_credit_transfer_data: description: '' properties: fingerprint: description: >- Bank account fingerprint associated with the Stripe owned bank account receiving the transfer. maxLength: 5000 type: string funding_method: description: >- The credit transfer rails the sender used to push this transfer. The possible rails are: Faster Payments, BACS, CHAPS, and wire transfers. Currently only Faster Payments is supported. maxLength: 5000 type: string last4: description: Last 4 digits of sender account number associated with the transfer. maxLength: 5000 type: string reference: description: Sender entered arbitrary information about the transfer. maxLength: 5000 type: string sender_account_number: description: Sender account number associated with the transfer. maxLength: 5000 type: string sender_name: description: Sender name associated with the transfer. maxLength: 5000 type: string sender_sort_code: description: Sender sort code associated with the transfer. maxLength: 5000 type: string title: SourceTransactionGbpCreditTransferData type: object x-expandableFields: [] source_transaction_paper_check_data: description: '' properties: available_at: description: >- Time at which the deposited funds will be available for use. Measured in seconds since the Unix epoch. maxLength: 5000 type: string invoices: description: Comma-separated list of invoice IDs associated with the paper check. maxLength: 5000 type: string title: SourceTransactionPaperCheckData type: object x-expandableFields: [] source_transaction_sepa_credit_transfer_data: description: '' properties: reference: description: Reference associated with the transfer. maxLength: 5000 type: string sender_iban: description: Sender's bank account IBAN. maxLength: 5000 type: string sender_name: description: Sender's name. maxLength: 5000 type: string title: SourceTransactionSepaCreditTransferData type: object x-expandableFields: [] source_type_ach_credit_transfer: properties: account_number: nullable: true type: string bank_name: nullable: true type: string fingerprint: nullable: true type: string refund_account_holder_name: nullable: true type: string refund_account_holder_type: nullable: true type: string refund_routing_number: nullable: true type: string routing_number: nullable: true type: string swift_code: nullable: true type: string type: object source_type_ach_debit: properties: bank_name: nullable: true type: string country: nullable: true type: string fingerprint: nullable: true type: string last4: nullable: true type: string routing_number: nullable: true type: string type: nullable: true type: string type: object source_type_acss_debit: properties: bank_address_city: nullable: true type: string bank_address_line_1: nullable: true type: string bank_address_line_2: nullable: true type: string bank_address_postal_code: nullable: true type: string bank_name: nullable: true type: string category: nullable: true type: string country: nullable: true type: string fingerprint: nullable: true type: string last4: nullable: true type: string routing_number: nullable: true type: string type: object source_type_alipay: properties: data_string: nullable: true type: string native_url: nullable: true type: string statement_descriptor: nullable: true type: string type: object source_type_au_becs_debit: properties: bsb_number: nullable: true type: string fingerprint: nullable: true type: string last4: nullable: true type: string type: object source_type_bancontact: properties: bank_code: nullable: true type: string bank_name: nullable: true type: string bic: nullable: true type: string iban_last4: nullable: true type: string preferred_language: nullable: true type: string statement_descriptor: nullable: true type: string type: object source_type_card: properties: address_line1_check: nullable: true type: string address_zip_check: nullable: true type: string brand: nullable: true type: string country: nullable: true type: string cvc_check: nullable: true type: string dynamic_last4: nullable: true type: string exp_month: nullable: true type: integer exp_year: nullable: true type: integer fingerprint: type: string funding: nullable: true type: string last4: nullable: true type: string name: nullable: true type: string three_d_secure: type: string tokenization_method: nullable: true type: string type: object source_type_card_present: properties: application_cryptogram: type: string application_preferred_name: type: string authorization_code: nullable: true type: string authorization_response_code: type: string brand: nullable: true type: string country: nullable: true type: string cvm_type: type: string data_type: nullable: true type: string dedicated_file_name: type: string emv_auth_data: type: string evidence_customer_signature: nullable: true type: string evidence_transaction_certificate: nullable: true type: string exp_month: nullable: true type: integer exp_year: nullable: true type: integer fingerprint: type: string funding: nullable: true type: string last4: nullable: true type: string pos_device_id: nullable: true type: string pos_entry_mode: type: string read_method: nullable: true type: string reader: nullable: true type: string terminal_verification_results: type: string transaction_status_information: type: string type: object source_type_eps: properties: reference: nullable: true type: string statement_descriptor: nullable: true type: string type: object source_type_giropay: properties: bank_code: nullable: true type: string bank_name: nullable: true type: string bic: nullable: true type: string statement_descriptor: nullable: true type: string type: object source_type_ideal: properties: bank: nullable: true type: string bic: nullable: true type: string iban_last4: nullable: true type: string statement_descriptor: nullable: true type: string type: object source_type_klarna: properties: background_image_url: type: string client_token: nullable: true type: string first_name: type: string last_name: type: string locale: type: string logo_url: type: string page_title: type: string pay_later_asset_urls_descriptive: type: string pay_later_asset_urls_standard: type: string pay_later_name: type: string pay_later_redirect_url: type: string pay_now_asset_urls_descriptive: type: string pay_now_asset_urls_standard: type: string pay_now_name: type: string pay_now_redirect_url: type: string pay_over_time_asset_urls_descriptive: type: string pay_over_time_asset_urls_standard: type: string pay_over_time_name: type: string pay_over_time_redirect_url: type: string payment_method_categories: type: string purchase_country: type: string purchase_type: type: string redirect_url: type: string shipping_delay: type: integer shipping_first_name: type: string shipping_last_name: type: string type: object source_type_multibanco: properties: entity: nullable: true type: string reference: nullable: true type: string refund_account_holder_address_city: nullable: true type: string refund_account_holder_address_country: nullable: true type: string refund_account_holder_address_line1: nullable: true type: string refund_account_holder_address_line2: nullable: true type: string refund_account_holder_address_postal_code: nullable: true type: string refund_account_holder_address_state: nullable: true type: string refund_account_holder_name: nullable: true type: string refund_iban: nullable: true type: string type: object source_type_p24: properties: reference: nullable: true type: string type: object source_type_sepa_debit: properties: bank_code: nullable: true type: string branch_code: nullable: true type: string country: nullable: true type: string fingerprint: nullable: true type: string last4: nullable: true type: string mandate_reference: nullable: true type: string mandate_url: nullable: true type: string type: object source_type_sofort: properties: bank_code: nullable: true type: string bank_name: nullable: true type: string bic: nullable: true type: string country: nullable: true type: string iban_last4: nullable: true type: string preferred_language: nullable: true type: string statement_descriptor: nullable: true type: string type: object source_type_three_d_secure: properties: address_line1_check: nullable: true type: string address_zip_check: nullable: true type: string authenticated: nullable: true type: boolean brand: nullable: true type: string card: nullable: true type: string country: nullable: true type: string customer: nullable: true type: string cvc_check: nullable: true type: string dynamic_last4: nullable: true type: string exp_month: nullable: true type: integer exp_year: nullable: true type: integer fingerprint: type: string funding: nullable: true type: string last4: nullable: true type: string name: nullable: true type: string three_d_secure: type: string tokenization_method: nullable: true type: string type: object source_type_wechat: properties: prepay_id: type: string qr_code_url: nullable: true type: string statement_descriptor: type: string type: object subscription: description: >- Subscriptions allow you to charge a customer on a recurring basis. Related guide: [Creating subscriptions](https://stripe.com/docs/billing/subscriptions/creating) properties: application: anyOf: - maxLength: 5000 type: string - $ref: '#/components/schemas/application' - $ref: '#/components/schemas/deleted_application' description: ID of the Connect Application that created the subscription. nullable: true x-expansionResources: oneOf: - $ref: '#/components/schemas/application' - $ref: '#/components/schemas/deleted_application' application_fee_percent: description: >- 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. nullable: true type: number automatic_tax: $ref: '#/components/schemas/subscription_automatic_tax' billing_cycle_anchor: description: >- 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. format: unix-time type: integer billing_cycle_anchor_config: anyOf: - $ref: >- #/components/schemas/subscriptions_resource_billing_cycle_anchor_config description: The fixed values used to calculate the `billing_cycle_anchor`. nullable: true billing_thresholds: anyOf: - $ref: '#/components/schemas/subscription_billing_thresholds' description: >- Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period nullable: true cancel_at: description: >- A date in the future at which the subscription will automatically get canceled format: unix-time nullable: true type: integer cancel_at_period_end: description: >- If the subscription has been canceled with the `at_period_end` flag set to `true`, `cancel_at_period_end` on the subscription will be true. You can use this attribute to determine whether a subscription that has a status of active is scheduled to be canceled at the end of the current period. type: boolean canceled_at: description: >- 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. format: unix-time nullable: true type: integer cancellation_details: anyOf: - $ref: '#/components/schemas/cancellation_details' description: Details about why this subscription was cancelled nullable: true collection_method: description: >- 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`. enum: - charge_automatically - send_invoice type: string created: description: >- Time at which the object was created. Measured in seconds since the Unix epoch. format: unix-time type: integer currency: description: >- 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). type: string current_period_end: description: >- End of the current period that the subscription has been invoiced for. At the end of this period, a new invoice will be created. format: unix-time type: integer current_period_start: description: >- Start of the current period that the subscription has been invoiced for. format: unix-time type: integer customer: anyOf: - maxLength: 5000 type: string - $ref: '#/components/schemas/customer' - $ref: '#/components/schemas/deleted_customer' description: ID of the customer who owns the subscription. x-expansionResources: oneOf: - $ref: '#/components/schemas/customer' - $ref: '#/components/schemas/deleted_customer' days_until_due: description: >- 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`. nullable: true type: integer default_payment_method: anyOf: - maxLength: 5000 type: string - $ref: '#/components/schemas/payment_method' description: >- 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). nullable: true x-expansionResources: oneOf: - $ref: '#/components/schemas/payment_method' default_source: anyOf: - maxLength: 5000 type: string - $ref: '#/components/schemas/bank_account' - $ref: '#/components/schemas/card' - $ref: '#/components/schemas/source' description: >- 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). nullable: true x-expansionResources: oneOf: - $ref: '#/components/schemas/bank_account' - $ref: '#/components/schemas/card' - $ref: '#/components/schemas/source' x-stripeBypassValidation: true default_tax_rates: description: >- 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. items: $ref: '#/components/schemas/tax_rate' nullable: true type: array description: description: >- 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. maxLength: 500 nullable: true type: string discount: anyOf: - $ref: '#/components/schemas/discount' description: >- Describes the current discount applied to this subscription, if there is one. When billing, a discount applied to a subscription overrides a discount applied on a customer-wide basis. This field has been deprecated and will be removed in a future API version. Use `discounts` instead. nullable: true discounts: description: >- The discounts applied to the subscription. Subscription item discounts are applied before subscription discounts. Use `expand[]=discounts` to expand each discount. items: anyOf: - maxLength: 5000 type: string - $ref: '#/components/schemas/discount' x-expansionResources: oneOf: - $ref: '#/components/schemas/discount' type: array ended_at: description: 'If the subscription has ended, the date the subscription ended.' format: unix-time nullable: true type: integer id: description: Unique identifier for the object. maxLength: 5000 type: string items: description: 'List of subscription items, each with an attached price.' properties: data: description: Details about each object. items: $ref: '#/components/schemas/subscription_item' type: array has_more: description: >- True if this list has another page of items after this one that can be fetched. type: boolean object: description: >- String representing the object's type. Objects of the same type share the same value. Always has the value `list`. enum: - list type: string url: description: The URL where this list can be accessed. maxLength: 5000 type: string required: - data - has_more - object - url title: SubscriptionItemList type: object x-expandableFields: - data latest_invoice: anyOf: - maxLength: 5000 type: string - $ref: '#/components/schemas/invoice' description: The most recent invoice this subscription has generated. nullable: true x-expansionResources: oneOf: - $ref: '#/components/schemas/invoice' livemode: description: >- Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. type: boolean metadata: additionalProperties: maxLength: 500 type: string description: >- 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. type: object next_pending_invoice_item_invoice: description: >- Specifies the approximate timestamp on which any pending invoice items will be billed according to the schedule provided at `pending_invoice_item_interval`. format: unix-time nullable: true type: integer object: description: >- String representing the object's type. Objects of the same type share the same value. enum: - subscription type: string on_behalf_of: anyOf: - maxLength: 5000 type: string - $ref: '#/components/schemas/account' description: >- The account (if any) the charge was made on behalf of for charges associated with this subscription. See the Connect documentation for details. nullable: true x-expansionResources: oneOf: - $ref: '#/components/schemas/account' pause_collection: anyOf: - $ref: '#/components/schemas/subscriptions_resource_pause_collection' description: >- If specified, payment collection for this subscription will be paused. Note that the subscription status will be unchanged and will not be updated to `paused`. Learn more about [pausing collection](/billing/subscriptions/pause-payment). nullable: true payment_settings: anyOf: - $ref: '#/components/schemas/subscriptions_resource_payment_settings' description: Payment settings passed on to invoices created by the subscription. nullable: true pending_invoice_item_interval: anyOf: - $ref: '#/components/schemas/subscription_pending_invoice_item_interval' description: >- Specifies an interval for how often to bill for any pending invoice items. It is analogous to calling [Create an invoice](https://stripe.com/docs/api#create_invoice) for the given subscription at the specified interval. nullable: true pending_setup_intent: anyOf: - maxLength: 5000 type: string - $ref: '#/components/schemas/setup_intent' description: >- 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). nullable: true x-expansionResources: oneOf: - $ref: '#/components/schemas/setup_intent' pending_update: anyOf: - $ref: '#/components/schemas/subscriptions_resource_pending_update' description: >- If specified, [pending updates](https://stripe.com/docs/billing/subscriptions/pending-updates) that will be applied to the subscription once the `latest_invoice` has been paid. nullable: true schedule: anyOf: - maxLength: 5000 type: string - $ref: '#/components/schemas/subscription_schedule' description: The schedule attached to the subscription nullable: true x-expansionResources: oneOf: - $ref: '#/components/schemas/subscription_schedule' start_date: description: >- Date when the subscription was first created. The date might differ from the `created` date due to backdating. format: unix-time type: integer status: description: >- 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](/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](/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. enum: - active - canceled - incomplete - incomplete_expired - past_due - paused - trialing - unpaid type: string test_clock: anyOf: - maxLength: 5000 type: string - $ref: '#/components/schemas/test_helpers.test_clock' description: ID of the test clock this subscription belongs to. nullable: true x-expansionResources: oneOf: - $ref: '#/components/schemas/test_helpers.test_clock' transfer_data: anyOf: - $ref: '#/components/schemas/subscription_transfer_data' description: >- The account (if any) the subscription's payments will be attributed to for tax reporting, and where funds from each payment will be transferred to for each of the subscription's invoices. nullable: true trial_end: description: 'If the subscription has a trial, the end of that trial.' format: unix-time nullable: true type: integer trial_settings: anyOf: - $ref: >- #/components/schemas/subscriptions_trials_resource_trial_settings description: Settings related to subscription trials. nullable: true trial_start: description: 'If the subscription has a trial, the beginning of that trial.' format: unix-time nullable: true type: integer required: - automatic_tax - billing_cycle_anchor - cancel_at_period_end - collection_method - created - currency - current_period_end - current_period_start - customer - discounts - id - items - livemode - metadata - object - start_date - status title: Subscription type: object x-expandableFields: - application - automatic_tax - billing_cycle_anchor_config - billing_thresholds - cancellation_details - customer - default_payment_method - default_source - default_tax_rates - discount - discounts - items - latest_invoice - on_behalf_of - pause_collection - payment_settings - pending_invoice_item_interval - pending_setup_intent - pending_update - schedule - test_clock - transfer_data - trial_settings x-resourceId: subscription subscription_automatic_tax: description: '' properties: enabled: description: Whether Stripe automatically computes tax on this subscription. type: boolean liability: anyOf: - $ref: '#/components/schemas/connect_account_reference' description: >- The account that's liable for tax. If set, the business address and tax registrations required to perform the tax calculation are loaded from this account. The tax transaction is returned in the report of the connected account. nullable: true required: - enabled title: SubscriptionAutomaticTax type: object x-expandableFields: - liability subscription_billing_thresholds: description: '' properties: amount_gte: description: >- Monetary threshold that triggers the subscription to create an invoice nullable: true type: integer reset_billing_cycle_anchor: description: >- Indicates if the `billing_cycle_anchor` should be reset when a threshold is reached. If true, `billing_cycle_anchor` will be updated to the date/time the threshold was last reached; otherwise, the value will remain unchanged. This value may not be `true` if the subscription contains items with plans that have `aggregate_usage=last_ever`. nullable: true type: boolean title: SubscriptionBillingThresholds type: object x-expandableFields: [] subscription_details_data: description: '' properties: metadata: additionalProperties: maxLength: 500 type: string description: >- Set of [key-value pairs](https://stripe.com/docs/api/metadata) defined as subscription metadata when an invoice is created. Becomes an immutable snapshot of the subscription metadata at the time of invoice finalization. *Note: This attribute is populated only for invoices created on or after June 29, 2023.* nullable: true type: object title: SubscriptionDetailsData type: object x-expandableFields: [] subscription_item: description: >- Subscription items allow you to create customer subscriptions with more than one plan, making it easy to represent complex billing relationships. properties: billing_thresholds: anyOf: - $ref: '#/components/schemas/subscription_item_billing_thresholds' description: >- Define thresholds at which an invoice will be sent, and the related subscription advanced to a new billing period nullable: true created: description: >- Time at which the object was created. Measured in seconds since the Unix epoch. type: integer discounts: description: >- The discounts applied to the subscription item. Subscription item discounts are applied before subscription discounts. Use `expand[]=discounts` to expand each discount. items: anyOf: - maxLength: 5000 type: string - $ref: '#/components/schemas/discount' x-expansionResources: oneOf: - $ref: '#/components/schemas/discount' type: array id: description: Unique identifier for the object. maxLength: 5000 type: string metadata: additionalProperties: maxLength: 500 type: string description: >- 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. type: object object: description: >- String representing the object's type. Objects of the same type share the same value. enum: - subscription_item type: string price: $ref: '#/components/schemas/price' quantity: description: >- The [quantity](https://stripe.com/docs/subscriptions/quantities) of the plan to which the customer should be subscribed. type: integer subscription: description: The `subscription` this `subscription_item` belongs to. maxLength: 5000 type: string tax_rates: description: >- The tax rates which apply to this `subscription_item`. When set, the `default_tax_rates` on the subscription do not apply to this `subscription_item`. items: $ref: '#/components/schemas/tax_rate' nullable: true type: array required: - created - discounts - id - metadata - object - price - subscription title: SubscriptionItem type: object x-expandableFields: - billing_thresholds - discounts - price - tax_rates x-resourceId: subscription_item subscription_item_billing_thresholds: description: '' properties: usage_gte: description: Usage threshold that triggers the subscription to create an invoice nullable: true type: integer title: SubscriptionItemBillingThresholds type: object x-expandableFields: [] subscription_payment_method_options_card: description: '' properties: mandate_options: $ref: '#/components/schemas/invoice_mandate_options_card' network: description: >- Selected network to process this Subscription on. Depends on the available networks of the card attached to the Subscription. Can be only set confirm-time. enum: - amex - cartes_bancaires - diners - discover - eftpos_au - interac - jcb - mastercard - unionpay - unknown - visa nullable: true type: string request_three_d_secure: description: >- We strongly recommend that you rely on our SCA Engine to automatically prompt your customers for authentication based on risk level and [other requirements](https://stripe.com/docs/strong-customer-authentication). However, if you wish to request 3D Secure based on logic from your own fraud engine, provide this option. Read our guide on [manually requesting 3D Secure](https://stripe.com/docs/payments/3d-secure/authentication-flow#manual-three-ds) for more information on how this configuration interacts with Radar and our SCA Engine. enum: - any - automatic - challenge nullable: true type: string title: subscription_payment_method_options_card type: object x-expandableFields: - mandate_options subscription_pending_invoice_item_interval: description: '' properties: interval: description: >- Specifies invoicing frequency. Either `day`, `week`, `month` or `year`. enum: - day - month - week - year type: string interval_count: description: >- The number of intervals between invoices. For example, `interval=month` and `interval_count=3` bills every 3 months. Maximum of one year interval allowed (1 year, 12 months, or 52 weeks). type: integer required: - interval - interval_count title: SubscriptionPendingInvoiceItemInterval type: object x-expandableFields: [] subscription_schedule: description: >- A subscription schedule allows you to create and manage the lifecycle of a subscription by predefining expected changes. Related guide: [Subscription schedules](https://stripe.com/docs/billing/subscriptions/subscription-schedules) properties: application: anyOf: - maxLength: 5000 type: string - $ref: '#/components/schemas/application' - $ref: '#/components/schemas/deleted_application' description: ID of the Connect Application that created the schedule. nullable: true x-expansionResources: oneOf: - $ref: '#/components/schemas/application' - $ref: '#/components/schemas/deleted_application' canceled_at: description: >- Time at which the subscription schedule was canceled. Measured in seconds since the Unix epoch. format: unix-time nullable: true type: integer completed_at: description: >- Time at which the subscription schedule was completed. Measured in seconds since the Unix epoch. format: unix-time nullable: true type: integer created: description: >- Time at which the object was created. Measured in seconds since the Unix epoch. format: unix-time type: integer current_phase: anyOf: - $ref: '#/components/schemas/subscription_schedule_current_phase' description: >- Object representing the start and end dates for the current phase of the subscription schedule, if it is `active`. nullable: true customer: anyOf: - maxLength: 5000 type: string - $ref: '#/components/schemas/customer' - $ref: '#/components/schemas/deleted_customer' description: ID of the customer who owns the subscription schedule. x-expansionResources: oneOf: - $ref: '#/components/schemas/customer' - $ref: '#/components/schemas/deleted_customer' default_settings: $ref: >- #/components/schemas/subscription_schedules_resource_default_settings end_behavior: description: >- Behavior of the subscription schedule and underlying subscription when it ends. Possible values are `release` or `cancel` with the default being `release`. `release` will end the subscription schedule and keep the underlying subscription running. `cancel` will end the subscription schedule and cancel the underlying subscription. enum: - cancel - none - release - renew type: string id: description: Unique identifier for the object. maxLength: 5000 type: string livemode: description: >- Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. type: boolean metadata: additionalProperties: maxLength: 500 type: string description: >- 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. nullable: true type: object object: description: >- String representing the object's type. Objects of the same type share the same value. enum: - subscription_schedule type: string phases: description: Configuration for the subscription schedule's phases. items: $ref: '#/components/schemas/subscription_schedule_phase_configuration' type: array released_at: description: >- Time at which the subscription schedule was released. Measured in seconds since the Unix epoch. format: unix-time nullable: true type: integer released_subscription: description: >- ID of the subscription once managed by the subscription schedule (if it is released). maxLength: 5000 nullable: true type: string status: description: >- The present status of the subscription schedule. Possible values are `not_started`, `active`, `completed`, `released`, and `canceled`. You can read more about the different states in our [behavior guide](https://stripe.com/docs/billing/subscriptions/subscription-schedules). enum: - active - canceled - completed - not_started - released type: string subscription: anyOf: - maxLength: 5000 type: string - $ref: '#/components/schemas/subscription' description: ID of the subscription managed by the subscription schedule. nullable: true x-expansionResources: oneOf: - $ref: '#/components/schemas/subscription' test_clock: anyOf: - maxLength: 5000 type: string - $ref: '#/components/schemas/test_helpers.test_clock' description: ID of the test clock this subscription schedule belongs to. nullable: true x-expansionResources: oneOf: - $ref: '#/components/schemas/test_helpers.test_clock' required: - created - customer - default_settings - end_behavior - id - livemode - object - phases - status title: SubscriptionSchedule type: object x-expandableFields: - application - current_phase - customer - default_settings - phases - subscription - test_clock x-resourceId: subscription_schedule subscription_schedule_add_invoice_item: description: >- An Add Invoice Item describes the prices and quantities that will be added as pending invoice items when entering a phase. properties: discounts: description: The stackable discounts that will be applied to the item. items: $ref: '#/components/schemas/discounts_resource_stackable_discount' type: array price: anyOf: - maxLength: 5000 type: string - $ref: '#/components/schemas/price' - $ref: '#/components/schemas/deleted_price' description: ID of the price used to generate the invoice item. x-expansionResources: oneOf: - $ref: '#/components/schemas/price' - $ref: '#/components/schemas/deleted_price' quantity: description: The quantity of the invoice item. nullable: true type: integer tax_rates: description: >- The tax rates which apply to the item. When set, the `default_tax_rates` do not apply to this item. items: $ref: '#/components/schemas/tax_rate' nullable: true type: array required: - discounts - price title: SubscriptionScheduleAddInvoiceItem type: object x-expandableFields: - discounts - price - tax_rates subscription_schedule_configuration_item: description: A phase item describes the price and quantity of a phase. properties: billing_thresholds: anyOf: - $ref: '#/components/schemas/subscription_item_billing_thresholds' description: >- Define thresholds at which an invoice will be sent, and the related subscription advanced to a new billing period nullable: true discounts: description: >- The discounts applied to the subscription item. Subscription item discounts are applied before subscription discounts. Use `expand[]=discounts` to expand each discount. items: $ref: '#/components/schemas/discounts_resource_stackable_discount' type: array metadata: additionalProperties: maxLength: 500 type: string description: >- Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an item. Metadata on this item will update the underlying subscription item's `metadata` when the phase is entered. nullable: true type: object price: anyOf: - maxLength: 5000 type: string - $ref: '#/components/schemas/price' - $ref: '#/components/schemas/deleted_price' description: ID of the price to which the customer should be subscribed. x-expansionResources: oneOf: - $ref: '#/components/schemas/price' - $ref: '#/components/schemas/deleted_price' quantity: description: Quantity of the plan to which the customer should be subscribed. type: integer tax_rates: description: >- The tax rates which apply to this `phase_item`. When set, the `default_tax_rates` on the phase do not apply to this `phase_item`. items: $ref: '#/components/schemas/tax_rate' nullable: true type: array required: - discounts - price title: SubscriptionScheduleConfigurationItem type: object x-expandableFields: - billing_thresholds - discounts - price - tax_rates subscription_schedule_current_phase: description: '' properties: end_date: description: The end of this phase of the subscription schedule. format: unix-time type: integer start_date: description: The start of this phase of the subscription schedule. format: unix-time type: integer required: - end_date - start_date title: SubscriptionScheduleCurrentPhase type: object x-expandableFields: [] subscription_schedule_phase_configuration: description: >- A phase describes the plans, coupon, and trialing status of a subscription for a predefined time period. properties: add_invoice_items: description: >- A list of prices and quantities that will generate invoice items appended to the next invoice for this phase. items: $ref: '#/components/schemas/subscription_schedule_add_invoice_item' type: array application_fee_percent: description: >- 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 during this phase of the schedule. nullable: true type: number automatic_tax: $ref: '#/components/schemas/schedules_phase_automatic_tax' billing_cycle_anchor: description: >- Possible values are `phase_start` or `automatic`. If `phase_start` then billing cycle anchor of the subscription is set to the start of the phase when entering the phase. If `automatic` then the billing cycle anchor is automatically modified as needed when entering the phase. For more information, see the billing cycle [documentation](https://stripe.com/docs/billing/subscriptions/billing-cycle). enum: - automatic - phase_start nullable: true type: string billing_thresholds: anyOf: - $ref: '#/components/schemas/subscription_billing_thresholds' description: >- Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period nullable: true collection_method: description: >- Either `charge_automatically`, or `send_invoice`. When charging automatically, Stripe will attempt to pay the underlying subscription at the end of each billing 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`. enum: - charge_automatically - send_invoice nullable: true type: string coupon: anyOf: - maxLength: 5000 type: string - $ref: '#/components/schemas/coupon' - $ref: '#/components/schemas/deleted_coupon' description: >- ID of the coupon to use during this phase of the subscription schedule. nullable: true x-expansionResources: oneOf: - $ref: '#/components/schemas/coupon' - $ref: '#/components/schemas/deleted_coupon' currency: description: >- 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). type: string default_payment_method: anyOf: - maxLength: 5000 type: string - $ref: '#/components/schemas/payment_method' description: >- ID of the default payment method for the subscription schedule. It must belong to the customer associated with the subscription schedule. If not set, invoices will use the default payment method in the customer's invoice settings. nullable: true x-expansionResources: oneOf: - $ref: '#/components/schemas/payment_method' default_tax_rates: description: >- The default tax rates to apply to the subscription during this phase of the subscription schedule. items: $ref: '#/components/schemas/tax_rate' nullable: true type: array description: description: >- Subscription 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. maxLength: 5000 nullable: true type: string discounts: description: >- The stackable discounts that will be applied to the subscription on this phase. Subscription item discounts are applied before subscription discounts. items: $ref: '#/components/schemas/discounts_resource_stackable_discount' type: array end_date: description: The end of this phase of the subscription schedule. format: unix-time type: integer invoice_settings: anyOf: - $ref: >- #/components/schemas/invoice_setting_subscription_schedule_phase_setting description: The invoice settings applicable during this phase. nullable: true items: description: >- Subscription items to configure the subscription to during this phase of the subscription schedule. items: $ref: '#/components/schemas/subscription_schedule_configuration_item' type: array metadata: additionalProperties: maxLength: 500 type: string description: >- Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to a phase. Metadata on a schedule's phase will update the underlying subscription's `metadata` when the phase is entered. Updating the underlying subscription's `metadata` directly will not affect the current phase's `metadata`. nullable: true type: object on_behalf_of: anyOf: - maxLength: 5000 type: string - $ref: '#/components/schemas/account' description: >- The account (if any) the charge was made on behalf of for charges associated with the schedule's subscription. See the Connect documentation for details. nullable: true x-expansionResources: oneOf: - $ref: '#/components/schemas/account' proration_behavior: description: >- If the subscription schedule will prorate when transitioning to this phase. Possible values are `create_prorations` and `none`. enum: - always_invoice - create_prorations - none type: string start_date: description: The start of this phase of the subscription schedule. format: unix-time type: integer transfer_data: anyOf: - $ref: '#/components/schemas/subscription_transfer_data' description: >- The account (if any) the associated subscription's payments will be attributed to for tax reporting, and where funds from each payment will be transferred to for each of the subscription's invoices. nullable: true trial_end: description: When the trial ends within the phase. format: unix-time nullable: true type: integer required: - add_invoice_items - currency - discounts - end_date - items - proration_behavior - start_date title: SubscriptionSchedulePhaseConfiguration type: object x-expandableFields: - add_invoice_items - automatic_tax - billing_thresholds - coupon - default_payment_method - default_tax_rates - discounts - invoice_settings - items - on_behalf_of - transfer_data subscription_schedules_resource_default_settings: description: '' properties: application_fee_percent: description: >- 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 during this phase of the schedule. nullable: true type: number automatic_tax: $ref: >- #/components/schemas/subscription_schedules_resource_default_settings_automatic_tax billing_cycle_anchor: description: >- Possible values are `phase_start` or `automatic`. If `phase_start` then billing cycle anchor of the subscription is set to the start of the phase when entering the phase. If `automatic` then the billing cycle anchor is automatically modified as needed when entering the phase. For more information, see the billing cycle [documentation](https://stripe.com/docs/billing/subscriptions/billing-cycle). enum: - automatic - phase_start type: string billing_thresholds: anyOf: - $ref: '#/components/schemas/subscription_billing_thresholds' description: >- Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period nullable: true collection_method: description: >- Either `charge_automatically`, or `send_invoice`. When charging automatically, Stripe will attempt to pay the underlying subscription at the end of each billing 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`. enum: - charge_automatically - send_invoice nullable: true type: string default_payment_method: anyOf: - maxLength: 5000 type: string - $ref: '#/components/schemas/payment_method' description: >- ID of the default payment method for the subscription schedule. If not set, invoices will use the default payment method in the customer's invoice settings. nullable: true x-expansionResources: oneOf: - $ref: '#/components/schemas/payment_method' description: description: >- Subscription 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. maxLength: 5000 nullable: true type: string invoice_settings: $ref: '#/components/schemas/invoice_setting_subscription_schedule_setting' on_behalf_of: anyOf: - maxLength: 5000 type: string - $ref: '#/components/schemas/account' description: >- The account (if any) the charge was made on behalf of for charges associated with the schedule's subscription. See the Connect documentation for details. nullable: true x-expansionResources: oneOf: - $ref: '#/components/schemas/account' transfer_data: anyOf: - $ref: '#/components/schemas/subscription_transfer_data' description: >- The account (if any) the associated subscription's payments will be attributed to for tax reporting, and where funds from each payment will be transferred to for each of the subscription's invoices. nullable: true required: - billing_cycle_anchor - invoice_settings title: SubscriptionSchedulesResourceDefaultSettings type: object x-expandableFields: - automatic_tax - billing_thresholds - default_payment_method - invoice_settings - on_behalf_of - transfer_data subscription_schedules_resource_default_settings_automatic_tax: description: '' properties: enabled: description: >- Whether Stripe automatically computes tax on invoices created during this phase. type: boolean liability: anyOf: - $ref: '#/components/schemas/connect_account_reference' description: >- The account that's liable for tax. If set, the business address and tax registrations required to perform the tax calculation are loaded from this account. The tax transaction is returned in the report of the connected account. nullable: true required: - enabled title: SubscriptionSchedulesResourceDefaultSettingsAutomaticTax type: object x-expandableFields: - liability subscription_transfer_data: description: '' properties: amount_percent: description: >- A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice total that will be transferred to the destination account. By default, the entire amount is transferred to the destination. nullable: true type: number destination: anyOf: - maxLength: 5000 type: string - $ref: '#/components/schemas/account' description: >- The account where funds from the payment will be transferred to upon payment success. x-expansionResources: oneOf: - $ref: '#/components/schemas/account' required: - destination title: SubscriptionTransferData type: object x-expandableFields: - destination subscriptions_resource_billing_cycle_anchor_config: description: '' properties: day_of_month: description: The day of the month of the billing_cycle_anchor. type: integer hour: description: The hour of the day of the billing_cycle_anchor. nullable: true type: integer minute: description: The minute of the hour of the billing_cycle_anchor. nullable: true type: integer month: description: The month to start full cycle billing periods. nullable: true type: integer second: description: The second of the minute of the billing_cycle_anchor. nullable: true type: integer required: - day_of_month title: SubscriptionsResourceBillingCycleAnchorConfig type: object x-expandableFields: [] subscriptions_resource_pause_collection: description: >- The Pause Collection settings determine how we will pause collection for this subscription and for how long the subscription should be paused. properties: behavior: description: >- The payment collection behavior for this subscription while paused. One of `keep_as_draft`, `mark_uncollectible`, or `void`. enum: - keep_as_draft - mark_uncollectible - void type: string resumes_at: description: >- The time after which the subscription will resume collecting payments. format: unix-time nullable: true type: integer required: - behavior title: SubscriptionsResourcePauseCollection type: object x-expandableFields: [] subscriptions_resource_payment_method_options: description: '' properties: acss_debit: anyOf: - $ref: '#/components/schemas/invoice_payment_method_options_acss_debit' description: >- This sub-hash contains details about the Canadian pre-authorized debit payment method options to pass to invoices created by the subscription. nullable: true bancontact: anyOf: - $ref: '#/components/schemas/invoice_payment_method_options_bancontact' description: >- This sub-hash contains details about the Bancontact payment method options to pass to invoices created by the subscription. nullable: true card: anyOf: - $ref: '#/components/schemas/subscription_payment_method_options_card' description: >- This sub-hash contains details about the Card payment method options to pass to invoices created by the subscription. nullable: true customer_balance: anyOf: - $ref: >- #/components/schemas/invoice_payment_method_options_customer_balance description: >- This sub-hash contains details about the Bank transfer payment method options to pass to invoices created by the subscription. nullable: true konbini: anyOf: - $ref: '#/components/schemas/invoice_payment_method_options_konbini' description: >- This sub-hash contains details about the Konbini payment method options to pass to invoices created by the subscription. nullable: true sepa_debit: anyOf: - $ref: '#/components/schemas/invoice_payment_method_options_sepa_debit' description: >- This sub-hash contains details about the SEPA Direct Debit payment method options to pass to invoices created by the subscription. nullable: true us_bank_account: anyOf: - $ref: >- #/components/schemas/invoice_payment_method_options_us_bank_account description: >- This sub-hash contains details about the ACH direct debit payment method options to pass to invoices created by the subscription. nullable: true title: SubscriptionsResourcePaymentMethodOptions type: object x-expandableFields: - acss_debit - bancontact - card - customer_balance - konbini - sepa_debit - us_bank_account subscriptions_resource_payment_settings: description: '' properties: payment_method_options: anyOf: - $ref: >- #/components/schemas/subscriptions_resource_payment_method_options description: >- Payment-method-specific configuration to provide to invoices created by the subscription. nullable: true payment_method_types: description: >- The list of payment method types to provide to every invoice created by the subscription. If not set, Stripe attempts to automatically determine the types to use by looking at the invoice’s default payment method, the subscription’s default payment method, the customer’s default payment method, and your [invoice template settings](https://dashboard.stripe.com/settings/billing/invoice). items: enum: - ach_credit_transfer - ach_debit - acss_debit - au_becs_debit - bacs_debit - bancontact - boleto - card - cashapp - customer_balance - eps - fpx - giropay - grabpay - ideal - konbini - link - p24 - paynow - paypal - promptpay - sepa_debit - sofort - us_bank_account - wechat_pay type: string x-stripeBypassValidation: true nullable: true type: array save_default_payment_method: description: >- Either `off`, or `on_subscription`. With `on_subscription` Stripe updates `subscription.default_payment_method` when a subscription payment succeeds. enum: - 'off' - on_subscription nullable: true type: string title: SubscriptionsResourcePaymentSettings type: object x-expandableFields: - payment_method_options subscriptions_resource_pending_update: description: >- Pending Updates store the changes pending from a previous update that will be applied to the Subscription upon successful payment. properties: billing_cycle_anchor: description: >- If the update is applied, determines the date of the first full invoice, and, for plans with `month` or `year` intervals, the day of the month for subsequent invoices. The timestamp is in UTC format. format: unix-time nullable: true type: integer expires_at: description: >- The point after which the changes reflected by this update will be discarded and no longer applied. format: unix-time type: integer subscription_items: description: >- List of subscription items, each with an attached plan, that will be set if the update is applied. items: $ref: '#/components/schemas/subscription_item' nullable: true type: array trial_end: description: >- Unix timestamp representing the end of the trial period the customer will get before being charged for the first time, if the update is applied. format: unix-time nullable: true type: integer trial_from_plan: description: >- Indicates if a plan's `trial_period_days` should be applied to the subscription. Setting `trial_end` per subscription is preferred, and this defaults to `false`. Setting this flag to `true` together with `trial_end` is not allowed. See [Using trial periods on subscriptions](https://stripe.com/docs/billing/subscriptions/trials) to learn more. nullable: true type: boolean required: - expires_at title: SubscriptionsResourcePendingUpdate type: object x-expandableFields: - subscription_items subscriptions_trials_resource_end_behavior: description: Defines how a subscription behaves when a free trial ends. properties: missing_payment_method: description: >- Indicates how the subscription should change when the trial ends if the user did not provide a payment method. enum: - cancel - create_invoice - pause type: string required: - missing_payment_method title: SubscriptionsTrialsResourceEndBehavior type: object x-expandableFields: [] subscriptions_trials_resource_trial_settings: description: Configures how this subscription behaves during the trial period. properties: end_behavior: $ref: '#/components/schemas/subscriptions_trials_resource_end_behavior' required: - end_behavior title: SubscriptionsTrialsResourceTrialSettings type: object x-expandableFields: - end_behavior tax.calculation: description: >- A Tax Calculation allows you to calculate the tax to collect from your customer. Related guide: [Calculate tax in your custom payment flow](https://stripe.com/docs/tax/custom) properties: amount_total: description: Total after taxes. type: integer currency: description: >- 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). maxLength: 5000 type: string customer: description: >- The ID of an existing [Customer](https://stripe.com/docs/api/customers/object) used for the resource. maxLength: 5000 nullable: true type: string customer_details: $ref: '#/components/schemas/tax_product_resource_customer_details' expires_at: description: Timestamp of date at which the tax calculation will expire. format: unix-time nullable: true type: integer id: description: Unique identifier for the calculation. maxLength: 5000 nullable: true type: string line_items: description: The list of items the customer is purchasing. nullable: true properties: data: description: Details about each object. items: $ref: '#/components/schemas/tax.calculation_line_item' type: array has_more: description: >- True if this list has another page of items after this one that can be fetched. type: boolean object: description: >- String representing the object's type. Objects of the same type share the same value. Always has the value `list`. enum: - list type: string url: description: The URL where this list can be accessed. maxLength: 5000 pattern: '^/v1/tax/calculations/[^/]+/line_items' type: string required: - data - has_more - object - url title: TaxProductResourceTaxCalculationLineItemList type: object x-expandableFields: - data livemode: description: >- Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. type: boolean object: description: >- String representing the object's type. Objects of the same type share the same value. enum: - tax.calculation type: string shipping_cost: anyOf: - $ref: >- #/components/schemas/tax_product_resource_tax_calculation_shipping_cost description: The shipping cost details for the calculation. nullable: true tax_amount_exclusive: description: The amount of tax to be collected on top of the line item prices. type: integer tax_amount_inclusive: description: The amount of tax already included in the line item prices. type: integer tax_breakdown: description: Breakdown of individual tax amounts that add up to the total. items: $ref: '#/components/schemas/tax_product_resource_tax_breakdown' type: array tax_date: description: >- Timestamp of date at which the tax rules and rates in effect applies for the calculation. format: unix-time type: integer required: - amount_total - currency - customer_details - livemode - object - tax_amount_exclusive - tax_amount_inclusive - tax_breakdown - tax_date title: TaxProductResourceTaxCalculation type: object x-expandableFields: - customer_details - line_items - shipping_cost - tax_breakdown x-resourceId: tax.calculation tax.calculation_line_item: description: '' properties: amount: description: >- The line item amount in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). If `tax_behavior=inclusive`, then this amount includes taxes. Otherwise, taxes were calculated on top of this amount. type: integer amount_tax: description: >- The amount of tax calculated for this line item, in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). type: integer id: description: Unique identifier for the object. maxLength: 5000 type: string livemode: description: >- Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. type: boolean object: description: >- String representing the object's type. Objects of the same type share the same value. enum: - tax.calculation_line_item type: string product: description: >- The ID of an existing [Product](https://stripe.com/docs/api/products/object). maxLength: 5000 nullable: true type: string quantity: description: >- The number of units of the item being purchased. For reversals, this is the quantity reversed. type: integer reference: description: A custom identifier for this line item. maxLength: 5000 nullable: true type: string tax_behavior: description: >- Specifies whether the `amount` includes taxes. If `tax_behavior=inclusive`, then the amount includes taxes. enum: - exclusive - inclusive type: string tax_breakdown: description: Detailed account of taxes relevant to this line item. items: $ref: '#/components/schemas/tax_product_resource_line_item_tax_breakdown' nullable: true type: array tax_code: description: >- The [tax code](https://stripe.com/docs/tax/tax-categories) ID used for this resource. maxLength: 5000 type: string required: - amount - amount_tax - id - livemode - object - quantity - tax_behavior - tax_code title: TaxProductResourceTaxCalculationLineItem type: object x-expandableFields: - tax_breakdown x-resourceId: tax.calculation_line_item tax.registration: description: >- A Tax `Registration` lets us know that your business is registered to collect tax on payments within a region, enabling you to [automatically collect tax](https://stripe.com/docs/tax). Stripe doesn't register on your behalf with the relevant authorities when you create a Tax `Registration` object. For more information on how to register to collect tax, see [our guide](https://stripe.com/docs/tax/registering). Related guide: [Using the Registrations API](https://stripe.com/docs/tax/registrations-api) properties: active_from: description: >- Time at which the registration becomes active. Measured in seconds since the Unix epoch. format: unix-time type: integer country: description: >- Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)). maxLength: 5000 type: string country_options: $ref: >- #/components/schemas/tax_product_registrations_resource_country_options created: description: >- Time at which the object was created. Measured in seconds since the Unix epoch. format: unix-time type: integer expires_at: description: >- If set, the registration stops being active at this time. If not set, the registration will be active indefinitely. Measured in seconds since the Unix epoch. format: unix-time nullable: true type: integer id: description: Unique identifier for the object. maxLength: 5000 type: string livemode: description: >- Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. type: boolean object: description: >- String representing the object's type. Objects of the same type share the same value. enum: - tax.registration type: string status: description: >- The status of the registration. This field is present for convenience and can be deduced from `active_from` and `expires_at`. enum: - active - expired - scheduled type: string required: - active_from - country - country_options - created - id - livemode - object - status title: TaxProductRegistrationsResourceTaxRegistration type: object x-expandableFields: - country_options x-resourceId: tax.registration tax.settings: description: >- You can use Tax `Settings` to manage configurations used by Stripe Tax calculations. Related guide: [Using the Settings API](https://stripe.com/docs/tax/settings-api) properties: defaults: $ref: '#/components/schemas/tax_product_resource_tax_settings_defaults' head_office: anyOf: - $ref: >- #/components/schemas/tax_product_resource_tax_settings_head_office description: The place where your business is located. nullable: true livemode: description: >- Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. type: boolean object: description: >- String representing the object's type. Objects of the same type share the same value. enum: - tax.settings type: string status: description: >- The `active` status indicates you have all required settings to calculate tax. A status can transition out of `active` when new required settings are introduced. enum: - active - pending type: string status_details: $ref: >- #/components/schemas/tax_product_resource_tax_settings_status_details required: - defaults - livemode - object - status - status_details title: TaxProductResourceTaxSettings type: object x-expandableFields: - defaults - head_office - status_details x-resourceId: tax.settings tax.transaction: description: >- A Tax Transaction records the tax collected from or refunded to your customer. Related guide: [Calculate tax in your custom payment flow](https://stripe.com/docs/tax/custom#tax-transaction) properties: created: description: >- Time at which the object was created. Measured in seconds since the Unix epoch. format: unix-time type: integer currency: description: >- 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). maxLength: 5000 type: string customer: description: >- The ID of an existing [Customer](https://stripe.com/docs/api/customers/object) used for the resource. maxLength: 5000 nullable: true type: string customer_details: $ref: '#/components/schemas/tax_product_resource_customer_details' id: description: Unique identifier for the transaction. maxLength: 5000 type: string line_items: description: 'The tax collected or refunded, by line item.' nullable: true properties: data: description: Details about each object. items: $ref: '#/components/schemas/tax.transaction_line_item' type: array has_more: description: >- True if this list has another page of items after this one that can be fetched. type: boolean object: description: >- String representing the object's type. Objects of the same type share the same value. Always has the value `list`. enum: - list type: string url: description: The URL where this list can be accessed. maxLength: 5000 pattern: '^/v1/tax/transactions/[^/]+/line_items' type: string required: - data - has_more - object - url title: TaxProductResourceTaxTransactionLineItemList type: object x-expandableFields: - data livemode: description: >- Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. type: boolean metadata: additionalProperties: maxLength: 500 type: string description: >- 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. nullable: true type: object object: description: >- String representing the object's type. Objects of the same type share the same value. enum: - tax.transaction type: string reference: description: 'A custom unique identifier, such as ''myOrder_123''.' maxLength: 5000 type: string reversal: anyOf: - $ref: >- #/components/schemas/tax_product_resource_tax_transaction_resource_reversal description: 'If `type=reversal`, contains information about what was reversed.' nullable: true shipping_cost: anyOf: - $ref: >- #/components/schemas/tax_product_resource_tax_transaction_shipping_cost description: The shipping cost details for the transaction. nullable: true tax_date: description: >- Timestamp of date at which the tax rules and rates in effect applies for the calculation. format: unix-time type: integer type: description: 'If `reversal`, this transaction reverses an earlier transaction.' enum: - reversal - transaction type: string required: - created - currency - customer_details - id - livemode - object - reference - tax_date - type title: TaxProductResourceTaxTransaction type: object x-expandableFields: - customer_details - line_items - reversal - shipping_cost x-resourceId: tax.transaction tax.transaction_line_item: description: '' properties: amount: description: >- The line item amount in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). If `tax_behavior=inclusive`, then this amount includes taxes. Otherwise, taxes were calculated on top of this amount. type: integer amount_tax: description: >- The amount of tax calculated for this line item, in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). type: integer id: description: Unique identifier for the object. maxLength: 5000 type: string livemode: description: >- Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. type: boolean metadata: additionalProperties: maxLength: 500 type: string description: >- 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. nullable: true type: object object: description: >- String representing the object's type. Objects of the same type share the same value. enum: - tax.transaction_line_item type: string product: description: >- The ID of an existing [Product](https://stripe.com/docs/api/products/object). maxLength: 5000 nullable: true type: string quantity: description: >- The number of units of the item being purchased. For reversals, this is the quantity reversed. type: integer reference: description: A custom identifier for this line item in the transaction. maxLength: 5000 type: string reversal: anyOf: - $ref: >- #/components/schemas/tax_product_resource_tax_transaction_line_item_resource_reversal description: 'If `type=reversal`, contains information about what was reversed.' nullable: true tax_behavior: description: >- Specifies whether the `amount` includes taxes. If `tax_behavior=inclusive`, then the amount includes taxes. enum: - exclusive - inclusive type: string tax_code: description: >- The [tax code](https://stripe.com/docs/tax/tax-categories) ID used for this resource. maxLength: 5000 type: string type: description: 'If `reversal`, this line item reverses an earlier transaction.' enum: - reversal - transaction type: string required: - amount - amount_tax - id - livemode - object - quantity - reference - tax_behavior - tax_code - type title: TaxProductResourceTaxTransactionLineItem type: object x-expandableFields: - reversal x-resourceId: tax.transaction_line_item tax_code: description: >- [Tax codes](https://stripe.com/docs/tax/tax-categories) classify goods and services for tax purposes. properties: description: description: >- A detailed description of which types of products the tax code represents. maxLength: 5000 type: string id: description: Unique identifier for the object. maxLength: 5000 type: string name: description: A short name for the tax code. maxLength: 5000 type: string object: description: >- String representing the object's type. Objects of the same type share the same value. enum: - tax_code type: string required: - description - id - name - object title: TaxProductResourceTaxCode type: object x-expandableFields: [] x-resourceId: tax_code tax_deducted_at_source: description: '' properties: id: description: Unique identifier for the object. maxLength: 5000 type: string object: description: >- String representing the object's type. Objects of the same type share the same value. enum: - tax_deducted_at_source type: string period_end: description: >- The end of the invoicing period. This TDS applies to Stripe fees collected during this invoicing period. format: unix-time type: integer period_start: description: >- The start of the invoicing period. This TDS applies to Stripe fees collected during this invoicing period. format: unix-time type: integer tax_deduction_account_number: description: The TAN that was supplied to Stripe when TDS was assessed maxLength: 5000 type: string required: - id - object - period_end - period_start - tax_deduction_account_number title: TaxDeductedAtSource type: object x-expandableFields: [] tax_i_ds_owner: description: '' properties: account: anyOf: - maxLength: 5000 type: string - $ref: '#/components/schemas/account' description: The account being referenced when `type` is `account`. x-expansionResources: oneOf: - $ref: '#/components/schemas/account' application: anyOf: - maxLength: 5000 type: string - $ref: '#/components/schemas/application' description: >- The Connect Application being referenced when `type` is `application`. x-expansionResources: oneOf: - $ref: '#/components/schemas/application' customer: anyOf: - maxLength: 5000 type: string - $ref: '#/components/schemas/customer' description: The customer being referenced when `type` is `customer`. x-expansionResources: oneOf: - $ref: '#/components/schemas/customer' type: description: Type of owner referenced. enum: - account - application - customer - self type: string required: - type title: TaxIDsOwner type: object x-expandableFields: - account - application - customer tax_id: description: >- You can add one or multiple tax IDs to a [customer](https://stripe.com/docs/api/customers) or account. Customer and account tax IDs get displayed on related invoices and credit notes. Related guides: [Customer tax identification numbers](https://stripe.com/docs/billing/taxes/tax-ids), [Account tax IDs](https://stripe.com/docs/invoicing/connect#account-tax-ids) properties: country: description: Two-letter ISO code representing the country of the tax ID. maxLength: 5000 nullable: true type: string created: description: >- Time at which the object was created. Measured in seconds since the Unix epoch. format: unix-time type: integer customer: anyOf: - maxLength: 5000 type: string - $ref: '#/components/schemas/customer' description: ID of the customer. nullable: true x-expansionResources: oneOf: - $ref: '#/components/schemas/customer' id: description: Unique identifier for the object. maxLength: 5000 type: string livemode: description: >- Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. type: boolean object: description: >- String representing the object's type. Objects of the same type share the same value. enum: - tax_id type: string owner: anyOf: - $ref: '#/components/schemas/tax_i_ds_owner' description: The account or customer the tax ID belongs to. nullable: true type: description: >- Type of the tax ID, one of `ad_nrt`, `ae_trn`, `ar_cuit`, `au_abn`, `au_arn`, `bg_uic`, `bh_vat`, `bo_tin`, `br_cnpj`, `br_cpf`, `ca_bn`, `ca_gst_hst`, `ca_pst_bc`, `ca_pst_mb`, `ca_pst_sk`, `ca_qst`, `ch_vat`, `cl_tin`, `cn_tin`, `co_nit`, `cr_tin`, `do_rcn`, `ec_ruc`, `eg_tin`, `es_cif`, `eu_oss_vat`, `eu_vat`, `gb_vat`, `ge_vat`, `hk_br`, `hu_tin`, `id_npwp`, `il_vat`, `in_gst`, `is_vat`, `jp_cn`, `jp_rn`, `jp_trn`, `ke_pin`, `kr_brn`, `kz_bin`, `li_uid`, `mx_rfc`, `my_frp`, `my_itn`, `my_sst`, `ng_tin`, `no_vat`, `no_voec`, `nz_gst`, `om_vat`, `pe_ruc`, `ph_tin`, `ro_tin`, `rs_pib`, `ru_inn`, `ru_kpp`, `sa_vat`, `sg_gst`, `sg_uen`, `si_tin`, `sv_nit`, `th_vat`, `tr_tin`, `tw_vat`, `ua_vat`, `us_ein`, `uy_ruc`, `ve_rif`, `vn_tin`, or `za_vat`. Note that some legacy tax IDs have type `unknown` enum: - ad_nrt - ae_trn - ar_cuit - au_abn - au_arn - bg_uic - bh_vat - bo_tin - br_cnpj - br_cpf - ca_bn - ca_gst_hst - ca_pst_bc - ca_pst_mb - ca_pst_sk - ca_qst - ch_vat - cl_tin - cn_tin - co_nit - cr_tin - do_rcn - ec_ruc - eg_tin - es_cif - eu_oss_vat - eu_vat - gb_vat - ge_vat - hk_br - hu_tin - id_npwp - il_vat - in_gst - is_vat - jp_cn - jp_rn - jp_trn - ke_pin - kr_brn - kz_bin - li_uid - mx_rfc - my_frp - my_itn - my_sst - ng_tin - no_vat - no_voec - nz_gst - om_vat - pe_ruc - ph_tin - ro_tin - rs_pib - ru_inn - ru_kpp - sa_vat - sg_gst - sg_uen - si_tin - sv_nit - th_vat - tr_tin - tw_vat - ua_vat - unknown - us_ein - uy_ruc - ve_rif - vn_tin - za_vat type: string value: description: Value of the tax ID. maxLength: 5000 type: string verification: anyOf: - $ref: '#/components/schemas/tax_id_verification' description: Tax ID verification information. nullable: true required: - created - id - livemode - object - type - value title: tax_id type: object x-expandableFields: - customer - owner - verification x-resourceId: tax_id tax_id_verification: description: '' properties: status: description: >- Verification status, one of `pending`, `verified`, `unverified`, or `unavailable`. enum: - pending - unavailable - unverified - verified type: string verified_address: description: Verified address. maxLength: 5000 nullable: true type: string verified_name: description: Verified name. maxLength: 5000 nullable: true type: string required: - status title: tax_id_verification type: object x-expandableFields: [] tax_product_registrations_resource_country_options: description: '' properties: ae: $ref: >- #/components/schemas/tax_product_registrations_resource_country_options_default at: $ref: >- #/components/schemas/tax_product_registrations_resource_country_options_europe au: $ref: >- #/components/schemas/tax_product_registrations_resource_country_options_default be: $ref: >- #/components/schemas/tax_product_registrations_resource_country_options_europe bg: $ref: >- #/components/schemas/tax_product_registrations_resource_country_options_europe ca: $ref: >- #/components/schemas/tax_product_registrations_resource_country_options_canada ch: $ref: >- #/components/schemas/tax_product_registrations_resource_country_options_default cl: $ref: >- #/components/schemas/tax_product_registrations_resource_country_options_simplified co: $ref: >- #/components/schemas/tax_product_registrations_resource_country_options_simplified cy: $ref: >- #/components/schemas/tax_product_registrations_resource_country_options_europe cz: $ref: >- #/components/schemas/tax_product_registrations_resource_country_options_europe de: $ref: >- #/components/schemas/tax_product_registrations_resource_country_options_europe dk: $ref: >- #/components/schemas/tax_product_registrations_resource_country_options_europe ee: $ref: >- #/components/schemas/tax_product_registrations_resource_country_options_europe es: $ref: >- #/components/schemas/tax_product_registrations_resource_country_options_europe fi: $ref: >- #/components/schemas/tax_product_registrations_resource_country_options_europe fr: $ref: >- #/components/schemas/tax_product_registrations_resource_country_options_europe gb: $ref: >- #/components/schemas/tax_product_registrations_resource_country_options_default gr: $ref: >- #/components/schemas/tax_product_registrations_resource_country_options_europe hr: $ref: >- #/components/schemas/tax_product_registrations_resource_country_options_europe hu: $ref: >- #/components/schemas/tax_product_registrations_resource_country_options_europe id: $ref: >- #/components/schemas/tax_product_registrations_resource_country_options_simplified ie: $ref: >- #/components/schemas/tax_product_registrations_resource_country_options_europe is: $ref: >- #/components/schemas/tax_product_registrations_resource_country_options_default it: $ref: >- #/components/schemas/tax_product_registrations_resource_country_options_europe jp: $ref: >- #/components/schemas/tax_product_registrations_resource_country_options_default kr: $ref: >- #/components/schemas/tax_product_registrations_resource_country_options_simplified lt: $ref: >- #/components/schemas/tax_product_registrations_resource_country_options_europe lu: $ref: >- #/components/schemas/tax_product_registrations_resource_country_options_europe lv: $ref: >- #/components/schemas/tax_product_registrations_resource_country_options_europe mt: $ref: >- #/components/schemas/tax_product_registrations_resource_country_options_europe mx: $ref: >- #/components/schemas/tax_product_registrations_resource_country_options_simplified my: $ref: >- #/components/schemas/tax_product_registrations_resource_country_options_simplified nl: $ref: >- #/components/schemas/tax_product_registrations_resource_country_options_europe 'no': $ref: >- #/components/schemas/tax_product_registrations_resource_country_options_default nz: $ref: >- #/components/schemas/tax_product_registrations_resource_country_options_default pl: $ref: >- #/components/schemas/tax_product_registrations_resource_country_options_europe pt: $ref: >- #/components/schemas/tax_product_registrations_resource_country_options_europe ro: $ref: >- #/components/schemas/tax_product_registrations_resource_country_options_europe sa: $ref: >- #/components/schemas/tax_product_registrations_resource_country_options_simplified se: $ref: >- #/components/schemas/tax_product_registrations_resource_country_options_europe sg: $ref: >- #/components/schemas/tax_product_registrations_resource_country_options_default si: $ref: >- #/components/schemas/tax_product_registrations_resource_country_options_europe sk: $ref: >- #/components/schemas/tax_product_registrations_resource_country_options_europe th: $ref: >- #/components/schemas/tax_product_registrations_resource_country_options_simplified tr: $ref: >- #/components/schemas/tax_product_registrations_resource_country_options_simplified us: $ref: >- #/components/schemas/tax_product_registrations_resource_country_options_united_states vn: $ref: >- #/components/schemas/tax_product_registrations_resource_country_options_simplified za: $ref: >- #/components/schemas/tax_product_registrations_resource_country_options_default title: TaxProductRegistrationsResourceCountryOptions type: object x-expandableFields: - ae - at - au - be - bg - ca - ch - cl - co - cy - cz - de - dk - ee - es - fi - fr - gb - gr - hr - hu - id - ie - is - it - jp - kr - lt - lu - lv - mt - mx - my - nl - 'no' - nz - pl - pt - ro - sa - se - sg - si - sk - th - tr - us - vn - za tax_product_registrations_resource_country_options_ca_province_standard: description: '' properties: province: description: >- Two-letter CA province code ([ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2)). maxLength: 5000 type: string required: - province title: TaxProductRegistrationsResourceCountryOptionsCaProvinceStandard type: object x-expandableFields: [] tax_product_registrations_resource_country_options_canada: description: '' properties: province_standard: $ref: >- #/components/schemas/tax_product_registrations_resource_country_options_ca_province_standard type: description: Type of registration in Canada. enum: - province_standard - simplified - standard type: string required: - type title: TaxProductRegistrationsResourceCountryOptionsCanada type: object x-expandableFields: - province_standard tax_product_registrations_resource_country_options_default: description: '' properties: type: description: Type of registration in `country`. enum: - standard type: string required: - type title: TaxProductRegistrationsResourceCountryOptionsDefault type: object x-expandableFields: [] tax_product_registrations_resource_country_options_eu_standard: description: '' properties: place_of_supply_scheme: description: Place of supply scheme used in an EU standard registration. enum: - small_seller - standard type: string required: - place_of_supply_scheme title: TaxProductRegistrationsResourceCountryOptionsEuStandard type: object x-expandableFields: [] tax_product_registrations_resource_country_options_europe: description: '' properties: standard: $ref: >- #/components/schemas/tax_product_registrations_resource_country_options_eu_standard type: description: Type of registration in an EU country. enum: - ioss - oss_non_union - oss_union - standard type: string required: - type title: TaxProductRegistrationsResourceCountryOptionsEurope type: object x-expandableFields: - standard tax_product_registrations_resource_country_options_simplified: description: '' properties: type: description: Type of registration in `country`. enum: - simplified type: string required: - type title: TaxProductRegistrationsResourceCountryOptionsSimplified type: object x-expandableFields: [] tax_product_registrations_resource_country_options_united_states: description: '' properties: local_amusement_tax: $ref: >- #/components/schemas/tax_product_registrations_resource_country_options_us_local_amusement_tax local_lease_tax: $ref: >- #/components/schemas/tax_product_registrations_resource_country_options_us_local_lease_tax state: description: >- Two-letter US state code ([ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2)). maxLength: 5000 type: string type: description: Type of registration in the US. enum: - local_amusement_tax - local_lease_tax - state_communications_tax - state_sales_tax type: string x-stripeBypassValidation: true required: - state - type title: TaxProductRegistrationsResourceCountryOptionsUnitedStates type: object x-expandableFields: - local_amusement_tax - local_lease_tax tax_product_registrations_resource_country_options_us_local_amusement_tax: description: '' properties: jurisdiction: description: >- A [FIPS code](https://www.census.gov/library/reference/code-lists/ansi.html) representing the local jurisdiction. maxLength: 5000 type: string required: - jurisdiction title: TaxProductRegistrationsResourceCountryOptionsUsLocalAmusementTax type: object x-expandableFields: [] tax_product_registrations_resource_country_options_us_local_lease_tax: description: '' properties: jurisdiction: description: >- A [FIPS code](https://www.census.gov/library/reference/code-lists/ansi.html) representing the local jurisdiction. maxLength: 5000 type: string required: - jurisdiction title: TaxProductRegistrationsResourceCountryOptionsUsLocalLeaseTax type: object x-expandableFields: [] tax_product_resource_customer_details: description: '' properties: address: anyOf: - $ref: '#/components/schemas/tax_product_resource_postal_address' description: >- The customer's postal address (for example, home or business location). nullable: true address_source: description: The type of customer address provided. enum: - billing - shipping nullable: true type: string ip_address: description: The customer's IP address (IPv4 or IPv6). maxLength: 5000 nullable: true type: string tax_ids: description: 'The customer''s tax IDs (for example, EU VAT numbers).' items: $ref: >- #/components/schemas/tax_product_resource_customer_details_resource_tax_id type: array taxability_override: description: The taxability override used for taxation. enum: - customer_exempt - none - reverse_charge type: string required: - tax_ids - taxability_override title: TaxProductResourceCustomerDetails type: object x-expandableFields: - address - tax_ids tax_product_resource_customer_details_resource_tax_id: description: '' properties: type: description: >- The type of the tax ID, one of `ad_nrt`, `ar_cuit`, `eu_vat`, `bo_tin`, `br_cnpj`, `br_cpf`, `cn_tin`, `co_nit`, `cr_tin`, `do_rcn`, `ec_ruc`, `eu_oss_vat`, `pe_ruc`, `ro_tin`, `rs_pib`, `sv_nit`, `uy_ruc`, `ve_rif`, `vn_tin`, `gb_vat`, `nz_gst`, `au_abn`, `au_arn`, `in_gst`, `no_vat`, `no_voec`, `za_vat`, `ch_vat`, `mx_rfc`, `sg_uen`, `ru_inn`, `ru_kpp`, `ca_bn`, `hk_br`, `es_cif`, `tw_vat`, `th_vat`, `jp_cn`, `jp_rn`, `jp_trn`, `li_uid`, `my_itn`, `us_ein`, `kr_brn`, `ca_qst`, `ca_gst_hst`, `ca_pst_bc`, `ca_pst_mb`, `ca_pst_sk`, `my_sst`, `sg_gst`, `ae_trn`, `cl_tin`, `sa_vat`, `id_npwp`, `my_frp`, `il_vat`, `ge_vat`, `ua_vat`, `is_vat`, `bg_uic`, `hu_tin`, `si_tin`, `ke_pin`, `tr_tin`, `eg_tin`, `ph_tin`, `bh_vat`, `kz_bin`, `ng_tin`, `om_vat`, or `unknown` enum: - ad_nrt - ae_trn - ar_cuit - au_abn - au_arn - bg_uic - bh_vat - bo_tin - br_cnpj - br_cpf - ca_bn - ca_gst_hst - ca_pst_bc - ca_pst_mb - ca_pst_sk - ca_qst - ch_vat - cl_tin - cn_tin - co_nit - cr_tin - do_rcn - ec_ruc - eg_tin - es_cif - eu_oss_vat - eu_vat - gb_vat - ge_vat - hk_br - hu_tin - id_npwp - il_vat - in_gst - is_vat - jp_cn - jp_rn - jp_trn - ke_pin - kr_brn - kz_bin - li_uid - mx_rfc - my_frp - my_itn - my_sst - ng_tin - no_vat - no_voec - nz_gst - om_vat - pe_ruc - ph_tin - ro_tin - rs_pib - ru_inn - ru_kpp - sa_vat - sg_gst - sg_uen - si_tin - sv_nit - th_vat - tr_tin - tw_vat - ua_vat - unknown - us_ein - uy_ruc - ve_rif - vn_tin - za_vat type: string value: description: The value of the tax ID. maxLength: 5000 type: string required: - type - value title: TaxProductResourceCustomerDetailsResourceTaxId type: object x-expandableFields: [] tax_product_resource_jurisdiction: description: '' properties: country: description: >- Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)). maxLength: 5000 type: string display_name: description: A human-readable name for the jurisdiction imposing the tax. maxLength: 5000 type: string level: description: Indicates the level of the jurisdiction imposing the tax. enum: - city - country - county - district - state type: string state: description: >- [ISO 3166-2 subdivision code](https://en.wikipedia.org/wiki/ISO_3166-2:US), without country prefix. For example, "NY" for New York, United States. maxLength: 5000 nullable: true type: string required: - country - display_name - level title: TaxProductResourceJurisdiction type: object x-expandableFields: [] tax_product_resource_line_item_tax_breakdown: description: '' properties: amount: description: >- The amount of tax, in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). type: integer jurisdiction: $ref: '#/components/schemas/tax_product_resource_jurisdiction' sourcing: description: >- Indicates whether the jurisdiction was determined by the origin (merchant's address) or destination (customer's address). enum: - destination - origin type: string tax_rate_details: anyOf: - $ref: >- #/components/schemas/tax_product_resource_line_item_tax_rate_details description: >- Details regarding the rate for this tax. This field will be `null` when the tax is not imposed, for example if the product is exempt from tax. nullable: true taxability_reason: description: >- The reasoning behind this tax, for example, if the product is tax exempt. The possible values for this field may be extended as new tax rules are supported. enum: - customer_exempt - not_collecting - not_subject_to_tax - not_supported - portion_product_exempt - portion_reduced_rated - portion_standard_rated - product_exempt - product_exempt_holiday - proportionally_rated - reduced_rated - reverse_charge - standard_rated - taxable_basis_reduced - zero_rated type: string taxable_amount: description: >- The amount on which tax is calculated, in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). type: integer required: - amount - jurisdiction - sourcing - taxability_reason - taxable_amount title: TaxProductResourceLineItemTaxBreakdown type: object x-expandableFields: - jurisdiction - tax_rate_details tax_product_resource_line_item_tax_rate_details: description: '' properties: display_name: description: >- A localized display name for tax type, intended to be human-readable. For example, "Local Sales and Use Tax", "Value-added tax (VAT)", or "Umsatzsteuer (USt.)". maxLength: 5000 type: string percentage_decimal: description: >- The tax rate percentage as a string. For example, 8.5% is represented as "8.5". maxLength: 5000 type: string tax_type: description: 'The tax type, such as `vat` or `sales_tax`.' enum: - amusement_tax - communications_tax - gst - hst - igst - jct - lease_tax - pst - qst - rst - sales_tax - vat type: string x-stripeBypassValidation: true required: - display_name - percentage_decimal - tax_type title: TaxProductResourceLineItemTaxRateDetails type: object x-expandableFields: [] tax_product_resource_postal_address: description: '' properties: city: description: 'City, district, suburb, town, or village.' maxLength: 5000 nullable: true type: string country: description: >- Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)). maxLength: 5000 type: string line1: description: 'Address line 1 (e.g., street, PO Box, or company name).' maxLength: 5000 nullable: true type: string line2: description: 'Address line 2 (e.g., apartment, suite, unit, or building).' maxLength: 5000 nullable: true type: string postal_code: description: ZIP or postal code. maxLength: 5000 nullable: true type: string state: description: >- State/province as an [ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2) subdivision code, without country prefix. Example: "NY" or "TX". maxLength: 5000 nullable: true type: string required: - country title: TaxProductResourcePostalAddress type: object x-expandableFields: [] tax_product_resource_tax_breakdown: description: '' properties: amount: description: >- The amount of tax, in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). type: integer inclusive: description: >- Specifies whether the tax amount is included in the line item amount. type: boolean tax_rate_details: $ref: '#/components/schemas/tax_product_resource_tax_rate_details' taxability_reason: description: >- The reasoning behind this tax, for example, if the product is tax exempt. We might extend the possible values for this field to support new tax rules. enum: - customer_exempt - not_collecting - not_subject_to_tax - not_supported - portion_product_exempt - portion_reduced_rated - portion_standard_rated - product_exempt - product_exempt_holiday - proportionally_rated - reduced_rated - reverse_charge - standard_rated - taxable_basis_reduced - zero_rated type: string taxable_amount: description: >- The amount on which tax is calculated, in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). type: integer required: - amount - inclusive - tax_rate_details - taxability_reason - taxable_amount title: TaxProductResourceTaxBreakdown type: object x-expandableFields: - tax_rate_details tax_product_resource_tax_calculation_shipping_cost: description: '' properties: amount: description: >- The shipping amount in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). If `tax_behavior=inclusive`, then this amount includes taxes. Otherwise, taxes were calculated on top of this amount. type: integer amount_tax: description: >- The amount of tax calculated for shipping, in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). type: integer shipping_rate: description: >- The ID of an existing [ShippingRate](https://stripe.com/docs/api/shipping_rates/object). maxLength: 5000 type: string tax_behavior: description: >- Specifies whether the `amount` includes taxes. If `tax_behavior=inclusive`, then the amount includes taxes. enum: - exclusive - inclusive type: string tax_breakdown: description: Detailed account of taxes relevant to shipping cost. items: $ref: '#/components/schemas/tax_product_resource_line_item_tax_breakdown' type: array tax_code: description: >- The [tax code](https://stripe.com/docs/tax/tax-categories) ID used for shipping. maxLength: 5000 type: string required: - amount - amount_tax - tax_behavior - tax_code title: TaxProductResourceTaxCalculationShippingCost type: object x-expandableFields: - tax_breakdown tax_product_resource_tax_rate_details: description: '' properties: country: description: >- Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)). maxLength: 5000 nullable: true type: string percentage_decimal: description: >- The tax rate percentage as a string. For example, 8.5% is represented as `"8.5"`. maxLength: 5000 type: string state: description: 'State, county, province, or region.' maxLength: 5000 nullable: true type: string tax_type: description: 'The tax type, such as `vat` or `sales_tax`.' enum: - amusement_tax - communications_tax - gst - hst - igst - jct - lease_tax - pst - qst - rst - sales_tax - vat nullable: true type: string x-stripeBypassValidation: true required: - percentage_decimal title: TaxProductResourceTaxRateDetails type: object x-expandableFields: [] tax_product_resource_tax_settings_defaults: description: '' properties: tax_behavior: description: >- Default [tax behavior](https://stripe.com/docs/tax/products-prices-tax-categories-tax-behavior#tax-behavior) used to specify whether the price is considered inclusive of taxes or exclusive of taxes. If the item's price has a tax behavior set, it will take precedence over the default tax behavior. enum: - exclusive - inclusive - inferred_by_currency nullable: true type: string tax_code: description: >- Default [tax code](https://stripe.com/docs/tax/tax-categories) used to classify your products and prices. maxLength: 5000 nullable: true type: string title: TaxProductResourceTaxSettingsDefaults type: object x-expandableFields: [] tax_product_resource_tax_settings_head_office: description: '' properties: address: $ref: '#/components/schemas/address' required: - address title: TaxProductResourceTaxSettingsHeadOffice type: object x-expandableFields: - address tax_product_resource_tax_settings_status_details: description: '' properties: active: $ref: >- #/components/schemas/tax_product_resource_tax_settings_status_details_resource_active pending: $ref: >- #/components/schemas/tax_product_resource_tax_settings_status_details_resource_pending title: TaxProductResourceTaxSettingsStatusDetails type: object x-expandableFields: - active - pending tax_product_resource_tax_settings_status_details_resource_active: description: '' properties: {} title: TaxProductResourceTaxSettingsStatusDetailsResourceActive type: object x-expandableFields: [] tax_product_resource_tax_settings_status_details_resource_pending: description: '' properties: missing_fields: description: >- The list of missing fields that are required to perform calculations. It includes the entry `head_office` when the status is `pending`. It is recommended to set the optional values even if they aren't listed as required for calculating taxes. Calculations can fail if missing fields aren't explicitly provided on every call. items: maxLength: 5000 type: string nullable: true type: array title: TaxProductResourceTaxSettingsStatusDetailsResourcePending type: object x-expandableFields: [] tax_product_resource_tax_transaction_line_item_resource_reversal: description: '' properties: original_line_item: description: The `id` of the line item to reverse in the original transaction. maxLength: 5000 type: string required: - original_line_item title: TaxProductResourceTaxTransactionLineItemResourceReversal type: object x-expandableFields: [] tax_product_resource_tax_transaction_resource_reversal: description: '' properties: original_transaction: description: The `id` of the reversed `Transaction` object. maxLength: 5000 nullable: true type: string title: TaxProductResourceTaxTransactionResourceReversal type: object x-expandableFields: [] tax_product_resource_tax_transaction_shipping_cost: description: '' properties: amount: description: >- The shipping amount in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). If `tax_behavior=inclusive`, then this amount includes taxes. Otherwise, taxes were calculated on top of this amount. type: integer amount_tax: description: >- The amount of tax calculated for shipping, in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). type: integer shipping_rate: description: >- The ID of an existing [ShippingRate](https://stripe.com/docs/api/shipping_rates/object). maxLength: 5000 type: string tax_behavior: description: >- Specifies whether the `amount` includes taxes. If `tax_behavior=inclusive`, then the amount includes taxes. enum: - exclusive - inclusive type: string tax_code: description: >- The [tax code](https://stripe.com/docs/tax/tax-categories) ID used for shipping. maxLength: 5000 type: string required: - amount - amount_tax - tax_behavior - tax_code title: TaxProductResourceTaxTransactionShippingCost type: object x-expandableFields: [] tax_rate: description: >- Tax rates can be applied to [invoices](https://stripe.com/docs/billing/invoices/tax-rates), [subscriptions](https://stripe.com/docs/billing/subscriptions/taxes) and [Checkout Sessions](https://stripe.com/docs/payments/checkout/set-up-a-subscription#tax-rates) to collect tax. Related guide: [Tax rates](https://stripe.com/docs/billing/taxes/tax-rates) properties: active: description: >- Defaults to `true`. When set to `false`, this tax rate cannot be used with new applications or Checkout Sessions, but will still work for subscriptions and invoices that already have it set. type: boolean country: description: >- Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)). maxLength: 5000 nullable: true type: string created: description: >- Time at which the object was created. Measured in seconds since the Unix epoch. format: unix-time type: integer description: description: >- An arbitrary string attached to the tax rate for your internal use only. It will not be visible to your customers. maxLength: 5000 nullable: true type: string display_name: description: >- The display name of the tax rates as it will appear to your customer on their receipt email, PDF, and the hosted invoice page. maxLength: 5000 type: string effective_percentage: description: >- Actual/effective tax rate percentage out of 100. For tax calculations with automatic_tax[enabled]=true, this percentage reflects the rate actually used to calculate tax based on the product's taxability and whether the user is registered to collect taxes in the corresponding jurisdiction. nullable: true type: number id: description: Unique identifier for the object. maxLength: 5000 type: string inclusive: description: This specifies if the tax rate is inclusive or exclusive. type: boolean jurisdiction: description: >- The jurisdiction for the tax rate. You can use this label field for tax reporting purposes. It also appears on your customer’s invoice. maxLength: 5000 nullable: true type: string jurisdiction_level: description: >- The level of the jurisdiction that imposes this tax rate. Will be `null` for manually defined tax rates. enum: - city - country - county - district - multiple - state nullable: true type: string livemode: description: >- Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. type: boolean metadata: additionalProperties: maxLength: 500 type: string description: >- 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. nullable: true type: object object: description: >- String representing the object's type. Objects of the same type share the same value. enum: - tax_rate type: string percentage: description: >- Tax rate percentage out of 100. For tax calculations with automatic_tax[enabled]=true, this percentage includes the statutory tax rate of non-taxable jurisdictions. type: number state: description: >- [ISO 3166-2 subdivision code](https://en.wikipedia.org/wiki/ISO_3166-2:US), without country prefix. For example, "NY" for New York, United States. maxLength: 5000 nullable: true type: string tax_type: description: 'The high-level tax type, such as `vat` or `sales_tax`.' enum: - amusement_tax - communications_tax - gst - hst - igst - jct - lease_tax - pst - qst - rst - sales_tax - vat nullable: true type: string x-stripeBypassValidation: true required: - active - created - display_name - id - inclusive - livemode - object - percentage title: TaxRate type: object x-expandableFields: [] x-resourceId: tax_rate terminal.configuration: description: >- A Configurations object represents how features should be configured for terminal readers. properties: bbpos_wisepos_e: $ref: >- #/components/schemas/terminal_configuration_configuration_resource_device_type_specific_config id: description: Unique identifier for the object. maxLength: 5000 type: string is_account_default: description: Whether this Configuration is the default for your account nullable: true type: boolean livemode: description: >- Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. type: boolean name: description: >- String indicating the name of the Configuration object, set by the user maxLength: 5000 nullable: true type: string object: description: >- String representing the object's type. Objects of the same type share the same value. enum: - terminal.configuration type: string offline: $ref: >- #/components/schemas/terminal_configuration_configuration_resource_offline_config tipping: $ref: >- #/components/schemas/terminal_configuration_configuration_resource_tipping verifone_p400: $ref: >- #/components/schemas/terminal_configuration_configuration_resource_device_type_specific_config required: - id - livemode - object title: TerminalConfigurationConfiguration type: object x-expandableFields: - bbpos_wisepos_e - offline - tipping - verifone_p400 x-resourceId: terminal.configuration terminal.connection_token: description: >- A Connection Token is used by the Stripe Terminal SDK to connect to a reader. Related guide: [Fleet management](https://stripe.com/docs/terminal/fleet/locations) properties: location: description: >- The id of the location that this connection token is scoped to. Note that location scoping only applies to internet-connected readers. For more details, see [the docs on scoping connection tokens](https://stripe.com/docs/terminal/fleet/locations#connection-tokens). maxLength: 5000 type: string object: description: >- String representing the object's type. Objects of the same type share the same value. enum: - terminal.connection_token type: string secret: description: Your application should pass this token to the Stripe Terminal SDK. maxLength: 5000 type: string required: - object - secret title: TerminalConnectionToken type: object x-expandableFields: [] x-resourceId: terminal.connection_token terminal.location: description: >- A Location represents a grouping of readers. Related guide: [Fleet management](https://stripe.com/docs/terminal/fleet/locations) properties: address: $ref: '#/components/schemas/address' configuration_overrides: description: >- The ID of a configuration that will be used to customize all readers in this location. maxLength: 5000 type: string display_name: description: The display name of the location. maxLength: 5000 type: string id: description: Unique identifier for the object. maxLength: 5000 type: string livemode: description: >- Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. type: boolean metadata: additionalProperties: maxLength: 500 type: string description: >- 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. type: object object: description: >- String representing the object's type. Objects of the same type share the same value. enum: - terminal.location type: string required: - address - display_name - id - livemode - metadata - object title: TerminalLocationLocation type: object x-expandableFields: - address x-resourceId: terminal.location terminal.reader: description: >- A Reader represents a physical device for accepting payment details. Related guide: [Connecting to a reader](https://stripe.com/docs/terminal/payments/connect-reader) properties: action: anyOf: - $ref: >- #/components/schemas/terminal_reader_reader_resource_reader_action description: The most recent action performed by the reader. nullable: true device_sw_version: description: The current software version of the reader. maxLength: 5000 nullable: true type: string device_type: description: >- Type of reader, one of `bbpos_wisepad3`, `stripe_m2`, `bbpos_chipper2x`, `bbpos_wisepos_e`, `verifone_P400`, `simulated_wisepos_e`, or `mobile_phone_reader`. enum: - bbpos_chipper2x - bbpos_wisepad3 - bbpos_wisepos_e - mobile_phone_reader - simulated_wisepos_e - stripe_m2 - verifone_P400 type: string id: description: Unique identifier for the object. maxLength: 5000 type: string ip_address: description: The local IP address of the reader. maxLength: 5000 nullable: true type: string label: description: Custom label given to the reader for easier identification. maxLength: 5000 type: string livemode: description: >- Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. type: boolean location: anyOf: - maxLength: 5000 type: string - $ref: '#/components/schemas/terminal.location' description: The location identifier of the reader. nullable: true x-expansionResources: oneOf: - $ref: '#/components/schemas/terminal.location' metadata: additionalProperties: maxLength: 500 type: string description: >- 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. type: object object: description: >- String representing the object's type. Objects of the same type share the same value. enum: - terminal.reader type: string serial_number: description: Serial number of the reader. maxLength: 5000 type: string status: description: The networking status of the reader. enum: - offline - online nullable: true type: string required: - device_type - id - label - livemode - metadata - object - serial_number title: TerminalReaderReader type: object x-expandableFields: - action - location x-resourceId: terminal.reader terminal_configuration_configuration_resource_currency_specific_config: description: '' properties: fixed_amounts: description: Fixed amounts displayed when collecting a tip items: type: integer nullable: true type: array percentages: description: Percentages displayed when collecting a tip items: type: integer nullable: true type: array smart_tip_threshold: description: >- Below this amount, fixed amounts will be displayed; above it, percentages will be displayed type: integer title: TerminalConfigurationConfigurationResourceCurrencySpecificConfig type: object x-expandableFields: [] terminal_configuration_configuration_resource_device_type_specific_config: description: '' properties: splashscreen: anyOf: - maxLength: 5000 type: string - $ref: '#/components/schemas/file' description: >- A File ID representing an image you would like displayed on the reader. x-expansionResources: oneOf: - $ref: '#/components/schemas/file' title: TerminalConfigurationConfigurationResourceDeviceTypeSpecificConfig type: object x-expandableFields: - splashscreen terminal_configuration_configuration_resource_offline_config: description: '' properties: enabled: description: >- Determines whether to allow transactions to be collected while reader is offline. Defaults to false. nullable: true type: boolean title: TerminalConfigurationConfigurationResourceOfflineConfig type: object x-expandableFields: [] terminal_configuration_configuration_resource_tipping: description: '' properties: aud: $ref: >- #/components/schemas/terminal_configuration_configuration_resource_currency_specific_config cad: $ref: >- #/components/schemas/terminal_configuration_configuration_resource_currency_specific_config chf: $ref: >- #/components/schemas/terminal_configuration_configuration_resource_currency_specific_config czk: $ref: >- #/components/schemas/terminal_configuration_configuration_resource_currency_specific_config dkk: $ref: >- #/components/schemas/terminal_configuration_configuration_resource_currency_specific_config eur: $ref: >- #/components/schemas/terminal_configuration_configuration_resource_currency_specific_config gbp: $ref: >- #/components/schemas/terminal_configuration_configuration_resource_currency_specific_config hkd: $ref: >- #/components/schemas/terminal_configuration_configuration_resource_currency_specific_config myr: $ref: >- #/components/schemas/terminal_configuration_configuration_resource_currency_specific_config nok: $ref: >- #/components/schemas/terminal_configuration_configuration_resource_currency_specific_config nzd: $ref: >- #/components/schemas/terminal_configuration_configuration_resource_currency_specific_config sek: $ref: >- #/components/schemas/terminal_configuration_configuration_resource_currency_specific_config sgd: $ref: >- #/components/schemas/terminal_configuration_configuration_resource_currency_specific_config usd: $ref: >- #/components/schemas/terminal_configuration_configuration_resource_currency_specific_config title: TerminalConfigurationConfigurationResourceTipping type: object x-expandableFields: - aud - cad - chf - czk - dkk - eur - gbp - hkd - myr - nok - nzd - sek - sgd - usd terminal_reader_reader_resource_cart: description: Represents a cart to be displayed on the reader properties: currency: description: >- 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). type: string line_items: description: List of line items in the cart. items: $ref: '#/components/schemas/terminal_reader_reader_resource_line_item' type: array tax: description: >- Tax amount for the entire cart. A positive integer in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). nullable: true type: integer total: description: >- Total amount for the entire cart, including tax. A positive integer in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). type: integer required: - currency - line_items - total title: TerminalReaderReaderResourceCart type: object x-expandableFields: - line_items terminal_reader_reader_resource_line_item: description: Represents a line item to be displayed on the reader properties: amount: description: >- The amount of the line item. A positive integer in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). type: integer description: description: Description of the line item. maxLength: 5000 type: string quantity: description: The quantity of the line item. type: integer required: - amount - description - quantity title: TerminalReaderReaderResourceLineItem type: object x-expandableFields: [] terminal_reader_reader_resource_process_config: description: Represents a per-transaction override of a reader configuration properties: enable_customer_cancellation: description: Enable customer initiated cancellation when processing this payment. type: boolean skip_tipping: description: Override showing a tipping selection screen on this transaction. type: boolean tipping: $ref: '#/components/schemas/terminal_reader_reader_resource_tipping_config' title: TerminalReaderReaderResourceProcessConfig type: object x-expandableFields: - tipping terminal_reader_reader_resource_process_payment_intent_action: description: Represents a reader action to process a payment intent properties: payment_intent: anyOf: - maxLength: 5000 type: string - $ref: '#/components/schemas/payment_intent' description: Most recent PaymentIntent processed by the reader. x-expansionResources: oneOf: - $ref: '#/components/schemas/payment_intent' process_config: $ref: '#/components/schemas/terminal_reader_reader_resource_process_config' required: - payment_intent title: TerminalReaderReaderResourceProcessPaymentIntentAction type: object x-expandableFields: - payment_intent - process_config terminal_reader_reader_resource_process_setup_config: description: Represents a per-setup override of a reader configuration properties: enable_customer_cancellation: description: >- Enable customer initiated cancellation when processing this SetupIntent. type: boolean title: TerminalReaderReaderResourceProcessSetupConfig type: object x-expandableFields: [] terminal_reader_reader_resource_process_setup_intent_action: description: Represents a reader action to process a setup intent properties: generated_card: description: >- ID of a card PaymentMethod generated from the card_present PaymentMethod that may be attached to a Customer for future transactions. Only present if it was possible to generate a card PaymentMethod. maxLength: 5000 type: string process_config: $ref: >- #/components/schemas/terminal_reader_reader_resource_process_setup_config setup_intent: anyOf: - maxLength: 5000 type: string - $ref: '#/components/schemas/setup_intent' description: Most recent SetupIntent processed by the reader. x-expansionResources: oneOf: - $ref: '#/components/schemas/setup_intent' required: - setup_intent title: TerminalReaderReaderResourceProcessSetupIntentAction type: object x-expandableFields: - process_config - setup_intent terminal_reader_reader_resource_reader_action: description: Represents an action performed by the reader properties: failure_code: description: 'Failure code, only set if status is `failed`.' maxLength: 5000 nullable: true type: string failure_message: description: 'Detailed failure message, only set if status is `failed`.' maxLength: 5000 nullable: true type: string process_payment_intent: $ref: >- #/components/schemas/terminal_reader_reader_resource_process_payment_intent_action process_setup_intent: $ref: >- #/components/schemas/terminal_reader_reader_resource_process_setup_intent_action refund_payment: $ref: >- #/components/schemas/terminal_reader_reader_resource_refund_payment_action set_reader_display: $ref: >- #/components/schemas/terminal_reader_reader_resource_set_reader_display_action status: description: Status of the action performed by the reader. enum: - failed - in_progress - succeeded type: string type: description: Type of action performed by the reader. enum: - process_payment_intent - process_setup_intent - refund_payment - set_reader_display type: string x-stripeBypassValidation: true required: - status - type title: TerminalReaderReaderResourceReaderAction type: object x-expandableFields: - process_payment_intent - process_setup_intent - refund_payment - set_reader_display terminal_reader_reader_resource_refund_payment_action: description: Represents a reader action to refund a payment properties: amount: description: The amount being refunded. type: integer charge: anyOf: - maxLength: 5000 type: string - $ref: '#/components/schemas/charge' description: Charge that is being refunded. x-expansionResources: oneOf: - $ref: '#/components/schemas/charge' metadata: additionalProperties: maxLength: 500 type: string description: >- 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. type: object payment_intent: anyOf: - maxLength: 5000 type: string - $ref: '#/components/schemas/payment_intent' description: Payment intent that is being refunded. x-expansionResources: oneOf: - $ref: '#/components/schemas/payment_intent' reason: description: The reason for the refund. enum: - duplicate - fraudulent - requested_by_customer type: string refund: anyOf: - maxLength: 5000 type: string - $ref: '#/components/schemas/refund' description: Unique identifier for the refund object. x-expansionResources: oneOf: - $ref: '#/components/schemas/refund' refund_application_fee: description: >- Boolean indicating whether the application fee should be refunded when refunding this charge. If a full charge refund is given, the full application fee will be refunded. Otherwise, the application fee will be refunded in an amount proportional to the amount of the charge refunded. An application fee can be refunded only by the application that created the charge. type: boolean refund_payment_config: $ref: >- #/components/schemas/terminal_reader_reader_resource_refund_payment_config reverse_transfer: description: >- Boolean indicating whether the transfer should be reversed when refunding this charge. The transfer will be reversed proportionally to the amount being refunded (either the entire or partial amount). A transfer can be reversed only by the application that created the charge. type: boolean title: TerminalReaderReaderResourceRefundPaymentAction type: object x-expandableFields: - charge - payment_intent - refund - refund_payment_config terminal_reader_reader_resource_refund_payment_config: description: Represents a per-transaction override of a reader configuration properties: enable_customer_cancellation: description: Enable customer initiated cancellation when refunding this payment. type: boolean title: TerminalReaderReaderResourceRefundPaymentConfig type: object x-expandableFields: [] terminal_reader_reader_resource_set_reader_display_action: description: Represents a reader action to set the reader display properties: cart: anyOf: - $ref: '#/components/schemas/terminal_reader_reader_resource_cart' description: Cart object to be displayed by the reader. nullable: true type: description: Type of information to be displayed by the reader. enum: - cart type: string required: - type title: TerminalReaderReaderResourceSetReaderDisplayAction type: object x-expandableFields: - cart terminal_reader_reader_resource_tipping_config: description: Represents a per-transaction tipping configuration properties: amount_eligible: description: >- Amount used to calculate tip suggestions on tipping selection screen for this transaction. Must be a positive integer in the smallest currency unit (e.g., 100 cents to represent $1.00 or 100 to represent ¥100, a zero-decimal currency). type: integer title: TerminalReaderReaderResourceTippingConfig type: object x-expandableFields: [] test_helpers.test_clock: description: >- 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. properties: created: description: >- Time at which the object was created. Measured in seconds since the Unix epoch. format: unix-time type: integer deletes_after: description: Time at which this clock is scheduled to auto delete. format: unix-time type: integer frozen_time: description: Time at which all objects belonging to this clock are frozen. format: unix-time type: integer id: description: Unique identifier for the object. maxLength: 5000 type: string livemode: description: >- Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. type: boolean name: description: The custom name supplied at creation. maxLength: 5000 nullable: true type: string object: description: >- String representing the object's type. Objects of the same type share the same value. enum: - test_helpers.test_clock type: string status: description: The status of the Test Clock. enum: - advancing - internal_failure - ready type: string required: - created - deletes_after - frozen_time - id - livemode - object - status title: TestClock type: object x-expandableFields: [] x-resourceId: test_helpers.test_clock three_d_secure_details: description: '' properties: authentication_flow: description: >- For authenticated transactions: how the customer was authenticated by the issuing bank. enum: - challenge - frictionless nullable: true type: string electronic_commerce_indicator: description: |- The Electronic Commerce Indicator (ECI). A protocol-level field indicating what degree of authentication was performed. enum: - '01' - '02' - '05' - '06' - '07' nullable: true type: string x-stripeBypassValidation: true result: description: Indicates the outcome of 3D Secure authentication. enum: - attempt_acknowledged - authenticated - exempted - failed - not_supported - processing_error nullable: true type: string result_reason: description: |- Additional information about why 3D Secure succeeded or failed based on the `result`. enum: - abandoned - bypassed - canceled - card_not_enrolled - network_not_supported - protocol_error - rejected nullable: true type: string transaction_id: description: |- The 3D Secure 1 XID or 3D Secure 2 Directory Server Transaction ID (dsTransId) for this payment. maxLength: 5000 nullable: true type: string version: description: The version of 3D Secure that was used. enum: - 1.0.2 - 2.1.0 - 2.2.0 nullable: true type: string x-stripeBypassValidation: true title: three_d_secure_details type: object x-expandableFields: [] three_d_secure_details_charge: description: '' properties: authentication_flow: description: >- For authenticated transactions: how the customer was authenticated by the issuing bank. enum: - challenge - frictionless nullable: true type: string electronic_commerce_indicator: description: |- The Electronic Commerce Indicator (ECI). A protocol-level field indicating what degree of authentication was performed. enum: - '01' - '02' - '05' - '06' - '07' nullable: true type: string x-stripeBypassValidation: true exemption_indicator: description: >- The exemption requested via 3DS and accepted by the issuer at authentication time. enum: - low_risk - none nullable: true type: string exemption_indicator_applied: description: >- Whether Stripe requested the value of `exemption_indicator` in the transaction. This will depend on the outcome of Stripe's internal risk assessment. type: boolean result: description: Indicates the outcome of 3D Secure authentication. enum: - attempt_acknowledged - authenticated - exempted - failed - not_supported - processing_error nullable: true type: string result_reason: description: |- Additional information about why 3D Secure succeeded or failed based on the `result`. enum: - abandoned - bypassed - canceled - card_not_enrolled - network_not_supported - protocol_error - rejected nullable: true type: string transaction_id: description: |- The 3D Secure 1 XID or 3D Secure 2 Directory Server Transaction ID (dsTransId) for this payment. maxLength: 5000 nullable: true type: string version: description: The version of 3D Secure that was used. enum: - 1.0.2 - 2.1.0 - 2.2.0 nullable: true type: string x-stripeBypassValidation: true title: three_d_secure_details_charge type: object x-expandableFields: [] three_d_secure_usage: description: '' properties: supported: description: Whether 3D Secure is supported on this card. type: boolean required: - supported title: three_d_secure_usage type: object x-expandableFields: [] token: description: >- Tokenization is the process Stripe uses to collect sensitive card or bank account details, or personally identifiable information (PII), directly from your customers in a secure manner. A token representing this information is returned to your server to use. Use our [recommended payments integrations](https://stripe.com/docs/payments) to perform this process on the client-side. This guarantees that no sensitive card data touches your server, and allows your integration to operate in a PCI-compliant way. If you can't use client-side tokenization, you can also create tokens using the API with either your publishable or secret API key. If your integration uses this method, you're responsible for any PCI compliance that it might require, and you must keep your secret API key safe. Unlike with client-side tokenization, your customer's information isn't sent directly to Stripe, so we can't determine how it's handled or stored. You can't store or use tokens more than once. To store card or bank account information for later use, create [Customer](https://stripe.com/docs/api#customers) objects or [Custom accounts](https://stripe.com/docs/api#external_accounts). [Radar](https://stripe.com/docs/radar), our integrated solution for automatic fraud protection, performs best with integrations that use client-side tokenization. properties: bank_account: $ref: '#/components/schemas/bank_account' card: $ref: '#/components/schemas/card' client_ip: description: IP address of the client that generates the token. maxLength: 5000 nullable: true type: string created: description: >- Time at which the object was created. Measured in seconds since the Unix epoch. format: unix-time type: integer id: description: Unique identifier for the object. maxLength: 5000 type: string livemode: description: >- Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. type: boolean object: description: >- String representing the object's type. Objects of the same type share the same value. enum: - token type: string type: description: 'Type of the token: `account`, `bank_account`, `card`, or `pii`.' maxLength: 5000 type: string used: description: >- Determines if you have already used this token (you can only use tokens once). type: boolean required: - created - id - livemode - object - type - used title: Token type: object x-expandableFields: - bank_account - card x-resourceId: token token_card_networks: description: '' properties: preferred: description: >- 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. maxLength: 5000 nullable: true type: string title: token_card_networks type: object x-expandableFields: [] topup: description: >- To top up your Stripe balance, you create a top-up object. You can retrieve individual top-ups, as well as list all top-ups. Top-ups are identified by a unique, random ID. Related guide: [Topping up your platform account](https://stripe.com/docs/connect/top-ups) properties: amount: description: Amount transferred. type: integer balance_transaction: anyOf: - maxLength: 5000 type: string - $ref: '#/components/schemas/balance_transaction' description: >- ID of the balance transaction that describes the impact of this top-up on your account balance. May not be specified depending on status of top-up. nullable: true x-expansionResources: oneOf: - $ref: '#/components/schemas/balance_transaction' created: description: >- Time at which the object was created. Measured in seconds since the Unix epoch. format: unix-time type: integer currency: description: >- 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). maxLength: 5000 type: string description: description: >- An arbitrary string attached to the object. Often useful for displaying to users. maxLength: 5000 nullable: true type: string expected_availability_date: description: >- Date the funds are expected to arrive in your Stripe account for payouts. This factors in delays like weekends or bank holidays. May not be specified depending on status of top-up. nullable: true type: integer failure_code: description: >- Error code explaining reason for top-up failure if available (see [the errors section](https://stripe.com/docs/api#errors) for a list of codes). maxLength: 5000 nullable: true type: string failure_message: description: >- Message to user further explaining reason for top-up failure if available. maxLength: 5000 nullable: true type: string id: description: Unique identifier for the object. maxLength: 5000 type: string livemode: description: >- Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. type: boolean metadata: additionalProperties: maxLength: 500 type: string description: >- 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. type: object object: description: >- String representing the object's type. Objects of the same type share the same value. enum: - topup type: string source: anyOf: - $ref: '#/components/schemas/source' description: >- The source field is deprecated. It might not always be present in the API response. nullable: true statement_descriptor: description: >- Extra information about a top-up. This will appear on your source's bank statement. It must contain at least one letter. maxLength: 5000 nullable: true type: string status: description: >- The status of the top-up is either `canceled`, `failed`, `pending`, `reversed`, or `succeeded`. enum: - canceled - failed - pending - reversed - succeeded type: string transfer_group: description: A string that identifies this top-up as part of a group. maxLength: 5000 nullable: true type: string required: - amount - created - currency - id - livemode - metadata - object - status title: Topup type: object x-expandableFields: - balance_transaction - source x-resourceId: topup transfer: description: >- A `Transfer` object is created when you move funds between Stripe accounts as part of Connect. Before April 6, 2017, transfers also represented movement of funds from a Stripe account to a card or bank account. This behavior has since been split out into a [Payout](https://stripe.com/docs/api#payout_object) object, with corresponding payout endpoints. For more information, read about the [transfer/payout split](https://stripe.com/docs/transfer-payout-split). Related guide: [Creating separate charges and transfers](https://stripe.com/docs/connect/separate-charges-and-transfers) properties: amount: description: Amount in cents (or local equivalent) to be transferred. type: integer amount_reversed: description: >- Amount in cents (or local equivalent) reversed (can be less than the amount attribute on the transfer if a partial reversal was issued). type: integer balance_transaction: anyOf: - maxLength: 5000 type: string - $ref: '#/components/schemas/balance_transaction' description: >- Balance transaction that describes the impact of this transfer on your account balance. nullable: true x-expansionResources: oneOf: - $ref: '#/components/schemas/balance_transaction' created: description: Time that this record of the transfer was first created. format: unix-time type: integer currency: description: >- 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). type: string description: description: >- An arbitrary string attached to the object. Often useful for displaying to users. maxLength: 5000 nullable: true type: string destination: anyOf: - maxLength: 5000 type: string - $ref: '#/components/schemas/account' description: ID of the Stripe account the transfer was sent to. nullable: true x-expansionResources: oneOf: - $ref: '#/components/schemas/account' destination_payment: anyOf: - maxLength: 5000 type: string - $ref: '#/components/schemas/charge' description: >- If the destination is a Stripe account, this will be the ID of the payment that the destination account received for the transfer. x-expansionResources: oneOf: - $ref: '#/components/schemas/charge' id: description: Unique identifier for the object. maxLength: 5000 type: string livemode: description: >- Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. type: boolean metadata: additionalProperties: maxLength: 500 type: string description: >- 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. type: object object: description: >- String representing the object's type. Objects of the same type share the same value. enum: - transfer type: string reversals: description: A list of reversals that have been applied to the transfer. properties: data: description: Details about each object. items: $ref: '#/components/schemas/transfer_reversal' type: array has_more: description: >- True if this list has another page of items after this one that can be fetched. type: boolean object: description: >- String representing the object's type. Objects of the same type share the same value. Always has the value `list`. enum: - list type: string url: description: The URL where this list can be accessed. maxLength: 5000 type: string required: - data - has_more - object - url title: TransferReversalList type: object x-expandableFields: - data reversed: description: >- Whether the transfer has been fully reversed. If the transfer is only partially reversed, this attribute will still be false. type: boolean source_transaction: anyOf: - maxLength: 5000 type: string - $ref: '#/components/schemas/charge' description: >- ID of the charge or payment that was used to fund the transfer. If null, the transfer was funded from the available balance. nullable: true x-expansionResources: oneOf: - $ref: '#/components/schemas/charge' source_type: description: >- The source balance this transfer came from. One of `card`, `fpx`, or `bank_account`. maxLength: 5000 type: string transfer_group: description: >- 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. maxLength: 5000 nullable: true type: string required: - amount - amount_reversed - created - currency - id - livemode - metadata - object - reversals - reversed title: Transfer type: object x-expandableFields: - balance_transaction - destination - destination_payment - reversals - source_transaction x-resourceId: transfer transfer_data: description: '' properties: amount: description: >- 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). type: integer destination: anyOf: - maxLength: 5000 type: string - $ref: '#/components/schemas/account' description: |- The account (if any) that the payment is attributed to for tax reporting, and where funds from the payment are transferred to after payment success. x-expansionResources: oneOf: - $ref: '#/components/schemas/account' required: - destination title: transfer_data type: object x-expandableFields: - destination transfer_reversal: description: >- [Stripe Connect](https://stripe.com/docs/connect) platforms can reverse transfers made to a connected account, either entirely or partially, and can also specify whether to refund any related application fees. Transfer reversals add to the platform's balance and subtract from the destination account's balance. Reversing a transfer that was made for a [destination charge](/docs/connect/destination-charges) is allowed only up to the amount of the charge. It is possible to reverse a [transfer_group](https://stripe.com/docs/connect/separate-charges-and-transfers#transfer-options) transfer only if the destination account has enough balance to cover the reversal. Related guide: [Reverse transfers](https://stripe.com/docs/connect/separate-charges-and-transfers#reverse-transfers) properties: amount: description: 'Amount, in cents (or local equivalent).' type: integer balance_transaction: anyOf: - maxLength: 5000 type: string - $ref: '#/components/schemas/balance_transaction' description: >- Balance transaction that describes the impact on your account balance. nullable: true x-expansionResources: oneOf: - $ref: '#/components/schemas/balance_transaction' created: description: >- Time at which the object was created. Measured in seconds since the Unix epoch. format: unix-time type: integer currency: description: >- 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). type: string destination_payment_refund: anyOf: - maxLength: 5000 type: string - $ref: '#/components/schemas/refund' description: Linked payment refund for the transfer reversal. nullable: true x-expansionResources: oneOf: - $ref: '#/components/schemas/refund' id: description: Unique identifier for the object. maxLength: 5000 type: string metadata: additionalProperties: maxLength: 500 type: string description: >- 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. nullable: true type: object object: description: >- String representing the object's type. Objects of the same type share the same value. enum: - transfer_reversal type: string source_refund: anyOf: - maxLength: 5000 type: string - $ref: '#/components/schemas/refund' description: ID of the refund responsible for the transfer reversal. nullable: true x-expansionResources: oneOf: - $ref: '#/components/schemas/refund' transfer: anyOf: - maxLength: 5000 type: string - $ref: '#/components/schemas/transfer' description: ID of the transfer that was reversed. x-expansionResources: oneOf: - $ref: '#/components/schemas/transfer' required: - amount - created - currency - id - object - transfer title: TransferReversal type: object x-expandableFields: - balance_transaction - destination_payment_refund - source_refund - transfer x-resourceId: transfer_reversal transfer_schedule: description: '' properties: delay_days: description: >- The number of days charges for the account will be held before being paid out. type: integer interval: description: >- How frequently funds will be paid out. One of `manual` (payouts only created via API call), `daily`, `weekly`, or `monthly`. maxLength: 5000 type: string monthly_anchor: description: >- The day of the month funds will be paid out. Only shown if `interval` is monthly. Payouts scheduled between the 29th and 31st of the month are sent on the last day of shorter months. type: integer weekly_anchor: description: >- The day of the week funds will be paid out, of the style 'monday', 'tuesday', etc. Only shown if `interval` is weekly. maxLength: 5000 type: string required: - delay_days - interval title: TransferSchedule type: object x-expandableFields: [] transform_quantity: description: '' properties: divide_by: description: Divide usage by this number. type: integer round: description: 'After division, either round the result `up` or `down`.' enum: - down - up type: string required: - divide_by - round title: TransformQuantity type: object x-expandableFields: [] transform_usage: description: '' properties: divide_by: description: Divide usage by this number. type: integer round: description: 'After division, either round the result `up` or `down`.' enum: - down - up type: string required: - divide_by - round title: TransformUsage type: object x-expandableFields: [] treasury.credit_reversal: description: >- You can reverse some [ReceivedCredits](https://stripe.com/docs/api#received_credits) depending on their network and source flow. Reversing a ReceivedCredit leads to the creation of a new object known as a CreditReversal. properties: amount: description: Amount (in cents) transferred. type: integer created: description: >- Time at which the object was created. Measured in seconds since the Unix epoch. format: unix-time type: integer currency: description: >- 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). type: string financial_account: description: The FinancialAccount to reverse funds from. maxLength: 5000 type: string hosted_regulatory_receipt_url: description: >- A [hosted transaction receipt](https://stripe.com/docs/treasury/moving-money/regulatory-receipts) URL that is provided when money movement is considered regulated under Stripe's money transmission licenses. maxLength: 5000 nullable: true type: string id: description: Unique identifier for the object. maxLength: 5000 type: string livemode: description: >- Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. type: boolean metadata: additionalProperties: maxLength: 500 type: string description: >- 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. type: object network: description: The rails used to reverse the funds. enum: - ach - stripe type: string object: description: >- String representing the object's type. Objects of the same type share the same value. enum: - treasury.credit_reversal type: string received_credit: description: The ReceivedCredit being reversed. maxLength: 5000 type: string status: description: Status of the CreditReversal enum: - canceled - posted - processing type: string status_transitions: $ref: >- #/components/schemas/treasury_received_credits_resource_status_transitions transaction: anyOf: - maxLength: 5000 type: string - $ref: '#/components/schemas/treasury.transaction' description: The Transaction associated with this object. nullable: true x-expansionResources: oneOf: - $ref: '#/components/schemas/treasury.transaction' required: - amount - created - currency - financial_account - id - livemode - metadata - network - object - received_credit - status - status_transitions title: TreasuryReceivedCreditsResourceCreditReversal type: object x-expandableFields: - status_transitions - transaction x-resourceId: treasury.credit_reversal treasury.debit_reversal: description: >- You can reverse some [ReceivedDebits](https://stripe.com/docs/api#received_debits) depending on their network and source flow. Reversing a ReceivedDebit leads to the creation of a new object known as a DebitReversal. properties: amount: description: Amount (in cents) transferred. type: integer created: description: >- Time at which the object was created. Measured in seconds since the Unix epoch. format: unix-time type: integer currency: description: >- 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). type: string financial_account: description: The FinancialAccount to reverse funds from. maxLength: 5000 nullable: true type: string hosted_regulatory_receipt_url: description: >- A [hosted transaction receipt](https://stripe.com/docs/treasury/moving-money/regulatory-receipts) URL that is provided when money movement is considered regulated under Stripe's money transmission licenses. maxLength: 5000 nullable: true type: string id: description: Unique identifier for the object. maxLength: 5000 type: string linked_flows: anyOf: - $ref: >- #/components/schemas/treasury_received_debits_resource_debit_reversal_linked_flows description: Other flows linked to a DebitReversal. nullable: true livemode: description: >- Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. type: boolean metadata: additionalProperties: maxLength: 500 type: string description: >- 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. type: object network: description: The rails used to reverse the funds. enum: - ach - card type: string object: description: >- String representing the object's type. Objects of the same type share the same value. enum: - treasury.debit_reversal type: string received_debit: description: The ReceivedDebit being reversed. maxLength: 5000 type: string status: description: Status of the DebitReversal enum: - failed - processing - succeeded type: string status_transitions: $ref: >- #/components/schemas/treasury_received_debits_resource_status_transitions transaction: anyOf: - maxLength: 5000 type: string - $ref: '#/components/schemas/treasury.transaction' description: The Transaction associated with this object. nullable: true x-expansionResources: oneOf: - $ref: '#/components/schemas/treasury.transaction' required: - amount - created - currency - id - livemode - metadata - network - object - received_debit - status - status_transitions title: TreasuryReceivedDebitsResourceDebitReversal type: object x-expandableFields: - linked_flows - status_transitions - transaction x-resourceId: treasury.debit_reversal treasury.financial_account: description: >- Stripe Treasury provides users with a container for money called a FinancialAccount that is separate from their Payments balance. FinancialAccounts serve as the source and destination of Treasury’s money movement APIs. properties: active_features: description: The array of paths to active Features in the Features hash. items: enum: - card_issuing - deposit_insurance - financial_addresses.aba - inbound_transfers.ach - intra_stripe_flows - outbound_payments.ach - outbound_payments.us_domestic_wire - outbound_transfers.ach - outbound_transfers.us_domestic_wire - remote_deposit_capture type: string x-stripeBypassValidation: true type: array balance: $ref: '#/components/schemas/treasury_financial_accounts_resource_balance' country: description: >- Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)). maxLength: 5000 type: string created: description: >- Time at which the object was created. Measured in seconds since the Unix epoch. format: unix-time type: integer features: $ref: '#/components/schemas/treasury.financial_account_features' financial_addresses: description: The set of credentials that resolve to a FinancialAccount. items: $ref: >- #/components/schemas/treasury_financial_accounts_resource_financial_address type: array id: description: Unique identifier for the object. maxLength: 5000 type: string livemode: description: >- Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. type: boolean metadata: additionalProperties: maxLength: 500 type: string description: >- 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. nullable: true type: object object: description: >- String representing the object's type. Objects of the same type share the same value. enum: - treasury.financial_account type: string pending_features: description: The array of paths to pending Features in the Features hash. items: enum: - card_issuing - deposit_insurance - financial_addresses.aba - inbound_transfers.ach - intra_stripe_flows - outbound_payments.ach - outbound_payments.us_domestic_wire - outbound_transfers.ach - outbound_transfers.us_domestic_wire - remote_deposit_capture type: string x-stripeBypassValidation: true type: array platform_restrictions: anyOf: - $ref: >- #/components/schemas/treasury_financial_accounts_resource_platform_restrictions description: >- The set of functionalities that the platform can restrict on the FinancialAccount. nullable: true restricted_features: description: The array of paths to restricted Features in the Features hash. items: enum: - card_issuing - deposit_insurance - financial_addresses.aba - inbound_transfers.ach - intra_stripe_flows - outbound_payments.ach - outbound_payments.us_domestic_wire - outbound_transfers.ach - outbound_transfers.us_domestic_wire - remote_deposit_capture type: string x-stripeBypassValidation: true type: array status: description: The enum specifying what state the account is in. enum: - closed - open type: string x-stripeBypassValidation: true status_details: $ref: >- #/components/schemas/treasury_financial_accounts_resource_status_details supported_currencies: description: >- The currencies the FinancialAccount can hold a balance in. Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. items: type: string type: array required: - balance - country - created - financial_addresses - id - livemode - object - status - status_details - supported_currencies title: TreasuryFinancialAccountsResourceFinancialAccount type: object x-expandableFields: - balance - features - financial_addresses - platform_restrictions - status_details x-resourceId: treasury.financial_account treasury.financial_account_features: description: >- Encodes whether a FinancialAccount has access to a particular Feature, with a `status` enum and associated `status_details`. Stripe or the platform can control Features via the requested field. properties: card_issuing: $ref: >- #/components/schemas/treasury_financial_accounts_resource_toggle_settings deposit_insurance: $ref: >- #/components/schemas/treasury_financial_accounts_resource_toggle_settings financial_addresses: $ref: >- #/components/schemas/treasury_financial_accounts_resource_financial_addresses_features inbound_transfers: $ref: >- #/components/schemas/treasury_financial_accounts_resource_inbound_transfers intra_stripe_flows: $ref: >- #/components/schemas/treasury_financial_accounts_resource_toggle_settings object: description: >- String representing the object's type. Objects of the same type share the same value. enum: - treasury.financial_account_features type: string outbound_payments: $ref: >- #/components/schemas/treasury_financial_accounts_resource_outbound_payments outbound_transfers: $ref: >- #/components/schemas/treasury_financial_accounts_resource_outbound_transfers required: - object title: TreasuryFinancialAccountsResourceFinancialAccountFeatures type: object x-expandableFields: - card_issuing - deposit_insurance - financial_addresses - inbound_transfers - intra_stripe_flows - outbound_payments - outbound_transfers x-resourceId: treasury.financial_account_features treasury.inbound_transfer: description: >- Use [InboundTransfers](https://stripe.com/docs/treasury/moving-money/financial-accounts/into/inbound-transfers) to add funds to your [FinancialAccount](https://stripe.com/docs/api#financial_accounts) via a PaymentMethod that is owned by you. The funds will be transferred via an ACH debit. properties: amount: description: Amount (in cents) transferred. type: integer cancelable: description: Returns `true` if the InboundTransfer is able to be canceled. type: boolean created: description: >- Time at which the object was created. Measured in seconds since the Unix epoch. format: unix-time type: integer currency: description: >- 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). type: string description: description: >- An arbitrary string attached to the object. Often useful for displaying to users. maxLength: 5000 nullable: true type: string failure_details: anyOf: - $ref: >- #/components/schemas/treasury_inbound_transfers_resource_failure_details description: >- Details about this InboundTransfer's failure. Only set when status is `failed`. nullable: true financial_account: description: The FinancialAccount that received the funds. maxLength: 5000 type: string hosted_regulatory_receipt_url: description: >- A [hosted transaction receipt](https://stripe.com/docs/treasury/moving-money/regulatory-receipts) URL that is provided when money movement is considered regulated under Stripe's money transmission licenses. maxLength: 5000 nullable: true type: string id: description: Unique identifier for the object. maxLength: 5000 type: string linked_flows: $ref: >- #/components/schemas/treasury_inbound_transfers_resource_inbound_transfer_resource_linked_flows livemode: description: >- Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. type: boolean metadata: additionalProperties: maxLength: 500 type: string description: >- 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. type: object object: description: >- String representing the object's type. Objects of the same type share the same value. enum: - treasury.inbound_transfer type: string origin_payment_method: description: The origin payment method to be debited for an InboundTransfer. maxLength: 5000 type: string origin_payment_method_details: anyOf: - $ref: '#/components/schemas/inbound_transfers' description: Details about the PaymentMethod for an InboundTransfer. nullable: true returned: description: >- Returns `true` if the funds for an InboundTransfer were returned after the InboundTransfer went to the `succeeded` state. nullable: true type: boolean statement_descriptor: description: >- Statement descriptor shown when funds are debited from the source. Not all payment networks support `statement_descriptor`. maxLength: 5000 type: string status: description: >- Status of the InboundTransfer: `processing`, `succeeded`, `failed`, and `canceled`. An InboundTransfer is `processing` if it is created and pending. The status changes to `succeeded` once the funds have been "confirmed" and a `transaction` is created and posted. The status changes to `failed` if the transfer fails. enum: - canceled - failed - processing - succeeded type: string status_transitions: $ref: >- #/components/schemas/treasury_inbound_transfers_resource_inbound_transfer_resource_status_transitions transaction: anyOf: - maxLength: 5000 type: string - $ref: '#/components/schemas/treasury.transaction' description: The Transaction associated with this object. nullable: true x-expansionResources: oneOf: - $ref: '#/components/schemas/treasury.transaction' required: - amount - cancelable - created - currency - financial_account - id - linked_flows - livemode - metadata - object - origin_payment_method - statement_descriptor - status - status_transitions title: TreasuryInboundTransfersResourceInboundTransfer type: object x-expandableFields: - failure_details - linked_flows - origin_payment_method_details - status_transitions - transaction x-resourceId: treasury.inbound_transfer treasury.outbound_payment: description: >- Use OutboundPayments to send funds to another party's external bank account or [FinancialAccount](https://stripe.com/docs/api#financial_accounts). To send money to an account belonging to the same user, use an [OutboundTransfer](https://stripe.com/docs/api#outbound_transfers). Simulate OutboundPayment state changes with the `/v1/test_helpers/treasury/outbound_payments` endpoints. These methods can only be called on test mode objects. properties: amount: description: Amount (in cents) transferred. type: integer cancelable: description: 'Returns `true` if the object can be canceled, and `false` otherwise.' type: boolean created: description: >- Time at which the object was created. Measured in seconds since the Unix epoch. format: unix-time type: integer currency: description: >- 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). type: string customer: description: >- ID of the [customer](https://stripe.com/docs/api/customers) to whom an OutboundPayment is sent. maxLength: 5000 nullable: true type: string description: description: >- An arbitrary string attached to the object. Often useful for displaying to users. maxLength: 5000 nullable: true type: string destination_payment_method: description: >- The PaymentMethod via which an OutboundPayment is sent. This field can be empty if the OutboundPayment was created using `destination_payment_method_data`. maxLength: 5000 nullable: true type: string destination_payment_method_details: anyOf: - $ref: '#/components/schemas/outbound_payments_payment_method_details' description: Details about the PaymentMethod for an OutboundPayment. nullable: true end_user_details: anyOf: - $ref: >- #/components/schemas/treasury_outbound_payments_resource_outbound_payment_resource_end_user_details description: Details about the end user. nullable: true expected_arrival_date: description: >- The date when funds are expected to arrive in the destination account. format: unix-time type: integer financial_account: description: The FinancialAccount that funds were pulled from. maxLength: 5000 type: string hosted_regulatory_receipt_url: description: >- A [hosted transaction receipt](https://stripe.com/docs/treasury/moving-money/regulatory-receipts) URL that is provided when money movement is considered regulated under Stripe's money transmission licenses. maxLength: 5000 nullable: true type: string id: description: Unique identifier for the object. maxLength: 5000 type: string livemode: description: >- Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. type: boolean metadata: additionalProperties: maxLength: 500 type: string description: >- 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. type: object object: description: >- String representing the object's type. Objects of the same type share the same value. enum: - treasury.outbound_payment type: string returned_details: anyOf: - $ref: >- #/components/schemas/treasury_outbound_payments_resource_returned_status description: >- Details about a returned OutboundPayment. Only set when the status is `returned`. nullable: true statement_descriptor: description: >- The description that appears on the receiving end for an OutboundPayment (for example, bank statement for external bank transfer). maxLength: 5000 type: string status: description: >- Current status of the OutboundPayment: `processing`, `failed`, `posted`, `returned`, `canceled`. An OutboundPayment is `processing` if it has been created and is pending. The status changes to `posted` once the OutboundPayment has been "confirmed" and funds have left the account, or to `failed` or `canceled`. If an OutboundPayment fails to arrive at its destination, its status will change to `returned`. enum: - canceled - failed - posted - processing - returned type: string status_transitions: $ref: >- #/components/schemas/treasury_outbound_payments_resource_outbound_payment_resource_status_transitions transaction: anyOf: - maxLength: 5000 type: string - $ref: '#/components/schemas/treasury.transaction' description: The Transaction associated with this object. x-expansionResources: oneOf: - $ref: '#/components/schemas/treasury.transaction' required: - amount - cancelable - created - currency - expected_arrival_date - financial_account - id - livemode - metadata - object - statement_descriptor - status - status_transitions - transaction title: TreasuryOutboundPaymentsResourceOutboundPayment type: object x-expandableFields: - destination_payment_method_details - end_user_details - returned_details - status_transitions - transaction x-resourceId: treasury.outbound_payment treasury.outbound_transfer: description: >- Use OutboundTransfers to transfer funds from a [FinancialAccount](https://stripe.com/docs/api#financial_accounts) to a PaymentMethod belonging to the same entity. To send funds to a different party, use [OutboundPayments](https://stripe.com/docs/api#outbound_payments) instead. You can send funds over ACH rails or through a domestic wire transfer to a user's own external bank account. Simulate OutboundTransfer state changes with the `/v1/test_helpers/treasury/outbound_transfers` endpoints. These methods can only be called on test mode objects. properties: amount: description: Amount (in cents) transferred. type: integer cancelable: description: 'Returns `true` if the object can be canceled, and `false` otherwise.' type: boolean created: description: >- Time at which the object was created. Measured in seconds since the Unix epoch. format: unix-time type: integer currency: description: >- 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). type: string description: description: >- An arbitrary string attached to the object. Often useful for displaying to users. maxLength: 5000 nullable: true type: string destination_payment_method: description: >- The PaymentMethod used as the payment instrument for an OutboundTransfer. maxLength: 5000 nullable: true type: string destination_payment_method_details: $ref: '#/components/schemas/outbound_transfers_payment_method_details' expected_arrival_date: description: >- The date when funds are expected to arrive in the destination account. format: unix-time type: integer financial_account: description: The FinancialAccount that funds were pulled from. maxLength: 5000 type: string hosted_regulatory_receipt_url: description: >- A [hosted transaction receipt](https://stripe.com/docs/treasury/moving-money/regulatory-receipts) URL that is provided when money movement is considered regulated under Stripe's money transmission licenses. maxLength: 5000 nullable: true type: string id: description: Unique identifier for the object. maxLength: 5000 type: string livemode: description: >- Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. type: boolean metadata: additionalProperties: maxLength: 500 type: string description: >- 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. type: object object: description: >- String representing the object's type. Objects of the same type share the same value. enum: - treasury.outbound_transfer type: string returned_details: anyOf: - $ref: >- #/components/schemas/treasury_outbound_transfers_resource_returned_details description: >- Details about a returned OutboundTransfer. Only set when the status is `returned`. nullable: true statement_descriptor: description: >- Information about the OutboundTransfer to be sent to the recipient account. maxLength: 5000 type: string status: description: >- Current status of the OutboundTransfer: `processing`, `failed`, `canceled`, `posted`, `returned`. An OutboundTransfer is `processing` if it has been created and is pending. The status changes to `posted` once the OutboundTransfer has been "confirmed" and funds have left the account, or to `failed` or `canceled`. If an OutboundTransfer fails to arrive at its destination, its status will change to `returned`. enum: - canceled - failed - posted - processing - returned type: string status_transitions: $ref: >- #/components/schemas/treasury_outbound_transfers_resource_status_transitions transaction: anyOf: - maxLength: 5000 type: string - $ref: '#/components/schemas/treasury.transaction' description: The Transaction associated with this object. x-expansionResources: oneOf: - $ref: '#/components/schemas/treasury.transaction' required: - amount - cancelable - created - currency - destination_payment_method_details - expected_arrival_date - financial_account - id - livemode - metadata - object - statement_descriptor - status - status_transitions - transaction title: TreasuryOutboundTransfersResourceOutboundTransfer type: object x-expandableFields: - destination_payment_method_details - returned_details - status_transitions - transaction x-resourceId: treasury.outbound_transfer treasury.received_credit: description: >- ReceivedCredits represent funds sent to a [FinancialAccount](https://stripe.com/docs/api#financial_accounts) (for example, via ACH or wire). These money movements are not initiated from the FinancialAccount. properties: amount: description: Amount (in cents) transferred. type: integer created: description: >- Time at which the object was created. Measured in seconds since the Unix epoch. format: unix-time type: integer currency: description: >- 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). type: string description: description: >- An arbitrary string attached to the object. Often useful for displaying to users. maxLength: 5000 type: string failure_code: description: >- Reason for the failure. A ReceivedCredit might fail because the receiving FinancialAccount is closed or frozen. enum: - account_closed - account_frozen - other nullable: true type: string x-stripeBypassValidation: true financial_account: description: The FinancialAccount that received the funds. maxLength: 5000 nullable: true type: string hosted_regulatory_receipt_url: description: >- A [hosted transaction receipt](https://stripe.com/docs/treasury/moving-money/regulatory-receipts) URL that is provided when money movement is considered regulated under Stripe's money transmission licenses. maxLength: 5000 nullable: true type: string id: description: Unique identifier for the object. maxLength: 5000 type: string initiating_payment_method_details: $ref: >- #/components/schemas/treasury_shared_resource_initiating_payment_method_details_initiating_payment_method_details linked_flows: $ref: '#/components/schemas/treasury_received_credits_resource_linked_flows' livemode: description: >- Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. type: boolean network: description: The rails used to send the funds. enum: - ach - card - stripe - us_domestic_wire type: string x-stripeBypassValidation: true object: description: >- String representing the object's type. Objects of the same type share the same value. enum: - treasury.received_credit type: string reversal_details: anyOf: - $ref: >- #/components/schemas/treasury_received_credits_resource_reversal_details description: Details describing when a ReceivedCredit may be reversed. nullable: true status: description: >- Status of the ReceivedCredit. ReceivedCredits are created either `succeeded` (approved) or `failed` (declined). If a ReceivedCredit is declined, the failure reason can be found in the `failure_code` field. enum: - failed - succeeded type: string x-stripeBypassValidation: true transaction: anyOf: - maxLength: 5000 type: string - $ref: '#/components/schemas/treasury.transaction' description: The Transaction associated with this object. nullable: true x-expansionResources: oneOf: - $ref: '#/components/schemas/treasury.transaction' required: - amount - created - currency - description - id - initiating_payment_method_details - linked_flows - livemode - network - object - status title: TreasuryReceivedCreditsResourceReceivedCredit type: object x-expandableFields: - initiating_payment_method_details - linked_flows - reversal_details - transaction x-resourceId: treasury.received_credit treasury.received_debit: description: >- ReceivedDebits represent funds pulled from a [FinancialAccount](https://stripe.com/docs/api#financial_accounts). These are not initiated from the FinancialAccount. properties: amount: description: Amount (in cents) transferred. type: integer created: description: >- Time at which the object was created. Measured in seconds since the Unix epoch. format: unix-time type: integer currency: description: >- 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). type: string description: description: >- An arbitrary string attached to the object. Often useful for displaying to users. maxLength: 5000 type: string failure_code: description: >- Reason for the failure. A ReceivedDebit might fail because the FinancialAccount doesn't have sufficient funds, is closed, or is frozen. enum: - account_closed - account_frozen - insufficient_funds - other nullable: true type: string financial_account: description: The FinancialAccount that funds were pulled from. maxLength: 5000 nullable: true type: string hosted_regulatory_receipt_url: description: >- A [hosted transaction receipt](https://stripe.com/docs/treasury/moving-money/regulatory-receipts) URL that is provided when money movement is considered regulated under Stripe's money transmission licenses. maxLength: 5000 nullable: true type: string id: description: Unique identifier for the object. maxLength: 5000 type: string initiating_payment_method_details: $ref: >- #/components/schemas/treasury_shared_resource_initiating_payment_method_details_initiating_payment_method_details linked_flows: $ref: '#/components/schemas/treasury_received_debits_resource_linked_flows' livemode: description: >- Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. type: boolean network: description: The network used for the ReceivedDebit. enum: - ach - card - stripe type: string x-stripeBypassValidation: true object: description: >- String representing the object's type. Objects of the same type share the same value. enum: - treasury.received_debit type: string reversal_details: anyOf: - $ref: >- #/components/schemas/treasury_received_debits_resource_reversal_details description: Details describing when a ReceivedDebit might be reversed. nullable: true status: description: >- Status of the ReceivedDebit. ReceivedDebits are created with a status of either `succeeded` (approved) or `failed` (declined). The failure reason can be found under the `failure_code`. enum: - failed - succeeded type: string x-stripeBypassValidation: true transaction: anyOf: - maxLength: 5000 type: string - $ref: '#/components/schemas/treasury.transaction' description: The Transaction associated with this object. nullable: true x-expansionResources: oneOf: - $ref: '#/components/schemas/treasury.transaction' required: - amount - created - currency - description - id - linked_flows - livemode - network - object - status title: TreasuryReceivedDebitsResourceReceivedDebit type: object x-expandableFields: - initiating_payment_method_details - linked_flows - reversal_details - transaction x-resourceId: treasury.received_debit treasury.transaction: description: >- Transactions represent changes to a [FinancialAccount's](https://stripe.com/docs/api#financial_accounts) balance. properties: amount: description: Amount (in cents) transferred. type: integer balance_impact: $ref: '#/components/schemas/treasury_transactions_resource_balance_impact' created: description: >- Time at which the object was created. Measured in seconds since the Unix epoch. format: unix-time type: integer currency: description: >- 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). type: string description: description: >- An arbitrary string attached to the object. Often useful for displaying to users. maxLength: 5000 type: string entries: description: >- A list of TransactionEntries that are part of this Transaction. This cannot be expanded in any list endpoints. nullable: true properties: data: description: Details about each object. items: $ref: '#/components/schemas/treasury.transaction_entry' type: array has_more: description: >- True if this list has another page of items after this one that can be fetched. type: boolean object: description: >- String representing the object's type. Objects of the same type share the same value. Always has the value `list`. enum: - list type: string url: description: The URL where this list can be accessed. maxLength: 5000 pattern: ^/v1/treasury/transaction_entries type: string required: - data - has_more - object - url title: TreasuryTransactionsResourceTransactionEntryList type: object x-expandableFields: - data financial_account: description: The FinancialAccount associated with this object. maxLength: 5000 type: string flow: description: ID of the flow that created the Transaction. maxLength: 5000 nullable: true type: string flow_details: anyOf: - $ref: '#/components/schemas/treasury_transactions_resource_flow_details' description: Details of the flow that created the Transaction. nullable: true flow_type: description: Type of the flow that created the Transaction. enum: - credit_reversal - debit_reversal - inbound_transfer - issuing_authorization - other - outbound_payment - outbound_transfer - received_credit - received_debit type: string id: description: Unique identifier for the object. maxLength: 5000 type: string livemode: description: >- Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. type: boolean object: description: >- String representing the object's type. Objects of the same type share the same value. enum: - treasury.transaction type: string status: description: Status of the Transaction. enum: - open - posted - void type: string status_transitions: $ref: >- #/components/schemas/treasury_transactions_resource_abstract_transaction_resource_status_transitions required: - amount - balance_impact - created - currency - description - financial_account - flow_type - id - livemode - object - status - status_transitions title: TreasuryTransactionsResourceTransaction type: object x-expandableFields: - balance_impact - entries - flow_details - status_transitions x-resourceId: treasury.transaction treasury.transaction_entry: description: >- TransactionEntries represent individual units of money movements within a single [Transaction](https://stripe.com/docs/api#transactions). properties: balance_impact: $ref: '#/components/schemas/treasury_transactions_resource_balance_impact' created: description: >- Time at which the object was created. Measured in seconds since the Unix epoch. format: unix-time type: integer currency: description: >- 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). type: string effective_at: description: >- When the TransactionEntry will impact the FinancialAccount's balance. format: unix-time type: integer financial_account: description: The FinancialAccount associated with this object. maxLength: 5000 type: string flow: description: Token of the flow associated with the TransactionEntry. maxLength: 5000 nullable: true type: string flow_details: anyOf: - $ref: '#/components/schemas/treasury_transactions_resource_flow_details' description: Details of the flow associated with the TransactionEntry. nullable: true flow_type: description: Type of the flow associated with the TransactionEntry. enum: - credit_reversal - debit_reversal - inbound_transfer - issuing_authorization - other - outbound_payment - outbound_transfer - received_credit - received_debit type: string id: description: Unique identifier for the object. maxLength: 5000 type: string livemode: description: >- Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. type: boolean object: description: >- String representing the object's type. Objects of the same type share the same value. enum: - treasury.transaction_entry type: string transaction: anyOf: - maxLength: 5000 type: string - $ref: '#/components/schemas/treasury.transaction' description: The Transaction associated with this object. x-expansionResources: oneOf: - $ref: '#/components/schemas/treasury.transaction' type: description: The specific money movement that generated the TransactionEntry. enum: - credit_reversal - credit_reversal_posting - debit_reversal - inbound_transfer - inbound_transfer_return - issuing_authorization_hold - issuing_authorization_release - other - outbound_payment - outbound_payment_cancellation - outbound_payment_failure - outbound_payment_posting - outbound_payment_return - outbound_transfer - outbound_transfer_cancellation - outbound_transfer_failure - outbound_transfer_posting - outbound_transfer_return - received_credit - received_debit type: string required: - balance_impact - created - currency - effective_at - financial_account - flow_type - id - livemode - object - transaction - type title: TreasuryTransactionsResourceTransactionEntry type: object x-expandableFields: - balance_impact - flow_details - transaction x-resourceId: treasury.transaction_entry treasury_financial_accounts_resource_aba_record: description: ABA Records contain U.S. bank account details per the ABA format. properties: account_holder_name: description: The name of the person or business that owns the bank account. maxLength: 5000 type: string account_number: description: The account number. maxLength: 5000 nullable: true type: string account_number_last4: description: The last four characters of the account number. maxLength: 5000 type: string bank_name: description: Name of the bank. maxLength: 5000 type: string routing_number: description: Routing number for the account. maxLength: 5000 type: string required: - account_holder_name - account_number_last4 - bank_name - routing_number title: TreasuryFinancialAccountsResourceABARecord type: object x-expandableFields: [] treasury_financial_accounts_resource_aba_toggle_settings: description: Toggle settings for enabling/disabling the ABA address feature properties: requested: description: Whether the FinancialAccount should have the Feature. type: boolean status: description: Whether the Feature is operational. enum: - active - pending - restricted type: string status_details: description: >- Additional details; includes at least one entry when the status is not `active`. items: $ref: >- #/components/schemas/treasury_financial_accounts_resource_toggles_setting_status_details type: array required: - requested - status - status_details title: TreasuryFinancialAccountsResourceAbaToggleSettings type: object x-expandableFields: - status_details treasury_financial_accounts_resource_ach_toggle_settings: description: Toggle settings for enabling/disabling an ACH specific feature properties: requested: description: Whether the FinancialAccount should have the Feature. type: boolean status: description: Whether the Feature is operational. enum: - active - pending - restricted type: string status_details: description: >- Additional details; includes at least one entry when the status is not `active`. items: $ref: >- #/components/schemas/treasury_financial_accounts_resource_toggles_setting_status_details type: array required: - requested - status - status_details title: TreasuryFinancialAccountsResourceAchToggleSettings type: object x-expandableFields: - status_details treasury_financial_accounts_resource_balance: description: Balance information for the FinancialAccount properties: cash: additionalProperties: type: integer description: Funds the user can spend right now. type: object inbound_pending: additionalProperties: type: integer description: 'Funds not spendable yet, but will become available at a later time.' type: object outbound_pending: additionalProperties: type: integer description: >- Funds in the account, but not spendable because they are being held for pending outbound flows. type: object required: - cash - inbound_pending - outbound_pending title: TreasuryFinancialAccountsResourceBalance type: object x-expandableFields: [] treasury_financial_accounts_resource_closed_status_details: description: '' properties: reasons: description: The array that contains reasons for a FinancialAccount closure. items: enum: - account_rejected - closed_by_platform - other type: string type: array required: - reasons title: TreasuryFinancialAccountsResourceClosedStatusDetails type: object x-expandableFields: [] treasury_financial_accounts_resource_financial_address: description: >- FinancialAddresses contain identifying information that resolves to a FinancialAccount. properties: aba: $ref: '#/components/schemas/treasury_financial_accounts_resource_aba_record' supported_networks: description: The list of networks that the address supports items: enum: - ach - us_domestic_wire type: string x-stripeBypassValidation: true type: array type: description: The type of financial address enum: - aba type: string x-stripeBypassValidation: true required: - type title: TreasuryFinancialAccountsResourceFinancialAddress type: object x-expandableFields: - aba treasury_financial_accounts_resource_financial_addresses_features: description: Settings related to Financial Addresses features on a Financial Account properties: aba: $ref: >- #/components/schemas/treasury_financial_accounts_resource_aba_toggle_settings title: TreasuryFinancialAccountsResourceFinancialAddressesFeatures type: object x-expandableFields: - aba treasury_financial_accounts_resource_inbound_transfers: description: >- InboundTransfers contains inbound transfers features for a FinancialAccount. properties: ach: $ref: >- #/components/schemas/treasury_financial_accounts_resource_ach_toggle_settings title: TreasuryFinancialAccountsResourceInboundTransfers type: object x-expandableFields: - ach treasury_financial_accounts_resource_outbound_payments: description: Settings related to Outbound Payments features on a Financial Account properties: ach: $ref: >- #/components/schemas/treasury_financial_accounts_resource_ach_toggle_settings us_domestic_wire: $ref: >- #/components/schemas/treasury_financial_accounts_resource_toggle_settings title: TreasuryFinancialAccountsResourceOutboundPayments type: object x-expandableFields: - ach - us_domestic_wire treasury_financial_accounts_resource_outbound_transfers: description: >- OutboundTransfers contains outbound transfers features for a FinancialAccount. properties: ach: $ref: >- #/components/schemas/treasury_financial_accounts_resource_ach_toggle_settings us_domestic_wire: $ref: >- #/components/schemas/treasury_financial_accounts_resource_toggle_settings title: TreasuryFinancialAccountsResourceOutboundTransfers type: object x-expandableFields: - ach - us_domestic_wire treasury_financial_accounts_resource_platform_restrictions: description: >- Restrictions that a Connect Platform has placed on this FinancialAccount. properties: inbound_flows: description: Restricts all inbound money movement. enum: - restricted - unrestricted nullable: true type: string outbound_flows: description: Restricts all outbound money movement. enum: - restricted - unrestricted nullable: true type: string title: TreasuryFinancialAccountsResourcePlatformRestrictions type: object x-expandableFields: [] treasury_financial_accounts_resource_status_details: description: '' properties: closed: anyOf: - $ref: >- #/components/schemas/treasury_financial_accounts_resource_closed_status_details description: Details related to the closure of this FinancialAccount nullable: true title: TreasuryFinancialAccountsResourceStatusDetails type: object x-expandableFields: - closed treasury_financial_accounts_resource_toggle_settings: description: Toggle settings for enabling/disabling a feature properties: requested: description: Whether the FinancialAccount should have the Feature. type: boolean status: description: Whether the Feature is operational. enum: - active - pending - restricted type: string status_details: description: >- Additional details; includes at least one entry when the status is not `active`. items: $ref: >- #/components/schemas/treasury_financial_accounts_resource_toggles_setting_status_details type: array required: - requested - status - status_details title: TreasuryFinancialAccountsResourceToggleSettings type: object x-expandableFields: - status_details treasury_financial_accounts_resource_toggles_setting_status_details: description: Additional details on the FinancialAccount Features information. properties: code: description: Represents the reason why the status is `pending` or `restricted`. enum: - activating - capability_not_requested - financial_account_closed - rejected_other - rejected_unsupported_business - requirements_past_due - requirements_pending_verification - restricted_by_platform - restricted_other type: string x-stripeBypassValidation: true resolution: description: >- Represents what the user should do, if anything, to activate the Feature. enum: - contact_stripe - provide_information - remove_restriction nullable: true type: string x-stripeBypassValidation: true restriction: description: The `platform_restrictions` that are restricting this Feature. enum: - inbound_flows - outbound_flows type: string required: - code title: TreasuryFinancialAccountsResourceTogglesSettingStatusDetails type: object x-expandableFields: [] treasury_inbound_transfers_resource_failure_details: description: '' properties: code: description: Reason for the failure. enum: - account_closed - account_frozen - bank_account_restricted - bank_ownership_changed - debit_not_authorized - incorrect_account_holder_address - incorrect_account_holder_name - incorrect_account_holder_tax_id - insufficient_funds - invalid_account_number - invalid_currency - no_account - other type: string required: - code title: TreasuryInboundTransfersResourceFailureDetails type: object x-expandableFields: [] treasury_inbound_transfers_resource_inbound_transfer_resource_linked_flows: description: '' properties: received_debit: description: >- If funds for this flow were returned after the flow went to the `succeeded` state, this field contains a reference to the ReceivedDebit return. maxLength: 5000 nullable: true type: string title: TreasuryInboundTransfersResourceInboundTransferResourceLinkedFlows type: object x-expandableFields: [] treasury_inbound_transfers_resource_inbound_transfer_resource_status_transitions: description: '' properties: canceled_at: description: >- Timestamp describing when an InboundTransfer changed status to `canceled`. format: unix-time nullable: true type: integer failed_at: description: >- Timestamp describing when an InboundTransfer changed status to `failed`. format: unix-time nullable: true type: integer succeeded_at: description: >- Timestamp describing when an InboundTransfer changed status to `succeeded`. format: unix-time nullable: true type: integer title: TreasuryInboundTransfersResourceInboundTransferResourceStatusTransitions type: object x-expandableFields: [] treasury_outbound_payments_resource_outbound_payment_resource_end_user_details: description: '' properties: ip_address: description: >- IP address of the user initiating the OutboundPayment. Set if `present` is set to `true`. IP address collection is required for risk and compliance reasons. This will be used to help determine if the OutboundPayment is authorized or should be blocked. maxLength: 5000 nullable: true type: string present: description: >- `true` if the OutboundPayment creation request is being made on behalf of an end user by a platform. Otherwise, `false`. type: boolean required: - present title: TreasuryOutboundPaymentsResourceOutboundPaymentResourceEndUserDetails type: object x-expandableFields: [] treasury_outbound_payments_resource_outbound_payment_resource_status_transitions: description: '' properties: canceled_at: description: >- Timestamp describing when an OutboundPayment changed status to `canceled`. format: unix-time nullable: true type: integer failed_at: description: >- Timestamp describing when an OutboundPayment changed status to `failed`. format: unix-time nullable: true type: integer posted_at: description: >- Timestamp describing when an OutboundPayment changed status to `posted`. format: unix-time nullable: true type: integer returned_at: description: >- Timestamp describing when an OutboundPayment changed status to `returned`. format: unix-time nullable: true type: integer title: TreasuryOutboundPaymentsResourceOutboundPaymentResourceStatusTransitions type: object x-expandableFields: [] treasury_outbound_payments_resource_returned_status: description: '' properties: code: description: Reason for the return. enum: - account_closed - account_frozen - bank_account_restricted - bank_ownership_changed - declined - incorrect_account_holder_name - invalid_account_number - invalid_currency - no_account - other type: string transaction: anyOf: - maxLength: 5000 type: string - $ref: '#/components/schemas/treasury.transaction' description: The Transaction associated with this object. x-expansionResources: oneOf: - $ref: '#/components/schemas/treasury.transaction' required: - code - transaction title: TreasuryOutboundPaymentsResourceReturnedStatus type: object x-expandableFields: - transaction treasury_outbound_transfers_resource_returned_details: description: '' properties: code: description: Reason for the return. enum: - account_closed - account_frozen - bank_account_restricted - bank_ownership_changed - declined - incorrect_account_holder_name - invalid_account_number - invalid_currency - no_account - other type: string transaction: anyOf: - maxLength: 5000 type: string - $ref: '#/components/schemas/treasury.transaction' description: The Transaction associated with this object. x-expansionResources: oneOf: - $ref: '#/components/schemas/treasury.transaction' required: - code - transaction title: TreasuryOutboundTransfersResourceReturnedDetails type: object x-expandableFields: - transaction treasury_outbound_transfers_resource_status_transitions: description: '' properties: canceled_at: description: >- Timestamp describing when an OutboundTransfer changed status to `canceled` format: unix-time nullable: true type: integer failed_at: description: >- Timestamp describing when an OutboundTransfer changed status to `failed` format: unix-time nullable: true type: integer posted_at: description: >- Timestamp describing when an OutboundTransfer changed status to `posted` format: unix-time nullable: true type: integer returned_at: description: >- Timestamp describing when an OutboundTransfer changed status to `returned` format: unix-time nullable: true type: integer title: TreasuryOutboundTransfersResourceStatusTransitions type: object x-expandableFields: [] treasury_received_credits_resource_linked_flows: description: '' properties: credit_reversal: description: >- The CreditReversal created as a result of this ReceivedCredit being reversed. maxLength: 5000 nullable: true type: string issuing_authorization: description: >- Set if the ReceivedCredit was created due to an [Issuing Authorization](https://stripe.com/docs/api#issuing_authorizations) object. maxLength: 5000 nullable: true type: string issuing_transaction: description: >- Set if the ReceivedCredit is also viewable as an [Issuing transaction](https://stripe.com/docs/api#issuing_transactions) object. maxLength: 5000 nullable: true type: string source_flow: description: >- ID of the source flow. Set if `network` is `stripe` and the source flow is visible to the user. Examples of source flows include OutboundPayments, payouts, or CreditReversals. maxLength: 5000 nullable: true type: string source_flow_details: anyOf: - $ref: >- #/components/schemas/treasury_received_credits_resource_source_flows_details description: The expandable object of the source flow. nullable: true source_flow_type: description: >- The type of flow that originated the ReceivedCredit (for example, `outbound_payment`). maxLength: 5000 nullable: true type: string title: TreasuryReceivedCreditsResourceLinkedFlows type: object x-expandableFields: - source_flow_details treasury_received_credits_resource_reversal_details: description: '' properties: deadline: description: Time before which a ReceivedCredit can be reversed. format: unix-time nullable: true type: integer restricted_reason: description: Set if a ReceivedCredit cannot be reversed. enum: - already_reversed - deadline_passed - network_restricted - other - source_flow_restricted nullable: true type: string title: TreasuryReceivedCreditsResourceReversalDetails type: object x-expandableFields: [] treasury_received_credits_resource_source_flows_details: description: '' properties: credit_reversal: $ref: '#/components/schemas/treasury.credit_reversal' outbound_payment: $ref: '#/components/schemas/treasury.outbound_payment' payout: $ref: '#/components/schemas/payout' type: description: The type of the source flow that originated the ReceivedCredit. enum: - credit_reversal - other - outbound_payment - payout type: string x-stripeBypassValidation: true required: - type title: TreasuryReceivedCreditsResourceSourceFlowsDetails type: object x-expandableFields: - credit_reversal - outbound_payment - payout treasury_received_credits_resource_status_transitions: description: '' properties: posted_at: description: >- Timestamp describing when the CreditReversal changed status to `posted` format: unix-time nullable: true type: integer title: TreasuryReceivedCreditsResourceStatusTransitions type: object x-expandableFields: [] treasury_received_debits_resource_debit_reversal_linked_flows: description: '' properties: issuing_dispute: description: >- Set if there is an Issuing dispute associated with the DebitReversal. maxLength: 5000 nullable: true type: string title: TreasuryReceivedDebitsResourceDebitReversalLinkedFlows type: object x-expandableFields: [] treasury_received_debits_resource_linked_flows: description: '' properties: debit_reversal: description: >- The DebitReversal created as a result of this ReceivedDebit being reversed. maxLength: 5000 nullable: true type: string inbound_transfer: description: >- Set if the ReceivedDebit is associated with an InboundTransfer's return of funds. maxLength: 5000 nullable: true type: string issuing_authorization: description: >- Set if the ReceivedDebit was created due to an [Issuing Authorization](https://stripe.com/docs/api#issuing_authorizations) object. maxLength: 5000 nullable: true type: string issuing_transaction: description: >- Set if the ReceivedDebit is also viewable as an [Issuing Dispute](https://stripe.com/docs/api#issuing_disputes) object. maxLength: 5000 nullable: true type: string payout: description: >- Set if the ReceivedDebit was created due to a [Payout](https://stripe.com/docs/api#payouts) object. maxLength: 5000 nullable: true type: string title: TreasuryReceivedDebitsResourceLinkedFlows type: object x-expandableFields: [] treasury_received_debits_resource_reversal_details: description: '' properties: deadline: description: Time before which a ReceivedDebit can be reversed. format: unix-time nullable: true type: integer restricted_reason: description: Set if a ReceivedDebit can't be reversed. enum: - already_reversed - deadline_passed - network_restricted - other - source_flow_restricted nullable: true type: string title: TreasuryReceivedDebitsResourceReversalDetails type: object x-expandableFields: [] treasury_received_debits_resource_status_transitions: description: '' properties: completed_at: description: >- Timestamp describing when the DebitReversal changed status to `completed`. format: unix-time nullable: true type: integer title: TreasuryReceivedDebitsResourceStatusTransitions type: object x-expandableFields: [] treasury_shared_resource_billing_details: description: '' properties: address: $ref: '#/components/schemas/address' email: description: Email address. maxLength: 5000 nullable: true type: string name: description: Full name. maxLength: 5000 nullable: true type: string required: - address title: TreasurySharedResourceBillingDetails type: object x-expandableFields: - address treasury_shared_resource_initiating_payment_method_details_initiating_payment_method_details: description: '' properties: balance: description: Set when `type` is `balance`. enum: - payments type: string billing_details: $ref: '#/components/schemas/treasury_shared_resource_billing_details' financial_account: $ref: >- #/components/schemas/received_payment_method_details_financial_account issuing_card: description: >- Set when `type` is `issuing_card`. This is an [Issuing Card](https://stripe.com/docs/api#issuing_cards) ID. maxLength: 5000 type: string type: description: >- Polymorphic type matching the originating money movement's source. This can be an external account, a Stripe balance, or a FinancialAccount. enum: - balance - financial_account - issuing_card - stripe - us_bank_account type: string x-stripeBypassValidation: true us_bank_account: $ref: >- #/components/schemas/treasury_shared_resource_initiating_payment_method_details_us_bank_account required: - billing_details - type title: >- TreasurySharedResourceInitiatingPaymentMethodDetailsInitiatingPaymentMethodDetails type: object x-expandableFields: - billing_details - financial_account - us_bank_account treasury_shared_resource_initiating_payment_method_details_us_bank_account: description: '' properties: bank_name: description: Bank name. maxLength: 5000 nullable: true type: string last4: description: The last four digits of the bank account number. maxLength: 5000 nullable: true type: string routing_number: description: The routing number for the bank account. maxLength: 5000 nullable: true type: string title: TreasurySharedResourceInitiatingPaymentMethodDetailsUSBankAccount type: object x-expandableFields: [] treasury_transactions_resource_abstract_transaction_resource_status_transitions: description: '' properties: posted_at: description: >- Timestamp describing when the Transaction changed status to `posted`. format: unix-time nullable: true type: integer void_at: description: Timestamp describing when the Transaction changed status to `void`. format: unix-time nullable: true type: integer title: TreasuryTransactionsResourceAbstractTransactionResourceStatusTransitions type: object x-expandableFields: [] treasury_transactions_resource_balance_impact: description: Change to a FinancialAccount's balance properties: cash: description: The change made to funds the user can spend right now. type: integer inbound_pending: description: >- The change made to funds that are not spendable yet, but will become available at a later time. type: integer outbound_pending: description: >- The change made to funds in the account, but not spendable because they are being held for pending outbound flows. type: integer required: - cash - inbound_pending - outbound_pending title: TreasuryTransactionsResourceBalanceImpact type: object x-expandableFields: [] treasury_transactions_resource_flow_details: description: '' properties: credit_reversal: $ref: '#/components/schemas/treasury.credit_reversal' debit_reversal: $ref: '#/components/schemas/treasury.debit_reversal' inbound_transfer: $ref: '#/components/schemas/treasury.inbound_transfer' issuing_authorization: $ref: '#/components/schemas/issuing.authorization' outbound_payment: $ref: '#/components/schemas/treasury.outbound_payment' outbound_transfer: $ref: '#/components/schemas/treasury.outbound_transfer' received_credit: $ref: '#/components/schemas/treasury.received_credit' received_debit: $ref: '#/components/schemas/treasury.received_debit' type: description: >- Type of the flow that created the Transaction. Set to the same value as `flow_type`. enum: - credit_reversal - debit_reversal - inbound_transfer - issuing_authorization - other - outbound_payment - outbound_transfer - received_credit - received_debit type: string required: - type title: TreasuryTransactionsResourceFlowDetails type: object x-expandableFields: - credit_reversal - debit_reversal - inbound_transfer - issuing_authorization - outbound_payment - outbound_transfer - received_credit - received_debit us_bank_account_networks: description: '' properties: preferred: description: The preferred network. maxLength: 5000 nullable: true type: string supported: description: All supported networks. items: enum: - ach - us_domestic_wire type: string type: array required: - supported title: us_bank_account_networks type: object x-expandableFields: [] usage_record: description: >- Usage records allow you to report customer usage and metrics to Stripe for metered billing of subscription prices. Related guide: [Metered billing](https://stripe.com/docs/billing/subscriptions/metered-billing) This is our legacy usage-based billing API. See the [updated usage-based billing docs](https://docs.stripe.com/billing/subscriptions/usage-based). properties: id: description: Unique identifier for the object. maxLength: 5000 type: string livemode: description: >- Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. type: boolean object: description: >- String representing the object's type. Objects of the same type share the same value. enum: - usage_record type: string quantity: description: The usage quantity for the specified date. type: integer subscription_item: description: The ID of the subscription item this usage record contains data for. maxLength: 5000 type: string timestamp: description: The timestamp when this usage occurred. format: unix-time type: integer required: - id - livemode - object - quantity - subscription_item - timestamp title: UsageRecord type: object x-expandableFields: [] x-resourceId: usage_record usage_record_summary: description: '' properties: id: description: Unique identifier for the object. maxLength: 5000 type: string invoice: description: The invoice in which this usage period has been billed for. maxLength: 5000 nullable: true type: string livemode: description: >- Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. type: boolean object: description: >- String representing the object's type. Objects of the same type share the same value. enum: - usage_record_summary type: string period: $ref: '#/components/schemas/period' subscription_item: description: The ID of the subscription item this summary is describing. maxLength: 5000 type: string total_usage: description: The total usage within this usage period. type: integer required: - id - livemode - object - period - subscription_item - total_usage title: UsageRecordSummary type: object x-expandableFields: - period x-resourceId: usage_record_summary verification_session_redaction: description: '' properties: status: description: >- Indicates whether this object and its related objects have been redacted or not. enum: - processing - redacted type: string required: - status title: verification_session_redaction type: object x-expandableFields: [] webhook_endpoint: description: >- You can configure [webhook endpoints](https://stripe.com/docs/webhooks/) via the API to be notified about events that happen in your Stripe account or connected accounts. Most users configure webhooks from [the dashboard](https://dashboard.stripe.com/webhooks), which provides a user interface for registering and testing your webhook endpoints. Related guide: [Setting up webhooks](https://stripe.com/docs/webhooks/configure) properties: api_version: description: The API version events are rendered as for this webhook endpoint. maxLength: 5000 nullable: true type: string application: description: The ID of the associated Connect application. maxLength: 5000 nullable: true type: string created: description: >- Time at which the object was created. Measured in seconds since the Unix epoch. format: unix-time type: integer description: description: An optional description of what the webhook is used for. maxLength: 5000 nullable: true type: string enabled_events: description: >- The list of events to enable for this endpoint. `['*']` indicates that all events are enabled, except those that require explicit selection. items: maxLength: 5000 type: string type: array id: description: Unique identifier for the object. maxLength: 5000 type: string livemode: description: >- Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. type: boolean metadata: additionalProperties: maxLength: 500 type: string description: >- 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. type: object object: description: >- String representing the object's type. Objects of the same type share the same value. enum: - webhook_endpoint type: string secret: description: >- The endpoint's secret, used to generate [webhook signatures](https://stripe.com/docs/webhooks/signatures). Only returned at creation. maxLength: 5000 type: string status: description: The status of the webhook. It can be `enabled` or `disabled`. maxLength: 5000 type: string url: description: The URL of the webhook endpoint. maxLength: 5000 type: string required: - created - enabled_events - id - livemode - metadata - object - status - url title: NotificationWebhookEndpoint type: object x-expandableFields: [] x-resourceId: webhook_endpoint securitySchemes: basicAuth: description: >- Basic HTTP authentication. Allowed headers-- Authorization: Basic | Authorization: Basic scheme: basic type: http bearerAuth: bearerFormat: auth-scheme description: >- Bearer HTTP authentication. Allowed headers-- Authorization: Bearer scheme: bearer type: http info: contact: email: dev-platform@stripe.com name: Stripe Dev Platform Team url: 'https://stripe.com' description: >- The Stripe REST API. Please see https://stripe.com/docs/api for more details. termsOfService: 'https://stripe.com/us/terms/' title: Stripe API version: '2024-04-10' x-stripeSpecFilename: spec3 openapi: 3.0.0 paths: /v1/account: get: description:

Retrieves the details of an account.

operationId: GetAccount parameters: - description: Specifies which fields in the response should be expanded. explode: true in: query name: expand required: false schema: items: maxLength: 5000 type: string type: array style: deepObject requestBody: content: application/x-www-form-urlencoded: encoding: {} schema: additionalProperties: false properties: {} type: object required: false responses: '200': content: application/json: schema: $ref: '#/components/schemas/account' description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. /v1/account_links: post: description: >-

Creates an AccountLink object that includes a single-use Stripe URL that the platform can redirect their user to in order to take them through the Connect Onboarding flow.

operationId: PostAccountLinks requestBody: content: application/x-www-form-urlencoded: encoding: collection_options: explode: true style: deepObject expand: explode: true style: deepObject schema: additionalProperties: false properties: account: description: The identifier of the account to create an account link for. maxLength: 5000 type: string collect: description: >- The collect parameter is deprecated. Use `collection_options` instead. enum: - currently_due - eventually_due type: string collection_options: description: >- Specifies the requirements that Stripe collects from connected accounts in the Connect Onboarding flow. properties: fields: enum: - currently_due - eventually_due type: string future_requirements: enum: - include - omit type: string required: - fields title: collection_options_params type: object expand: description: Specifies which fields in the response should be expanded. items: maxLength: 5000 type: string type: array refresh_url: description: >- The URL the user will be redirected to if the account link is expired, has been previously-visited, or is otherwise invalid. The URL you specify should attempt to generate a new account link with the same parameters used to create the original account link, then redirect the user to the new account link's URL so they can continue with Connect Onboarding. If a new account link cannot be generated or the redirect fails you should display a useful error to the user. type: string return_url: description: >- The URL that the user will be redirected to upon leaving or completing the linked flow. type: string type: description: >- The type of account link the user is requesting. Possible values are `account_onboarding` or `account_update`. enum: - account_onboarding - account_update type: string x-stripeBypassValidation: true required: - account - type type: object required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/account_link' description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. /v1/account_sessions: post: description: >-

Creates a AccountSession object that includes a single-use token that the platform can use on their front-end to grant client-side API access.

operationId: PostAccountSessions requestBody: content: application/x-www-form-urlencoded: encoding: components: explode: true style: deepObject expand: explode: true style: deepObject schema: additionalProperties: false properties: account: description: >- The identifier of the account to create an Account Session for. type: string components: description: >- Each key of the dictionary represents an embedded component, and each embedded component maps to its configuration (e.g. whether it has been enabled or not). properties: account_management: properties: enabled: type: boolean features: properties: external_account_collection: type: boolean title: account_features_param type: object required: - enabled title: account_config_param type: object account_onboarding: properties: enabled: type: boolean features: properties: external_account_collection: type: boolean title: account_features_param type: object required: - enabled title: account_config_param type: object balances: properties: enabled: type: boolean features: properties: edit_payout_schedule: type: boolean instant_payouts: type: boolean standard_payouts: type: boolean title: payouts_features_param type: object required: - enabled title: payouts_config_param type: object documents: properties: enabled: type: boolean features: properties: {} title: base_features_param type: object required: - enabled title: base_config_param type: object notification_banner: properties: enabled: type: boolean features: properties: external_account_collection: type: boolean title: account_features_param type: object required: - enabled title: account_config_param type: object payment_details: properties: enabled: type: boolean features: properties: capture_payments: type: boolean destination_on_behalf_of_charge_management: type: boolean dispute_management: type: boolean refund_management: type: boolean title: payments_features_param type: object required: - enabled title: payments_config_param type: object payments: properties: enabled: type: boolean features: properties: capture_payments: type: boolean destination_on_behalf_of_charge_management: type: boolean dispute_management: type: boolean refund_management: type: boolean title: payments_features_param type: object required: - enabled title: payments_config_param type: object payouts: properties: enabled: type: boolean features: properties: edit_payout_schedule: type: boolean instant_payouts: type: boolean standard_payouts: type: boolean title: payouts_features_param type: object required: - enabled title: payouts_config_param type: object payouts_list: properties: enabled: type: boolean features: properties: {} title: base_features_param type: object required: - enabled title: base_config_param type: object title: account_session_create_components_param type: object expand: description: Specifies which fields in the response should be expanded. items: maxLength: 5000 type: string type: array required: - account - components type: object required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/account_session' description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. /v1/accounts: get: description: >-

Returns a list of accounts connected to your platform via Connect. If you’re not a platform, the list is empty.

operationId: GetAccounts parameters: - description: >- Only return connected accounts that were created during the given date interval. explode: true in: query name: created required: false schema: anyOf: - properties: gt: type: integer gte: type: integer lt: type: integer lte: type: integer title: range_query_specs type: object - type: integer style: deepObject - description: >- A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. in: query name: ending_before required: false schema: type: string style: form - description: Specifies which fields in the response should be expanded. explode: true in: query name: expand required: false schema: items: maxLength: 5000 type: string type: array style: deepObject - description: >- A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. in: query name: limit required: false schema: type: integer style: form - description: >- A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. in: query name: starting_after required: false schema: type: string style: form requestBody: content: application/x-www-form-urlencoded: encoding: {} schema: additionalProperties: false properties: {} type: object required: false responses: '200': content: application/json: schema: description: '' properties: data: items: $ref: '#/components/schemas/account' type: array has_more: description: >- True if this list has another page of items after this one that can be fetched. type: boolean object: description: >- String representing the object's type. Objects of the same type share the same value. Always has the value `list`. enum: - list type: string url: description: The URL where this list can be accessed. maxLength: 5000 pattern: ^/v1/accounts type: string required: - data - has_more - object - url title: AccountList type: object x-expandableFields: - data description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. post: description: >-

With Connect, you can create Stripe accounts for your users. To do this, you’ll first need to register your platform.

If you’ve already collected information for your connected accounts, you can prefill that information when creating the account. Connect Onboarding won’t ask for the prefilled information during account onboarding. You can prefill any information on the account.

operationId: PostAccounts requestBody: content: application/x-www-form-urlencoded: encoding: bank_account: explode: true style: deepObject business_profile: explode: true style: deepObject capabilities: explode: true style: deepObject company: explode: true style: deepObject controller: explode: true style: deepObject documents: explode: true style: deepObject expand: explode: true style: deepObject individual: explode: true style: deepObject metadata: explode: true style: deepObject settings: explode: true style: deepObject tos_acceptance: explode: true style: deepObject schema: additionalProperties: false properties: account_token: description: >- An [account token](https://stripe.com/docs/api#create_account_token), used to securely provide details to the account. maxLength: 5000 type: string bank_account: anyOf: - properties: account_holder_name: maxLength: 5000 type: string account_holder_type: enum: - company - individual maxLength: 5000 type: string account_number: maxLength: 5000 type: string account_type: enum: - checking - futsu - savings - toza maxLength: 5000 type: string country: maxLength: 5000 type: string currency: type: string documents: properties: bank_account_ownership_verification: properties: files: items: maxLength: 500 type: string type: array title: documents_param type: object title: external_account_documents_param type: object object: enum: - bank_account maxLength: 5000 type: string routing_number: maxLength: 5000 type: string required: - account_number - country title: external_account_payout_bank_account type: object - maxLength: 5000 type: string description: >- Either a token, like the ones returned by [Stripe.js](https://stripe.com/docs/js), or a dictionary containing a user's bank account details. business_profile: description: Business information about the account. properties: annual_revenue: properties: amount: type: integer currency: type: string fiscal_year_end: maxLength: 5000 type: string required: - amount - currency - fiscal_year_end title: annual_revenue_specs type: object estimated_worker_count: type: integer mcc: maxLength: 4 type: string monthly_estimated_revenue: properties: amount: type: integer currency: type: string required: - amount - currency title: monthly_estimated_revenue_specs type: object name: maxLength: 5000 type: string product_description: maxLength: 40000 type: string support_address: properties: city: maxLength: 100 type: string country: maxLength: 5000 type: string line1: maxLength: 200 type: string line2: maxLength: 200 type: string postal_code: maxLength: 5000 type: string state: maxLength: 5000 type: string title: address_specs type: object support_email: type: string support_phone: maxLength: 5000 type: string support_url: anyOf: - type: string - enum: - '' type: string url: type: string title: business_profile_specs type: object business_type: description: >- The business type. Once you create an [Account Link](https://docs.stripe.com/api/account_links) or [Account Session](https://docs.stripe.com/api/account_sessions), this property can only be updated for Custom accounts. enum: - company - government_entity - individual - non_profit type: string x-stripeBypassValidation: true capabilities: description: >- Each key of the dictionary represents a capability, and each capability maps to its settings (e.g. whether it has been requested or not). Each capability will be inactive until you have provided its specific requirements and Stripe has verified them. An account may have some of its requested capabilities be active and some be inactive. properties: acss_debit_payments: properties: requested: type: boolean title: capability_param type: object affirm_payments: properties: requested: type: boolean title: capability_param type: object afterpay_clearpay_payments: properties: requested: type: boolean title: capability_param type: object amazon_pay_payments: properties: requested: type: boolean title: capability_param type: object au_becs_debit_payments: properties: requested: type: boolean title: capability_param type: object bacs_debit_payments: properties: requested: type: boolean title: capability_param type: object bancontact_payments: properties: requested: type: boolean title: capability_param type: object bank_transfer_payments: properties: requested: type: boolean title: capability_param type: object blik_payments: properties: requested: type: boolean title: capability_param type: object boleto_payments: properties: requested: type: boolean title: capability_param type: object card_issuing: properties: requested: type: boolean title: capability_param type: object card_payments: properties: requested: type: boolean title: capability_param type: object cartes_bancaires_payments: properties: requested: type: boolean title: capability_param type: object cashapp_payments: properties: requested: type: boolean title: capability_param type: object eps_payments: properties: requested: type: boolean title: capability_param type: object fpx_payments: properties: requested: type: boolean title: capability_param type: object giropay_payments: properties: requested: type: boolean title: capability_param type: object grabpay_payments: properties: requested: type: boolean title: capability_param type: object ideal_payments: properties: requested: type: boolean title: capability_param type: object india_international_payments: properties: requested: type: boolean title: capability_param type: object jcb_payments: properties: requested: type: boolean title: capability_param type: object klarna_payments: properties: requested: type: boolean title: capability_param type: object konbini_payments: properties: requested: type: boolean title: capability_param type: object legacy_payments: properties: requested: type: boolean title: capability_param type: object link_payments: properties: requested: type: boolean title: capability_param type: object mobilepay_payments: properties: requested: type: boolean title: capability_param type: object oxxo_payments: properties: requested: type: boolean title: capability_param type: object p24_payments: properties: requested: type: boolean title: capability_param type: object paynow_payments: properties: requested: type: boolean title: capability_param type: object promptpay_payments: properties: requested: type: boolean title: capability_param type: object revolut_pay_payments: properties: requested: type: boolean title: capability_param type: object sepa_debit_payments: properties: requested: type: boolean title: capability_param type: object sofort_payments: properties: requested: type: boolean title: capability_param type: object swish_payments: properties: requested: type: boolean title: capability_param type: object tax_reporting_us_1099_k: properties: requested: type: boolean title: capability_param type: object tax_reporting_us_1099_misc: properties: requested: type: boolean title: capability_param type: object transfers: properties: requested: type: boolean title: capability_param type: object treasury: properties: requested: type: boolean title: capability_param type: object us_bank_account_ach_payments: properties: requested: type: boolean title: capability_param type: object zip_payments: properties: requested: type: boolean title: capability_param type: object title: capabilities_param type: object company: description: >- Information about the company or business. This field is available for any `business_type`. Once you create an [Account Link](https://docs.stripe.com/api/account_links) or [Account Session](https://docs.stripe.com/api/account_sessions), this property can only be updated for Custom accounts. properties: address: properties: city: maxLength: 100 type: string country: maxLength: 5000 type: string line1: maxLength: 200 type: string line2: maxLength: 200 type: string postal_code: maxLength: 5000 type: string state: maxLength: 5000 type: string title: address_specs type: object address_kana: properties: city: maxLength: 5000 type: string country: maxLength: 5000 type: string line1: maxLength: 5000 type: string line2: maxLength: 5000 type: string postal_code: maxLength: 5000 type: string state: maxLength: 5000 type: string town: maxLength: 5000 type: string title: japan_address_kana_specs type: object address_kanji: properties: city: maxLength: 5000 type: string country: maxLength: 5000 type: string line1: maxLength: 5000 type: string line2: maxLength: 5000 type: string postal_code: maxLength: 5000 type: string state: maxLength: 5000 type: string town: maxLength: 5000 type: string title: japan_address_kanji_specs type: object directors_provided: type: boolean executives_provided: type: boolean export_license_id: maxLength: 5000 type: string export_purpose_code: maxLength: 5000 type: string name: maxLength: 100 type: string name_kana: maxLength: 100 type: string name_kanji: maxLength: 100 type: string owners_provided: type: boolean ownership_declaration: properties: date: format: unix-time type: integer ip: type: string user_agent: maxLength: 5000 type: string title: company_ownership_declaration type: object phone: maxLength: 5000 type: string registration_number: maxLength: 5000 type: string structure: enum: - '' - 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 type: string x-stripeBypassValidation: true tax_id: maxLength: 5000 type: string tax_id_registrar: maxLength: 5000 type: string vat_id: maxLength: 5000 type: string verification: properties: document: properties: back: maxLength: 500 type: string front: maxLength: 500 type: string title: verification_document_specs type: object title: verification_specs type: object title: company_specs type: object controller: description: >- A hash of configuration describing the account controller's attributes. properties: fees: properties: payer: enum: - account - application type: string title: controller_fees_specs type: object losses: properties: payments: enum: - application - stripe type: string title: controller_losses_specs type: object requirement_collection: enum: - application - stripe type: string stripe_dashboard: properties: type: enum: - express - full - none type: string title: controller_dashboard_specs type: object title: controller_specs type: object country: description: >- The country in which the account holder resides, or in which the business is legally established. This should be an ISO 3166-1 alpha-2 country code. For example, if you are in the United States and the business for which you're creating an account is legally represented in Canada, you would use `CA` as the country for the account being created. Available countries include [Stripe's global markets](https://stripe.com/global) as well as countries where [cross-border payouts](https://stripe.com/docs/connect/cross-border-payouts) are supported. maxLength: 5000 type: string default_currency: description: >- 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://docs.stripe.com/payouts). type: string documents: description: >- Documents that may be submitted to satisfy various informational requests. properties: bank_account_ownership_verification: properties: files: items: maxLength: 500 type: string type: array title: documents_param type: object company_license: properties: files: items: maxLength: 500 type: string type: array title: documents_param type: object company_memorandum_of_association: properties: files: items: maxLength: 500 type: string type: array title: documents_param type: object company_ministerial_decree: properties: files: items: maxLength: 500 type: string type: array title: documents_param type: object company_registration_verification: properties: files: items: maxLength: 500 type: string type: array title: documents_param type: object company_tax_id_verification: properties: files: items: maxLength: 500 type: string type: array title: documents_param type: object proof_of_registration: properties: files: items: maxLength: 500 type: string type: array title: documents_param type: object title: documents_specs type: object email: description: >- The email address of the account holder. This is only to make the account easier to identify to you. Stripe only emails Custom accounts with your consent. type: string expand: description: Specifies which fields in the response should be expanded. items: maxLength: 5000 type: string type: array external_account: description: >- A card or bank account to attach to the account for receiving [payouts](https://docs.stripe.com/connect/bank-debit-card-payouts) (you won’t be able to use it for top-ups). You can provide either a token, like the ones returned by [Stripe.js](https://docs.stripe.com/js), or a dictionary, as documented in the `external_account` parameter for [bank account](https://docs.stripe.com/api#account_create_bank_account) creation.

By default, providing an external account sets it as the new default external account for its currency, and deletes the old default if one exists. To add additional external accounts without replacing the existing default for the currency, use the [bank account](https://docs.stripe.com/api#account_create_bank_account) or [card creation](https://docs.stripe.com/api#account_create_card) APIs. After you create an [Account Link](https://docs.stripe.com/api/account_links) or [Account Session](https://docs.stripe.com/api/account_sessions), this property can only be updated for Custom accounts. maxLength: 5000 type: string x-stripeBypassValidation: true individual: description: >- Information about the person represented by the account. This field is null unless `business_type` is set to `individual`. Once you create an [Account Link](https://docs.stripe.com/api/account_links) or [Account Session](https://docs.stripe.com/api/account_sessions), this property can only be updated for Custom accounts. properties: address: properties: city: maxLength: 100 type: string country: maxLength: 5000 type: string line1: maxLength: 200 type: string line2: maxLength: 200 type: string postal_code: maxLength: 5000 type: string state: maxLength: 5000 type: string title: address_specs type: object address_kana: properties: city: maxLength: 5000 type: string country: maxLength: 5000 type: string line1: maxLength: 5000 type: string line2: maxLength: 5000 type: string postal_code: maxLength: 5000 type: string state: maxLength: 5000 type: string town: maxLength: 5000 type: string title: japan_address_kana_specs type: object address_kanji: properties: city: maxLength: 5000 type: string country: maxLength: 5000 type: string line1: maxLength: 5000 type: string line2: maxLength: 5000 type: string postal_code: maxLength: 5000 type: string state: maxLength: 5000 type: string town: maxLength: 5000 type: string title: japan_address_kanji_specs type: object dob: anyOf: - properties: day: type: integer month: type: integer year: type: integer required: - day - month - year title: date_of_birth_specs type: object - enum: - '' type: string email: type: string first_name: maxLength: 100 type: string first_name_kana: maxLength: 5000 type: string first_name_kanji: maxLength: 5000 type: string full_name_aliases: anyOf: - items: maxLength: 300 type: string type: array - enum: - '' type: string gender: type: string id_number: maxLength: 5000 type: string id_number_secondary: maxLength: 5000 type: string last_name: maxLength: 100 type: string last_name_kana: maxLength: 5000 type: string last_name_kanji: maxLength: 5000 type: string maiden_name: maxLength: 5000 type: string metadata: anyOf: - additionalProperties: type: string type: object - enum: - '' type: string phone: type: string political_exposure: enum: - existing - none type: string registered_address: properties: city: maxLength: 100 type: string country: maxLength: 5000 type: string line1: maxLength: 200 type: string line2: maxLength: 200 type: string postal_code: maxLength: 5000 type: string state: maxLength: 5000 type: string title: address_specs type: object relationship: properties: director: type: boolean executive: type: boolean owner: type: boolean percent_ownership: anyOf: - type: number - enum: - '' type: string title: maxLength: 5000 type: string title: individual_relationship_specs type: object ssn_last_4: maxLength: 5000 type: string verification: properties: additional_document: properties: back: maxLength: 500 type: string front: maxLength: 500 type: string title: person_verification_document_specs type: object document: properties: back: maxLength: 500 type: string front: maxLength: 500 type: string title: person_verification_document_specs type: object title: person_verification_specs type: object title: individual_specs type: object metadata: anyOf: - additionalProperties: type: string type: object - enum: - '' type: string description: >- Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. settings: description: >- Options for customizing how the account functions within Stripe. properties: bacs_debit_payments: properties: display_name: type: string title: bacs_debit_payments_specs type: object branding: properties: icon: maxLength: 5000 type: string logo: maxLength: 5000 type: string primary_color: maxLength: 5000 type: string secondary_color: maxLength: 5000 type: string title: branding_settings_specs type: object card_issuing: properties: tos_acceptance: properties: date: format: unix-time type: integer ip: type: string user_agent: anyOf: - maxLength: 5000 type: string - enum: - '' type: string title: settings_terms_of_service_specs type: object title: card_issuing_settings_specs type: object card_payments: properties: decline_on: properties: avs_failure: type: boolean cvc_failure: type: boolean title: decline_charge_on_specs type: object statement_descriptor_prefix: maxLength: 10 type: string statement_descriptor_prefix_kana: anyOf: - maxLength: 10 type: string - enum: - '' type: string statement_descriptor_prefix_kanji: anyOf: - maxLength: 10 type: string - enum: - '' type: string title: card_payments_settings_specs type: object payments: properties: statement_descriptor: maxLength: 22 type: string statement_descriptor_kana: maxLength: 22 type: string statement_descriptor_kanji: maxLength: 22 type: string title: payments_settings_specs type: object payouts: properties: debit_negative_balances: type: boolean schedule: properties: delay_days: anyOf: - enum: - minimum maxLength: 5000 type: string - type: integer interval: enum: - daily - manual - monthly - weekly maxLength: 5000 type: string x-stripeBypassValidation: true monthly_anchor: type: integer weekly_anchor: enum: - friday - monday - saturday - sunday - thursday - tuesday - wednesday maxLength: 5000 type: string title: transfer_schedule_specs type: object statement_descriptor: maxLength: 22 type: string title: payout_settings_specs type: object treasury: properties: tos_acceptance: properties: date: format: unix-time type: integer ip: type: string user_agent: anyOf: - maxLength: 5000 type: string - enum: - '' type: string title: settings_terms_of_service_specs type: object title: treasury_settings_specs type: object title: settings_specs type: object tos_acceptance: description: >- Details on the account's acceptance of the [Stripe Services Agreement](https://docs.stripe.com/connect/updating-accounts#tos-acceptance) This property can only be updated for Custom accounts. properties: date: format: unix-time type: integer ip: type: string service_agreement: maxLength: 5000 type: string user_agent: maxLength: 5000 type: string title: tos_acceptance_specs type: object type: description: >- The type of Stripe account to create. May be one of `custom`, `express` or `standard`. enum: - custom - express - standard type: string type: object required: false responses: '200': content: application/json: schema: $ref: '#/components/schemas/account' description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. '/v1/accounts/{account}': delete: description: >-

With Connect, you can delete accounts you manage.

Accounts created using test-mode keys can be deleted at any time. Standard accounts created using live-mode keys cannot be deleted. Custom or Express accounts created using live-mode keys can only be deleted once all balances are zero.

If you want to delete your own account, use the account information tab in your account settings instead.

operationId: DeleteAccountsAccount parameters: - in: path name: account required: true schema: maxLength: 5000 type: string style: simple requestBody: content: application/x-www-form-urlencoded: encoding: {} schema: additionalProperties: false properties: {} type: object required: false responses: '200': content: application/json: schema: $ref: '#/components/schemas/deleted_account' description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. get: description:

Retrieves the details of an account.

operationId: GetAccountsAccount parameters: - in: path name: account required: true schema: maxLength: 5000 type: string style: simple - description: Specifies which fields in the response should be expanded. explode: true in: query name: expand required: false schema: items: maxLength: 5000 type: string type: array style: deepObject requestBody: content: application/x-www-form-urlencoded: encoding: {} schema: additionalProperties: false properties: {} type: object required: false responses: '200': content: application/json: schema: $ref: '#/components/schemas/account' description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. post: description: >-

Updates a connected account by setting the values of the parameters passed. Any parameters not provided are left unchanged.

For Custom accounts, you can update any information on the account. For other accounts, you can update all information until that account has started to go through Connect Onboarding. Once you create an Account Link or Account Session, some properties can only be changed or updated for Custom accounts.

To update your own account, use the Dashboard. Refer to our Connect documentation to learn more about updating accounts.

operationId: PostAccountsAccount parameters: - in: path name: account required: true schema: maxLength: 5000 type: string style: simple requestBody: content: application/x-www-form-urlencoded: encoding: business_profile: explode: true style: deepObject capabilities: explode: true style: deepObject company: explode: true style: deepObject documents: explode: true style: deepObject expand: explode: true style: deepObject individual: explode: true style: deepObject metadata: explode: true style: deepObject settings: explode: true style: deepObject tos_acceptance: explode: true style: deepObject schema: additionalProperties: false properties: account_token: description: >- An [account token](https://stripe.com/docs/api#create_account_token), used to securely provide details to the account. maxLength: 5000 type: string business_profile: description: Business information about the account. properties: annual_revenue: properties: amount: type: integer currency: type: string fiscal_year_end: maxLength: 5000 type: string required: - amount - currency - fiscal_year_end title: annual_revenue_specs type: object estimated_worker_count: type: integer mcc: maxLength: 4 type: string monthly_estimated_revenue: properties: amount: type: integer currency: type: string required: - amount - currency title: monthly_estimated_revenue_specs type: object name: maxLength: 5000 type: string product_description: maxLength: 40000 type: string support_address: properties: city: maxLength: 100 type: string country: maxLength: 5000 type: string line1: maxLength: 200 type: string line2: maxLength: 200 type: string postal_code: maxLength: 5000 type: string state: maxLength: 5000 type: string title: address_specs type: object support_email: type: string support_phone: maxLength: 5000 type: string support_url: anyOf: - type: string - enum: - '' type: string url: type: string title: business_profile_specs type: object business_type: description: >- The business type. Once you create an [Account Link](https://docs.stripe.com/api/account_links) or [Account Session](https://docs.stripe.com/api/account_sessions), this property can only be updated for Custom accounts. enum: - company - government_entity - individual - non_profit type: string x-stripeBypassValidation: true capabilities: description: >- Each key of the dictionary represents a capability, and each capability maps to its settings (e.g. whether it has been requested or not). Each capability will be inactive until you have provided its specific requirements and Stripe has verified them. An account may have some of its requested capabilities be active and some be inactive. properties: acss_debit_payments: properties: requested: type: boolean title: capability_param type: object affirm_payments: properties: requested: type: boolean title: capability_param type: object afterpay_clearpay_payments: properties: requested: type: boolean title: capability_param type: object amazon_pay_payments: properties: requested: type: boolean title: capability_param type: object au_becs_debit_payments: properties: requested: type: boolean title: capability_param type: object bacs_debit_payments: properties: requested: type: boolean title: capability_param type: object bancontact_payments: properties: requested: type: boolean title: capability_param type: object bank_transfer_payments: properties: requested: type: boolean title: capability_param type: object blik_payments: properties: requested: type: boolean title: capability_param type: object boleto_payments: properties: requested: type: boolean title: capability_param type: object card_issuing: properties: requested: type: boolean title: capability_param type: object card_payments: properties: requested: type: boolean title: capability_param type: object cartes_bancaires_payments: properties: requested: type: boolean title: capability_param type: object cashapp_payments: properties: requested: type: boolean title: capability_param type: object eps_payments: properties: requested: type: boolean title: capability_param type: object fpx_payments: properties: requested: type: boolean title: capability_param type: object giropay_payments: properties: requested: type: boolean title: capability_param type: object grabpay_payments: properties: requested: type: boolean title: capability_param type: object ideal_payments: properties: requested: type: boolean title: capability_param type: object india_international_payments: properties: requested: type: boolean title: capability_param type: object jcb_payments: properties: requested: type: boolean title: capability_param type: object klarna_payments: properties: requested: type: boolean title: capability_param type: object konbini_payments: properties: requested: type: boolean title: capability_param type: object legacy_payments: properties: requested: type: boolean title: capability_param type: object link_payments: properties: requested: type: boolean title: capability_param type: object mobilepay_payments: properties: requested: type: boolean title: capability_param type: object oxxo_payments: properties: requested: type: boolean title: capability_param type: object p24_payments: properties: requested: type: boolean title: capability_param type: object paynow_payments: properties: requested: type: boolean title: capability_param type: object promptpay_payments: properties: requested: type: boolean title: capability_param type: object revolut_pay_payments: properties: requested: type: boolean title: capability_param type: object sepa_debit_payments: properties: requested: type: boolean title: capability_param type: object sofort_payments: properties: requested: type: boolean title: capability_param type: object swish_payments: properties: requested: type: boolean title: capability_param type: object tax_reporting_us_1099_k: properties: requested: type: boolean title: capability_param type: object tax_reporting_us_1099_misc: properties: requested: type: boolean title: capability_param type: object transfers: properties: requested: type: boolean title: capability_param type: object treasury: properties: requested: type: boolean title: capability_param type: object us_bank_account_ach_payments: properties: requested: type: boolean title: capability_param type: object zip_payments: properties: requested: type: boolean title: capability_param type: object title: capabilities_param type: object company: description: >- Information about the company or business. This field is available for any `business_type`. Once you create an [Account Link](https://docs.stripe.com/api/account_links) or [Account Session](https://docs.stripe.com/api/account_sessions), this property can only be updated for Custom accounts. properties: address: properties: city: maxLength: 100 type: string country: maxLength: 5000 type: string line1: maxLength: 200 type: string line2: maxLength: 200 type: string postal_code: maxLength: 5000 type: string state: maxLength: 5000 type: string title: address_specs type: object address_kana: properties: city: maxLength: 5000 type: string country: maxLength: 5000 type: string line1: maxLength: 5000 type: string line2: maxLength: 5000 type: string postal_code: maxLength: 5000 type: string state: maxLength: 5000 type: string town: maxLength: 5000 type: string title: japan_address_kana_specs type: object address_kanji: properties: city: maxLength: 5000 type: string country: maxLength: 5000 type: string line1: maxLength: 5000 type: string line2: maxLength: 5000 type: string postal_code: maxLength: 5000 type: string state: maxLength: 5000 type: string town: maxLength: 5000 type: string title: japan_address_kanji_specs type: object directors_provided: type: boolean executives_provided: type: boolean export_license_id: maxLength: 5000 type: string export_purpose_code: maxLength: 5000 type: string name: maxLength: 100 type: string name_kana: maxLength: 100 type: string name_kanji: maxLength: 100 type: string owners_provided: type: boolean ownership_declaration: properties: date: format: unix-time type: integer ip: type: string user_agent: maxLength: 5000 type: string title: company_ownership_declaration type: object phone: maxLength: 5000 type: string registration_number: maxLength: 5000 type: string structure: enum: - '' - 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 type: string x-stripeBypassValidation: true tax_id: maxLength: 5000 type: string tax_id_registrar: maxLength: 5000 type: string vat_id: maxLength: 5000 type: string verification: properties: document: properties: back: maxLength: 500 type: string front: maxLength: 500 type: string title: verification_document_specs type: object title: verification_specs type: object title: company_specs type: object default_currency: description: >- 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://docs.stripe.com/payouts). type: string documents: description: >- Documents that may be submitted to satisfy various informational requests. properties: bank_account_ownership_verification: properties: files: items: maxLength: 500 type: string type: array title: documents_param type: object company_license: properties: files: items: maxLength: 500 type: string type: array title: documents_param type: object company_memorandum_of_association: properties: files: items: maxLength: 500 type: string type: array title: documents_param type: object company_ministerial_decree: properties: files: items: maxLength: 500 type: string type: array title: documents_param type: object company_registration_verification: properties: files: items: maxLength: 500 type: string type: array title: documents_param type: object company_tax_id_verification: properties: files: items: maxLength: 500 type: string type: array title: documents_param type: object proof_of_registration: properties: files: items: maxLength: 500 type: string type: array title: documents_param type: object title: documents_specs type: object email: description: >- The email address of the account holder. This is only to make the account easier to identify to you. Stripe only emails Custom accounts with your consent. type: string expand: description: Specifies which fields in the response should be expanded. items: maxLength: 5000 type: string type: array external_account: description: >- A card or bank account to attach to the account for receiving [payouts](https://docs.stripe.com/connect/bank-debit-card-payouts) (you won’t be able to use it for top-ups). You can provide either a token, like the ones returned by [Stripe.js](https://docs.stripe.com/js), or a dictionary, as documented in the `external_account` parameter for [bank account](https://docs.stripe.com/api#account_create_bank_account) creation.

By default, providing an external account sets it as the new default external account for its currency, and deletes the old default if one exists. To add additional external accounts without replacing the existing default for the currency, use the [bank account](https://docs.stripe.com/api#account_create_bank_account) or [card creation](https://docs.stripe.com/api#account_create_card) APIs. After you create an [Account Link](https://docs.stripe.com/api/account_links) or [Account Session](https://docs.stripe.com/api/account_sessions), this property can only be updated for Custom accounts. maxLength: 5000 type: string x-stripeBypassValidation: true individual: description: >- Information about the person represented by the account. This field is null unless `business_type` is set to `individual`. Once you create an [Account Link](https://docs.stripe.com/api/account_links) or [Account Session](https://docs.stripe.com/api/account_sessions), this property can only be updated for Custom accounts. properties: address: properties: city: maxLength: 100 type: string country: maxLength: 5000 type: string line1: maxLength: 200 type: string line2: maxLength: 200 type: string postal_code: maxLength: 5000 type: string state: maxLength: 5000 type: string title: address_specs type: object address_kana: properties: city: maxLength: 5000 type: string country: maxLength: 5000 type: string line1: maxLength: 5000 type: string line2: maxLength: 5000 type: string postal_code: maxLength: 5000 type: string state: maxLength: 5000 type: string town: maxLength: 5000 type: string title: japan_address_kana_specs type: object address_kanji: properties: city: maxLength: 5000 type: string country: maxLength: 5000 type: string line1: maxLength: 5000 type: string line2: maxLength: 5000 type: string postal_code: maxLength: 5000 type: string state: maxLength: 5000 type: string town: maxLength: 5000 type: string title: japan_address_kanji_specs type: object dob: anyOf: - properties: day: type: integer month: type: integer year: type: integer required: - day - month - year title: date_of_birth_specs type: object - enum: - '' type: string email: type: string first_name: maxLength: 100 type: string first_name_kana: maxLength: 5000 type: string first_name_kanji: maxLength: 5000 type: string full_name_aliases: anyOf: - items: maxLength: 300 type: string type: array - enum: - '' type: string gender: type: string id_number: maxLength: 5000 type: string id_number_secondary: maxLength: 5000 type: string last_name: maxLength: 100 type: string last_name_kana: maxLength: 5000 type: string last_name_kanji: maxLength: 5000 type: string maiden_name: maxLength: 5000 type: string metadata: anyOf: - additionalProperties: type: string type: object - enum: - '' type: string phone: type: string political_exposure: enum: - existing - none type: string registered_address: properties: city: maxLength: 100 type: string country: maxLength: 5000 type: string line1: maxLength: 200 type: string line2: maxLength: 200 type: string postal_code: maxLength: 5000 type: string state: maxLength: 5000 type: string title: address_specs type: object relationship: properties: director: type: boolean executive: type: boolean owner: type: boolean percent_ownership: anyOf: - type: number - enum: - '' type: string title: maxLength: 5000 type: string title: individual_relationship_specs type: object ssn_last_4: maxLength: 5000 type: string verification: properties: additional_document: properties: back: maxLength: 500 type: string front: maxLength: 500 type: string title: person_verification_document_specs type: object document: properties: back: maxLength: 500 type: string front: maxLength: 500 type: string title: person_verification_document_specs type: object title: person_verification_specs type: object title: individual_specs type: object metadata: anyOf: - additionalProperties: type: string type: object - enum: - '' type: string description: >- Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. settings: description: >- Options for customizing how the account functions within Stripe. properties: bacs_debit_payments: properties: display_name: type: string title: bacs_debit_payments_specs type: object branding: properties: icon: maxLength: 5000 type: string logo: maxLength: 5000 type: string primary_color: maxLength: 5000 type: string secondary_color: maxLength: 5000 type: string title: branding_settings_specs type: object card_issuing: properties: tos_acceptance: properties: date: format: unix-time type: integer ip: type: string user_agent: anyOf: - maxLength: 5000 type: string - enum: - '' type: string title: settings_terms_of_service_specs type: object title: card_issuing_settings_specs type: object card_payments: properties: decline_on: properties: avs_failure: type: boolean cvc_failure: type: boolean title: decline_charge_on_specs type: object statement_descriptor_prefix: maxLength: 10 type: string statement_descriptor_prefix_kana: anyOf: - maxLength: 10 type: string - enum: - '' type: string statement_descriptor_prefix_kanji: anyOf: - maxLength: 10 type: string - enum: - '' type: string title: card_payments_settings_specs type: object invoices: properties: default_account_tax_ids: anyOf: - items: maxLength: 5000 type: string type: array - enum: - '' type: string title: invoices_settings_specs type: object payments: properties: statement_descriptor: maxLength: 22 type: string statement_descriptor_kana: maxLength: 22 type: string statement_descriptor_kanji: maxLength: 22 type: string title: payments_settings_specs type: object payouts: properties: debit_negative_balances: type: boolean schedule: properties: delay_days: anyOf: - enum: - minimum maxLength: 5000 type: string - type: integer interval: enum: - daily - manual - monthly - weekly maxLength: 5000 type: string x-stripeBypassValidation: true monthly_anchor: type: integer weekly_anchor: enum: - friday - monday - saturday - sunday - thursday - tuesday - wednesday maxLength: 5000 type: string title: transfer_schedule_specs type: object statement_descriptor: maxLength: 22 type: string title: payout_settings_specs type: object treasury: properties: tos_acceptance: properties: date: format: unix-time type: integer ip: type: string user_agent: anyOf: - maxLength: 5000 type: string - enum: - '' type: string title: settings_terms_of_service_specs type: object title: treasury_settings_specs type: object title: settings_specs_update type: object tos_acceptance: description: >- Details on the account's acceptance of the [Stripe Services Agreement](https://docs.stripe.com/connect/updating-accounts#tos-acceptance) This property can only be updated for Custom accounts. properties: date: format: unix-time type: integer ip: type: string service_agreement: maxLength: 5000 type: string user_agent: maxLength: 5000 type: string title: tos_acceptance_specs type: object type: object required: false responses: '200': content: application/json: schema: $ref: '#/components/schemas/account' description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. '/v1/accounts/{account}/bank_accounts': post: description:

Create an external account for a given account.

operationId: PostAccountsAccountBankAccounts parameters: - in: path name: account required: true schema: maxLength: 5000 type: string style: simple requestBody: content: application/x-www-form-urlencoded: encoding: bank_account: explode: true style: deepObject expand: explode: true style: deepObject metadata: explode: true style: deepObject schema: additionalProperties: false properties: bank_account: anyOf: - properties: account_holder_name: maxLength: 5000 type: string account_holder_type: enum: - company - individual maxLength: 5000 type: string account_number: maxLength: 5000 type: string account_type: enum: - checking - futsu - savings - toza maxLength: 5000 type: string country: maxLength: 5000 type: string currency: type: string documents: properties: bank_account_ownership_verification: properties: files: items: maxLength: 500 type: string type: array title: documents_param type: object title: external_account_documents_param type: object object: enum: - bank_account maxLength: 5000 type: string routing_number: maxLength: 5000 type: string required: - account_number - country title: external_account_payout_bank_account type: object - maxLength: 5000 type: string description: >- Either a token, like the ones returned by [Stripe.js](https://stripe.com/docs/js), or a dictionary containing a user's bank account details. default_for_currency: description: >- When set to true, or if this is the first external account added in this currency, this account becomes the default external account for its currency. type: boolean expand: description: Specifies which fields in the response should be expanded. items: maxLength: 5000 type: string type: array external_account: description: >- Please refer to full [documentation](https://stripe.com/docs/api) instead. maxLength: 5000 type: string x-stripeBypassValidation: true metadata: additionalProperties: type: string description: >- Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. type: object type: object required: false responses: '200': content: application/json: schema: $ref: '#/components/schemas/external_account' description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. '/v1/accounts/{account}/bank_accounts/{id}': delete: description:

Delete a specified external account for a given account.

operationId: DeleteAccountsAccountBankAccountsId parameters: - in: path name: account required: true schema: maxLength: 5000 type: string style: simple - in: path name: id required: true schema: type: string style: simple requestBody: content: application/x-www-form-urlencoded: encoding: {} schema: additionalProperties: false properties: {} type: object required: false responses: '200': content: application/json: schema: $ref: '#/components/schemas/deleted_external_account' description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. get: description:

Retrieve a specified external account for a given account.

operationId: GetAccountsAccountBankAccountsId parameters: - in: path name: account required: true schema: maxLength: 5000 type: string style: simple - description: Specifies which fields in the response should be expanded. explode: true in: query name: expand required: false schema: items: maxLength: 5000 type: string type: array style: deepObject - in: path name: id required: true schema: type: string style: simple requestBody: content: application/x-www-form-urlencoded: encoding: {} schema: additionalProperties: false properties: {} type: object required: false responses: '200': content: application/json: schema: $ref: '#/components/schemas/external_account' description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. post: description: >-

Updates the metadata, account holder name, account holder type of a bank account belonging to a Custom account, and optionally sets it as the default for its currency. Other bank account details are not editable by design.

You can re-enable a disabled bank account by performing an update call without providing any arguments or changes.

operationId: PostAccountsAccountBankAccountsId parameters: - in: path name: account required: true schema: maxLength: 5000 type: string style: simple - in: path name: id required: true schema: type: string style: simple requestBody: content: application/x-www-form-urlencoded: encoding: documents: explode: true style: deepObject expand: explode: true style: deepObject metadata: explode: true style: deepObject schema: additionalProperties: false properties: account_holder_name: description: >- The name of the person or business that owns the bank account. maxLength: 5000 type: string account_holder_type: description: >- The type of entity that holds the account. This can be either `individual` or `company`. enum: - '' - company - individual maxLength: 5000 type: string account_type: description: >- The bank account type. This can only be `checking` or `savings` in most countries. In Japan, this can only be `futsu` or `toza`. enum: - checking - futsu - savings - toza maxLength: 5000 type: string address_city: description: City/District/Suburb/Town/Village. maxLength: 5000 type: string address_country: description: 'Billing address country, if provided when creating card.' maxLength: 5000 type: string address_line1: description: Address line 1 (Street address/PO Box/Company name). maxLength: 5000 type: string address_line2: description: Address line 2 (Apartment/Suite/Unit/Building). maxLength: 5000 type: string address_state: description: State/County/Province/Region. maxLength: 5000 type: string address_zip: description: ZIP or postal code. maxLength: 5000 type: string default_for_currency: description: >- When set to true, this becomes the default external account for its currency. type: boolean documents: description: >- Documents that may be submitted to satisfy various informational requests. properties: bank_account_ownership_verification: properties: files: items: maxLength: 500 type: string type: array title: documents_param type: object title: external_account_documents_param type: object exp_month: description: Two digit number representing the card’s expiration month. maxLength: 5000 type: string exp_year: description: Four digit number representing the card’s expiration year. maxLength: 5000 type: string expand: description: Specifies which fields in the response should be expanded. items: maxLength: 5000 type: string type: array metadata: anyOf: - additionalProperties: type: string type: object - enum: - '' type: string description: >- Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. name: description: Cardholder name. maxLength: 5000 type: string type: object required: false responses: '200': content: application/json: schema: $ref: '#/components/schemas/external_account' description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. '/v1/accounts/{account}/capabilities': get: description: >-

Returns a list of capabilities associated with the account. The capabilities are returned sorted by creation date, with the most recent capability appearing first.

operationId: GetAccountsAccountCapabilities parameters: - in: path name: account required: true schema: maxLength: 5000 type: string style: simple - description: Specifies which fields in the response should be expanded. explode: true in: query name: expand required: false schema: items: maxLength: 5000 type: string type: array style: deepObject requestBody: content: application/x-www-form-urlencoded: encoding: {} schema: additionalProperties: false properties: {} type: object required: false responses: '200': content: application/json: schema: description: '' properties: data: items: $ref: '#/components/schemas/capability' type: array has_more: description: >- True if this list has another page of items after this one that can be fetched. type: boolean object: description: >- String representing the object's type. Objects of the same type share the same value. Always has the value `list`. enum: - list type: string url: description: The URL where this list can be accessed. maxLength: 5000 type: string required: - data - has_more - object - url title: ListAccountCapability type: object x-expandableFields: - data description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. '/v1/accounts/{account}/capabilities/{capability}': get: description:

Retrieves information about the specified Account Capability.

operationId: GetAccountsAccountCapabilitiesCapability parameters: - in: path name: account required: true schema: maxLength: 5000 type: string style: simple - in: path name: capability required: true schema: type: string style: simple - description: Specifies which fields in the response should be expanded. explode: true in: query name: expand required: false schema: items: maxLength: 5000 type: string type: array style: deepObject requestBody: content: application/x-www-form-urlencoded: encoding: {} schema: additionalProperties: false properties: {} type: object required: false responses: '200': content: application/json: schema: $ref: '#/components/schemas/capability' description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. post: description: >-

Updates an existing Account Capability. Request or remove a capability by updating its requested parameter.

operationId: PostAccountsAccountCapabilitiesCapability parameters: - in: path name: account required: true schema: maxLength: 5000 type: string style: simple - in: path name: capability required: true schema: type: string style: simple requestBody: content: application/x-www-form-urlencoded: encoding: expand: explode: true style: deepObject schema: additionalProperties: false properties: expand: description: Specifies which fields in the response should be expanded. items: maxLength: 5000 type: string type: array requested: description: >- To request a new capability for an account, pass true. There can be a delay before the requested capability becomes active. If the capability has any activation requirements, the response includes them in the `requirements` arrays. If a capability isn't permanent, you can remove it from the account by passing false. Most capabilities are permanent after they've been requested. Attempting to remove a permanent capability returns an error. type: boolean type: object required: false responses: '200': content: application/json: schema: $ref: '#/components/schemas/capability' description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. '/v1/accounts/{account}/external_accounts': get: description:

List external accounts for an account.

operationId: GetAccountsAccountExternalAccounts parameters: - in: path name: account required: true schema: maxLength: 5000 type: string style: simple - description: >- A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. in: query name: ending_before required: false schema: type: string style: form - description: Specifies which fields in the response should be expanded. explode: true in: query name: expand required: false schema: items: maxLength: 5000 type: string type: array style: deepObject - description: >- A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. in: query name: limit required: false schema: type: integer style: form - description: Filter external accounts according to a particular object type. in: query name: object required: false schema: enum: - bank_account - card maxLength: 5000 type: string x-stripeBypassValidation: true style: form - description: >- A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. in: query name: starting_after required: false schema: type: string style: form requestBody: content: application/x-www-form-urlencoded: encoding: {} schema: additionalProperties: false properties: {} type: object required: false responses: '200': content: application/json: schema: description: '' properties: data: description: >- The list contains all external accounts that have been attached to the Stripe account. These may be bank accounts or cards. items: anyOf: - $ref: '#/components/schemas/bank_account' - $ref: '#/components/schemas/card' title: Polymorphic x-stripeBypassValidation: true type: array has_more: description: >- True if this list has another page of items after this one that can be fetched. type: boolean object: description: >- String representing the object's type. Objects of the same type share the same value. Always has the value `list`. enum: - list type: string url: description: The URL where this list can be accessed. maxLength: 5000 type: string required: - data - has_more - object - url title: ExternalAccountList type: object x-expandableFields: - data description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. post: description:

Create an external account for a given account.

operationId: PostAccountsAccountExternalAccounts parameters: - in: path name: account required: true schema: maxLength: 5000 type: string style: simple requestBody: content: application/x-www-form-urlencoded: encoding: bank_account: explode: true style: deepObject expand: explode: true style: deepObject metadata: explode: true style: deepObject schema: additionalProperties: false properties: bank_account: anyOf: - properties: account_holder_name: maxLength: 5000 type: string account_holder_type: enum: - company - individual maxLength: 5000 type: string account_number: maxLength: 5000 type: string account_type: enum: - checking - futsu - savings - toza maxLength: 5000 type: string country: maxLength: 5000 type: string currency: type: string documents: properties: bank_account_ownership_verification: properties: files: items: maxLength: 500 type: string type: array title: documents_param type: object title: external_account_documents_param type: object object: enum: - bank_account maxLength: 5000 type: string routing_number: maxLength: 5000 type: string required: - account_number - country title: external_account_payout_bank_account type: object - maxLength: 5000 type: string description: >- Either a token, like the ones returned by [Stripe.js](https://stripe.com/docs/js), or a dictionary containing a user's bank account details. default_for_currency: description: >- When set to true, or if this is the first external account added in this currency, this account becomes the default external account for its currency. type: boolean expand: description: Specifies which fields in the response should be expanded. items: maxLength: 5000 type: string type: array external_account: description: >- Please refer to full [documentation](https://stripe.com/docs/api) instead. maxLength: 5000 type: string x-stripeBypassValidation: true metadata: additionalProperties: type: string description: >- Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. type: object type: object required: false responses: '200': content: application/json: schema: $ref: '#/components/schemas/external_account' description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. '/v1/accounts/{account}/external_accounts/{id}': delete: description:

Delete a specified external account for a given account.

operationId: DeleteAccountsAccountExternalAccountsId parameters: - in: path name: account required: true schema: maxLength: 5000 type: string style: simple - in: path name: id required: true schema: type: string style: simple requestBody: content: application/x-www-form-urlencoded: encoding: {} schema: additionalProperties: false properties: {} type: object required: false responses: '200': content: application/json: schema: $ref: '#/components/schemas/deleted_external_account' description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. get: description:

Retrieve a specified external account for a given account.

operationId: GetAccountsAccountExternalAccountsId parameters: - in: path name: account required: true schema: maxLength: 5000 type: string style: simple - description: Specifies which fields in the response should be expanded. explode: true in: query name: expand required: false schema: items: maxLength: 5000 type: string type: array style: deepObject - in: path name: id required: true schema: type: string style: simple requestBody: content: application/x-www-form-urlencoded: encoding: {} schema: additionalProperties: false properties: {} type: object required: false responses: '200': content: application/json: schema: $ref: '#/components/schemas/external_account' description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. post: description: >-

Updates the metadata, account holder name, account holder type of a bank account belonging to a Custom account, and optionally sets it as the default for its currency. Other bank account details are not editable by design.

You can re-enable a disabled bank account by performing an update call without providing any arguments or changes.

operationId: PostAccountsAccountExternalAccountsId parameters: - in: path name: account required: true schema: maxLength: 5000 type: string style: simple - in: path name: id required: true schema: type: string style: simple requestBody: content: application/x-www-form-urlencoded: encoding: documents: explode: true style: deepObject expand: explode: true style: deepObject metadata: explode: true style: deepObject schema: additionalProperties: false properties: account_holder_name: description: >- The name of the person or business that owns the bank account. maxLength: 5000 type: string account_holder_type: description: >- The type of entity that holds the account. This can be either `individual` or `company`. enum: - '' - company - individual maxLength: 5000 type: string account_type: description: >- The bank account type. This can only be `checking` or `savings` in most countries. In Japan, this can only be `futsu` or `toza`. enum: - checking - futsu - savings - toza maxLength: 5000 type: string address_city: description: City/District/Suburb/Town/Village. maxLength: 5000 type: string address_country: description: 'Billing address country, if provided when creating card.' maxLength: 5000 type: string address_line1: description: Address line 1 (Street address/PO Box/Company name). maxLength: 5000 type: string address_line2: description: Address line 2 (Apartment/Suite/Unit/Building). maxLength: 5000 type: string address_state: description: State/County/Province/Region. maxLength: 5000 type: string address_zip: description: ZIP or postal code. maxLength: 5000 type: string default_for_currency: description: >- When set to true, this becomes the default external account for its currency. type: boolean documents: description: >- Documents that may be submitted to satisfy various informational requests. properties: bank_account_ownership_verification: properties: files: items: maxLength: 500 type: string type: array title: documents_param type: object title: external_account_documents_param type: object exp_month: description: Two digit number representing the card’s expiration month. maxLength: 5000 type: string exp_year: description: Four digit number representing the card’s expiration year. maxLength: 5000 type: string expand: description: Specifies which fields in the response should be expanded. items: maxLength: 5000 type: string type: array metadata: anyOf: - additionalProperties: type: string type: object - enum: - '' type: string description: >- Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. name: description: Cardholder name. maxLength: 5000 type: string type: object required: false responses: '200': content: application/json: schema: $ref: '#/components/schemas/external_account' description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. '/v1/accounts/{account}/login_links': post: description: >-

Creates a single-use login link for an Express account to access their Stripe dashboard.

You may only create login links for Express accounts connected to your platform.

operationId: PostAccountsAccountLoginLinks parameters: - in: path name: account required: true schema: maxLength: 5000 type: string style: simple requestBody: content: application/x-www-form-urlencoded: encoding: expand: explode: true style: deepObject schema: additionalProperties: false properties: expand: description: Specifies which fields in the response should be expanded. items: maxLength: 5000 type: string type: array type: object required: false responses: '200': content: application/json: schema: $ref: '#/components/schemas/login_link' description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. '/v1/accounts/{account}/people': get: description: >-

Returns a list of people associated with the account’s legal entity. The people are returned sorted by creation date, with the most recent people appearing first.

operationId: GetAccountsAccountPeople parameters: - in: path name: account required: true schema: maxLength: 5000 type: string style: simple - description: >- A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. in: query name: ending_before required: false schema: maxLength: 5000 type: string style: form - description: Specifies which fields in the response should be expanded. explode: true in: query name: expand required: false schema: items: maxLength: 5000 type: string type: array style: deepObject - description: >- A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. in: query name: limit required: false schema: type: integer style: form - description: >- Filters on the list of people returned based on the person's relationship to the account's company. explode: true in: query name: relationship required: false schema: properties: director: type: boolean executive: type: boolean legal_guardian: type: boolean owner: type: boolean representative: type: boolean title: all_people_relationship_specs type: object style: deepObject - description: >- A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. in: query name: starting_after required: false schema: maxLength: 5000 type: string style: form requestBody: content: application/x-www-form-urlencoded: encoding: {} schema: additionalProperties: false properties: {} type: object required: false responses: '200': content: application/json: schema: description: '' properties: data: items: $ref: '#/components/schemas/person' type: array has_more: description: >- True if this list has another page of items after this one that can be fetched. type: boolean object: description: >- String representing the object's type. Objects of the same type share the same value. Always has the value `list`. enum: - list type: string url: description: The URL where this list can be accessed. maxLength: 5000 type: string required: - data - has_more - object - url title: PersonList type: object x-expandableFields: - data description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. post: description:

Creates a new person.

operationId: PostAccountsAccountPeople parameters: - in: path name: account required: true schema: maxLength: 5000 type: string style: simple requestBody: content: application/x-www-form-urlencoded: encoding: additional_tos_acceptances: explode: true style: deepObject address: explode: true style: deepObject address_kana: explode: true style: deepObject address_kanji: explode: true style: deepObject dob: explode: true style: deepObject documents: explode: true style: deepObject expand: explode: true style: deepObject full_name_aliases: explode: true style: deepObject metadata: explode: true style: deepObject registered_address: explode: true style: deepObject relationship: explode: true style: deepObject verification: explode: true style: deepObject schema: additionalProperties: false properties: additional_tos_acceptances: description: >- Details on the legal guardian's acceptance of the required Stripe agreements. properties: account: properties: date: format: unix-time type: integer ip: type: string user_agent: anyOf: - maxLength: 5000 type: string - enum: - '' type: string title: settings_terms_of_service_specs type: object title: person_additional_tos_acceptances_specs type: object address: description: The person's address. properties: city: maxLength: 100 type: string country: maxLength: 5000 type: string line1: maxLength: 200 type: string line2: maxLength: 200 type: string postal_code: maxLength: 5000 type: string state: maxLength: 5000 type: string title: address_specs type: object address_kana: description: The Kana variation of the person's address (Japan only). properties: city: maxLength: 5000 type: string country: maxLength: 5000 type: string line1: maxLength: 5000 type: string line2: maxLength: 5000 type: string postal_code: maxLength: 5000 type: string state: maxLength: 5000 type: string town: maxLength: 5000 type: string title: japan_address_kana_specs type: object address_kanji: description: The Kanji variation of the person's address (Japan only). properties: city: maxLength: 5000 type: string country: maxLength: 5000 type: string line1: maxLength: 5000 type: string line2: maxLength: 5000 type: string postal_code: maxLength: 5000 type: string state: maxLength: 5000 type: string town: maxLength: 5000 type: string title: japan_address_kanji_specs type: object dob: anyOf: - properties: day: type: integer month: type: integer year: type: integer required: - day - month - year title: date_of_birth_specs type: object - enum: - '' type: string description: The person's date of birth. documents: description: >- Documents that may be submitted to satisfy various informational requests. properties: company_authorization: properties: files: items: anyOf: - maxLength: 500 type: string - enum: - '' type: string type: array title: documents_param type: object passport: properties: files: items: anyOf: - maxLength: 500 type: string - enum: - '' type: string type: array title: documents_param type: object visa: properties: files: items: anyOf: - maxLength: 500 type: string - enum: - '' type: string type: array title: documents_param type: object title: person_documents_specs type: object email: description: The person's email address. type: string expand: description: Specifies which fields in the response should be expanded. items: maxLength: 5000 type: string type: array first_name: description: The person's first name. maxLength: 5000 type: string first_name_kana: description: The Kana variation of the person's first name (Japan only). maxLength: 5000 type: string first_name_kanji: description: The Kanji variation of the person's first name (Japan only). maxLength: 5000 type: string full_name_aliases: anyOf: - items: maxLength: 5000 type: string type: array - enum: - '' type: string description: >- A list of alternate names or aliases that the person is known by. gender: description: >- The person's gender (International regulations require either "male" or "female"). type: string id_number: description: >- The person's ID number, as appropriate for their country. For example, a social security number in the U.S., social insurance number in Canada, etc. Instead of the number itself, you can also provide a [PII token provided by Stripe.js](https://docs.stripe.com/js/tokens/create_token?type=pii). maxLength: 5000 type: string id_number_secondary: description: >- The person's secondary ID number, as appropriate for their country, will be used for enhanced verification checks. In Thailand, this would be the laser code found on the back of an ID card. Instead of the number itself, you can also provide a [PII token provided by Stripe.js](https://docs.stripe.com/js/tokens/create_token?type=pii). maxLength: 5000 type: string last_name: description: The person's last name. maxLength: 5000 type: string last_name_kana: description: The Kana variation of the person's last name (Japan only). maxLength: 5000 type: string last_name_kanji: description: The Kanji variation of the person's last name (Japan only). maxLength: 5000 type: string maiden_name: description: The person's maiden name. maxLength: 5000 type: string metadata: anyOf: - additionalProperties: type: string type: object - enum: - '' type: string description: >- Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. nationality: description: >- The country where the person is a national. Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)), or "XX" if unavailable. maxLength: 5000 type: string person_token: description: >- A [person token](https://docs.stripe.com/connect/account-tokens), used to securely provide details to the person. maxLength: 5000 type: string phone: description: The person's phone number. type: string political_exposure: description: >- 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. maxLength: 5000 type: string registered_address: description: The person's registered address. properties: city: maxLength: 100 type: string country: maxLength: 5000 type: string line1: maxLength: 200 type: string line2: maxLength: 200 type: string postal_code: maxLength: 5000 type: string state: maxLength: 5000 type: string title: address_specs type: object relationship: description: >- The relationship that this person has with the account's legal entity. properties: director: type: boolean executive: type: boolean legal_guardian: type: boolean owner: type: boolean percent_ownership: anyOf: - type: number - enum: - '' type: string representative: type: boolean title: maxLength: 5000 type: string title: relationship_specs type: object ssn_last_4: description: >- The last four digits of the person's Social Security number (U.S. only). type: string verification: description: The person's verification status. properties: additional_document: properties: back: maxLength: 500 type: string front: maxLength: 500 type: string title: person_verification_document_specs type: object document: properties: back: maxLength: 500 type: string front: maxLength: 500 type: string title: person_verification_document_specs type: object title: person_verification_specs type: object type: object required: false responses: '200': content: application/json: schema: $ref: '#/components/schemas/person' description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. '/v1/accounts/{account}/people/{person}': delete: description: >-

Deletes an existing person’s relationship to the account’s legal entity. Any person with a relationship for an account can be deleted through the API, except if the person is the account_opener. If your integration is using the executive parameter, you cannot delete the only verified executive on file.

operationId: DeleteAccountsAccountPeoplePerson parameters: - in: path name: account required: true schema: maxLength: 5000 type: string style: simple - in: path name: person required: true schema: maxLength: 5000 type: string style: simple requestBody: content: application/x-www-form-urlencoded: encoding: {} schema: additionalProperties: false properties: {} type: object required: false responses: '200': content: application/json: schema: $ref: '#/components/schemas/deleted_person' description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. get: description:

Retrieves an existing person.

operationId: GetAccountsAccountPeoplePerson parameters: - in: path name: account required: true schema: maxLength: 5000 type: string style: simple - description: Specifies which fields in the response should be expanded. explode: true in: query name: expand required: false schema: items: maxLength: 5000 type: string type: array style: deepObject - in: path name: person required: true schema: maxLength: 5000 type: string style: simple requestBody: content: application/x-www-form-urlencoded: encoding: {} schema: additionalProperties: false properties: {} type: object required: false responses: '200': content: application/json: schema: $ref: '#/components/schemas/person' description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. post: description:

Updates an existing person.

operationId: PostAccountsAccountPeoplePerson parameters: - in: path name: account required: true schema: maxLength: 5000 type: string style: simple - in: path name: person required: true schema: maxLength: 5000 type: string style: simple requestBody: content: application/x-www-form-urlencoded: encoding: additional_tos_acceptances: explode: true style: deepObject address: explode: true style: deepObject address_kana: explode: true style: deepObject address_kanji: explode: true style: deepObject dob: explode: true style: deepObject documents: explode: true style: deepObject expand: explode: true style: deepObject full_name_aliases: explode: true style: deepObject metadata: explode: true style: deepObject registered_address: explode: true style: deepObject relationship: explode: true style: deepObject verification: explode: true style: deepObject schema: additionalProperties: false properties: additional_tos_acceptances: description: >- Details on the legal guardian's acceptance of the required Stripe agreements. properties: account: properties: date: format: unix-time type: integer ip: type: string user_agent: anyOf: - maxLength: 5000 type: string - enum: - '' type: string title: settings_terms_of_service_specs type: object title: person_additional_tos_acceptances_specs type: object address: description: The person's address. properties: city: maxLength: 100 type: string country: maxLength: 5000 type: string line1: maxLength: 200 type: string line2: maxLength: 200 type: string postal_code: maxLength: 5000 type: string state: maxLength: 5000 type: string title: address_specs type: object address_kana: description: The Kana variation of the person's address (Japan only). properties: city: maxLength: 5000 type: string country: maxLength: 5000 type: string line1: maxLength: 5000 type: string line2: maxLength: 5000 type: string postal_code: maxLength: 5000 type: string state: maxLength: 5000 type: string town: maxLength: 5000 type: string title: japan_address_kana_specs type: object address_kanji: description: The Kanji variation of the person's address (Japan only). properties: city: maxLength: 5000 type: string country: maxLength: 5000 type: string line1: maxLength: 5000 type: string line2: maxLength: 5000 type: string postal_code: maxLength: 5000 type: string state: maxLength: 5000 type: string town: maxLength: 5000 type: string title: japan_address_kanji_specs type: object dob: anyOf: - properties: day: type: integer month: type: integer year: type: integer required: - day - month - year title: date_of_birth_specs type: object - enum: - '' type: string description: The person's date of birth. documents: description: >- Documents that may be submitted to satisfy various informational requests. properties: company_authorization: properties: files: items: anyOf: - maxLength: 500 type: string - enum: - '' type: string type: array title: documents_param type: object passport: properties: files: items: anyOf: - maxLength: 500 type: string - enum: - '' type: string type: array title: documents_param type: object visa: properties: files: items: anyOf: - maxLength: 500 type: string - enum: - '' type: string type: array title: documents_param type: object title: person_documents_specs type: object email: description: The person's email address. type: string expand: description: Specifies which fields in the response should be expanded. items: maxLength: 5000 type: string type: array first_name: description: The person's first name. maxLength: 5000 type: string first_name_kana: description: The Kana variation of the person's first name (Japan only). maxLength: 5000 type: string first_name_kanji: description: The Kanji variation of the person's first name (Japan only). maxLength: 5000 type: string full_name_aliases: anyOf: - items: maxLength: 5000 type: string type: array - enum: - '' type: string description: >- A list of alternate names or aliases that the person is known by. gender: description: >- The person's gender (International regulations require either "male" or "female"). type: string id_number: description: >- The person's ID number, as appropriate for their country. For example, a social security number in the U.S., social insurance number in Canada, etc. Instead of the number itself, you can also provide a [PII token provided by Stripe.js](https://docs.stripe.com/js/tokens/create_token?type=pii). maxLength: 5000 type: string id_number_secondary: description: >- The person's secondary ID number, as appropriate for their country, will be used for enhanced verification checks. In Thailand, this would be the laser code found on the back of an ID card. Instead of the number itself, you can also provide a [PII token provided by Stripe.js](https://docs.stripe.com/js/tokens/create_token?type=pii). maxLength: 5000 type: string last_name: description: The person's last name. maxLength: 5000 type: string last_name_kana: description: The Kana variation of the person's last name (Japan only). maxLength: 5000 type: string last_name_kanji: description: The Kanji variation of the person's last name (Japan only). maxLength: 5000 type: string maiden_name: description: The person's maiden name. maxLength: 5000 type: string metadata: anyOf: - additionalProperties: type: string type: object - enum: - '' type: string description: >- Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. nationality: description: >- The country where the person is a national. Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)), or "XX" if unavailable. maxLength: 5000 type: string person_token: description: >- A [person token](https://docs.stripe.com/connect/account-tokens), used to securely provide details to the person. maxLength: 5000 type: string phone: description: The person's phone number. type: string political_exposure: description: >- 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. maxLength: 5000 type: string registered_address: description: The person's registered address. properties: city: maxLength: 100 type: string country: maxLength: 5000 type: string line1: maxLength: 200 type: string line2: maxLength: 200 type: string postal_code: maxLength: 5000 type: string state: maxLength: 5000 type: string title: address_specs type: object relationship: description: >- The relationship that this person has with the account's legal entity. properties: director: type: boolean executive: type: boolean legal_guardian: type: boolean owner: type: boolean percent_ownership: anyOf: - type: number - enum: - '' type: string representative: type: boolean title: maxLength: 5000 type: string title: relationship_specs type: object ssn_last_4: description: >- The last four digits of the person's Social Security number (U.S. only). type: string verification: description: The person's verification status. properties: additional_document: properties: back: maxLength: 500 type: string front: maxLength: 500 type: string title: person_verification_document_specs type: object document: properties: back: maxLength: 500 type: string front: maxLength: 500 type: string title: person_verification_document_specs type: object title: person_verification_specs type: object type: object required: false responses: '200': content: application/json: schema: $ref: '#/components/schemas/person' description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. '/v1/accounts/{account}/persons': get: description: >-

Returns a list of people associated with the account’s legal entity. The people are returned sorted by creation date, with the most recent people appearing first.

operationId: GetAccountsAccountPersons parameters: - in: path name: account required: true schema: maxLength: 5000 type: string style: simple - description: >- A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. in: query name: ending_before required: false schema: maxLength: 5000 type: string style: form - description: Specifies which fields in the response should be expanded. explode: true in: query name: expand required: false schema: items: maxLength: 5000 type: string type: array style: deepObject - description: >- A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. in: query name: limit required: false schema: type: integer style: form - description: >- Filters on the list of people returned based on the person's relationship to the account's company. explode: true in: query name: relationship required: false schema: properties: director: type: boolean executive: type: boolean legal_guardian: type: boolean owner: type: boolean representative: type: boolean title: all_people_relationship_specs type: object style: deepObject - description: >- A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. in: query name: starting_after required: false schema: maxLength: 5000 type: string style: form requestBody: content: application/x-www-form-urlencoded: encoding: {} schema: additionalProperties: false properties: {} type: object required: false responses: '200': content: application/json: schema: description: '' properties: data: items: $ref: '#/components/schemas/person' type: array has_more: description: >- True if this list has another page of items after this one that can be fetched. type: boolean object: description: >- String representing the object's type. Objects of the same type share the same value. Always has the value `list`. enum: - list type: string url: description: The URL where this list can be accessed. maxLength: 5000 type: string required: - data - has_more - object - url title: PersonList type: object x-expandableFields: - data description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. post: description:

Creates a new person.

operationId: PostAccountsAccountPersons parameters: - in: path name: account required: true schema: maxLength: 5000 type: string style: simple requestBody: content: application/x-www-form-urlencoded: encoding: additional_tos_acceptances: explode: true style: deepObject address: explode: true style: deepObject address_kana: explode: true style: deepObject address_kanji: explode: true style: deepObject dob: explode: true style: deepObject documents: explode: true style: deepObject expand: explode: true style: deepObject full_name_aliases: explode: true style: deepObject metadata: explode: true style: deepObject registered_address: explode: true style: deepObject relationship: explode: true style: deepObject verification: explode: true style: deepObject schema: additionalProperties: false properties: additional_tos_acceptances: description: >- Details on the legal guardian's acceptance of the required Stripe agreements. properties: account: properties: date: format: unix-time type: integer ip: type: string user_agent: anyOf: - maxLength: 5000 type: string - enum: - '' type: string title: settings_terms_of_service_specs type: object title: person_additional_tos_acceptances_specs type: object address: description: The person's address. properties: city: maxLength: 100 type: string country: maxLength: 5000 type: string line1: maxLength: 200 type: string line2: maxLength: 200 type: string postal_code: maxLength: 5000 type: string state: maxLength: 5000 type: string title: address_specs type: object address_kana: description: The Kana variation of the person's address (Japan only). properties: city: maxLength: 5000 type: string country: maxLength: 5000 type: string line1: maxLength: 5000 type: string line2: maxLength: 5000 type: string postal_code: maxLength: 5000 type: string state: maxLength: 5000 type: string town: maxLength: 5000 type: string title: japan_address_kana_specs type: object address_kanji: description: The Kanji variation of the person's address (Japan only). properties: city: maxLength: 5000 type: string country: maxLength: 5000 type: string line1: maxLength: 5000 type: string line2: maxLength: 5000 type: string postal_code: maxLength: 5000 type: string state: maxLength: 5000 type: string town: maxLength: 5000 type: string title: japan_address_kanji_specs type: object dob: anyOf: - properties: day: type: integer month: type: integer year: type: integer required: - day - month - year title: date_of_birth_specs type: object - enum: - '' type: string description: The person's date of birth. documents: description: >- Documents that may be submitted to satisfy various informational requests. properties: company_authorization: properties: files: items: anyOf: - maxLength: 500 type: string - enum: - '' type: string type: array title: documents_param type: object passport: properties: files: items: anyOf: - maxLength: 500 type: string - enum: - '' type: string type: array title: documents_param type: object visa: properties: files: items: anyOf: - maxLength: 500 type: string - enum: - '' type: string type: array title: documents_param type: object title: person_documents_specs type: object email: description: The person's email address. type: string expand: description: Specifies which fields in the response should be expanded. items: maxLength: 5000 type: string type: array first_name: description: The person's first name. maxLength: 5000 type: string first_name_kana: description: The Kana variation of the person's first name (Japan only). maxLength: 5000 type: string first_name_kanji: description: The Kanji variation of the person's first name (Japan only). maxLength: 5000 type: string full_name_aliases: anyOf: - items: maxLength: 5000 type: string type: array - enum: - '' type: string description: >- A list of alternate names or aliases that the person is known by. gender: description: >- The person's gender (International regulations require either "male" or "female"). type: string id_number: description: >- The person's ID number, as appropriate for their country. For example, a social security number in the U.S., social insurance number in Canada, etc. Instead of the number itself, you can also provide a [PII token provided by Stripe.js](https://docs.stripe.com/js/tokens/create_token?type=pii). maxLength: 5000 type: string id_number_secondary: description: >- The person's secondary ID number, as appropriate for their country, will be used for enhanced verification checks. In Thailand, this would be the laser code found on the back of an ID card. Instead of the number itself, you can also provide a [PII token provided by Stripe.js](https://docs.stripe.com/js/tokens/create_token?type=pii). maxLength: 5000 type: string last_name: description: The person's last name. maxLength: 5000 type: string last_name_kana: description: The Kana variation of the person's last name (Japan only). maxLength: 5000 type: string last_name_kanji: description: The Kanji variation of the person's last name (Japan only). maxLength: 5000 type: string maiden_name: description: The person's maiden name. maxLength: 5000 type: string metadata: anyOf: - additionalProperties: type: string type: object - enum: - '' type: string description: >- Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. nationality: description: >- The country where the person is a national. Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)), or "XX" if unavailable. maxLength: 5000 type: string person_token: description: >- A [person token](https://docs.stripe.com/connect/account-tokens), used to securely provide details to the person. maxLength: 5000 type: string phone: description: The person's phone number. type: string political_exposure: description: >- 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. maxLength: 5000 type: string registered_address: description: The person's registered address. properties: city: maxLength: 100 type: string country: maxLength: 5000 type: string line1: maxLength: 200 type: string line2: maxLength: 200 type: string postal_code: maxLength: 5000 type: string state: maxLength: 5000 type: string title: address_specs type: object relationship: description: >- The relationship that this person has with the account's legal entity. properties: director: type: boolean executive: type: boolean legal_guardian: type: boolean owner: type: boolean percent_ownership: anyOf: - type: number - enum: - '' type: string representative: type: boolean title: maxLength: 5000 type: string title: relationship_specs type: object ssn_last_4: description: >- The last four digits of the person's Social Security number (U.S. only). type: string verification: description: The person's verification status. properties: additional_document: properties: back: maxLength: 500 type: string front: maxLength: 500 type: string title: person_verification_document_specs type: object document: properties: back: maxLength: 500 type: string front: maxLength: 500 type: string title: person_verification_document_specs type: object title: person_verification_specs type: object type: object required: false responses: '200': content: application/json: schema: $ref: '#/components/schemas/person' description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. '/v1/accounts/{account}/persons/{person}': delete: description: >-

Deletes an existing person’s relationship to the account’s legal entity. Any person with a relationship for an account can be deleted through the API, except if the person is the account_opener. If your integration is using the executive parameter, you cannot delete the only verified executive on file.

operationId: DeleteAccountsAccountPersonsPerson parameters: - in: path name: account required: true schema: maxLength: 5000 type: string style: simple - in: path name: person required: true schema: maxLength: 5000 type: string style: simple requestBody: content: application/x-www-form-urlencoded: encoding: {} schema: additionalProperties: false properties: {} type: object required: false responses: '200': content: application/json: schema: $ref: '#/components/schemas/deleted_person' description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. get: description:

Retrieves an existing person.

operationId: GetAccountsAccountPersonsPerson parameters: - in: path name: account required: true schema: maxLength: 5000 type: string style: simple - description: Specifies which fields in the response should be expanded. explode: true in: query name: expand required: false schema: items: maxLength: 5000 type: string type: array style: deepObject - in: path name: person required: true schema: maxLength: 5000 type: string style: simple requestBody: content: application/x-www-form-urlencoded: encoding: {} schema: additionalProperties: false properties: {} type: object required: false responses: '200': content: application/json: schema: $ref: '#/components/schemas/person' description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. post: description:

Updates an existing person.

operationId: PostAccountsAccountPersonsPerson parameters: - in: path name: account required: true schema: maxLength: 5000 type: string style: simple - in: path name: person required: true schema: maxLength: 5000 type: string style: simple requestBody: content: application/x-www-form-urlencoded: encoding: additional_tos_acceptances: explode: true style: deepObject address: explode: true style: deepObject address_kana: explode: true style: deepObject address_kanji: explode: true style: deepObject dob: explode: true style: deepObject documents: explode: true style: deepObject expand: explode: true style: deepObject full_name_aliases: explode: true style: deepObject metadata: explode: true style: deepObject registered_address: explode: true style: deepObject relationship: explode: true style: deepObject verification: explode: true style: deepObject schema: additionalProperties: false properties: additional_tos_acceptances: description: >- Details on the legal guardian's acceptance of the required Stripe agreements. properties: account: properties: date: format: unix-time type: integer ip: type: string user_agent: anyOf: - maxLength: 5000 type: string - enum: - '' type: string title: settings_terms_of_service_specs type: object title: person_additional_tos_acceptances_specs type: object address: description: The person's address. properties: city: maxLength: 100 type: string country: maxLength: 5000 type: string line1: maxLength: 200 type: string line2: maxLength: 200 type: string postal_code: maxLength: 5000 type: string state: maxLength: 5000 type: string title: address_specs type: object address_kana: description: The Kana variation of the person's address (Japan only). properties: city: maxLength: 5000 type: string country: maxLength: 5000 type: string line1: maxLength: 5000 type: string line2: maxLength: 5000 type: string postal_code: maxLength: 5000 type: string state: maxLength: 5000 type: string town: maxLength: 5000 type: string title: japan_address_kana_specs type: object address_kanji: description: The Kanji variation of the person's address (Japan only). properties: city: maxLength: 5000 type: string country: maxLength: 5000 type: string line1: maxLength: 5000 type: string line2: maxLength: 5000 type: string postal_code: maxLength: 5000 type: string state: maxLength: 5000 type: string town: maxLength: 5000 type: string title: japan_address_kanji_specs type: object dob: anyOf: - properties: day: type: integer month: type: integer year: type: integer required: - day - month - year title: date_of_birth_specs type: object - enum: - '' type: string description: The person's date of birth. documents: description: >- Documents that may be submitted to satisfy various informational requests. properties: company_authorization: properties: files: items: anyOf: - maxLength: 500 type: string - enum: - '' type: string type: array title: documents_param type: object passport: properties: files: items: anyOf: - maxLength: 500 type: string - enum: - '' type: string type: array title: documents_param type: object visa: properties: files: items: anyOf: - maxLength: 500 type: string - enum: - '' type: string type: array title: documents_param type: object title: person_documents_specs type: object email: description: The person's email address. type: string expand: description: Specifies which fields in the response should be expanded. items: maxLength: 5000 type: string type: array first_name: description: The person's first name. maxLength: 5000 type: string first_name_kana: description: The Kana variation of the person's first name (Japan only). maxLength: 5000 type: string first_name_kanji: description: The Kanji variation of the person's first name (Japan only). maxLength: 5000 type: string full_name_aliases: anyOf: - items: maxLength: 5000 type: string type: array - enum: - '' type: string description: >- A list of alternate names or aliases that the person is known by. gender: description: >- The person's gender (International regulations require either "male" or "female"). type: string id_number: description: >- The person's ID number, as appropriate for their country. For example, a social security number in the U.S., social insurance number in Canada, etc. Instead of the number itself, you can also provide a [PII token provided by Stripe.js](https://docs.stripe.com/js/tokens/create_token?type=pii). maxLength: 5000 type: string id_number_secondary: description: >- The person's secondary ID number, as appropriate for their country, will be used for enhanced verification checks. In Thailand, this would be the laser code found on the back of an ID card. Instead of the number itself, you can also provide a [PII token provided by Stripe.js](https://docs.stripe.com/js/tokens/create_token?type=pii). maxLength: 5000 type: string last_name: description: The person's last name. maxLength: 5000 type: string last_name_kana: description: The Kana variation of the person's last name (Japan only). maxLength: 5000 type: string last_name_kanji: description: The Kanji variation of the person's last name (Japan only). maxLength: 5000 type: string maiden_name: description: The person's maiden name. maxLength: 5000 type: string metadata: anyOf: - additionalProperties: type: string type: object - enum: - '' type: string description: >- Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. nationality: description: >- The country where the person is a national. Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)), or "XX" if unavailable. maxLength: 5000 type: string person_token: description: >- A [person token](https://docs.stripe.com/connect/account-tokens), used to securely provide details to the person. maxLength: 5000 type: string phone: description: The person's phone number. type: string political_exposure: description: >- 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. maxLength: 5000 type: string registered_address: description: The person's registered address. properties: city: maxLength: 100 type: string country: maxLength: 5000 type: string line1: maxLength: 200 type: string line2: maxLength: 200 type: string postal_code: maxLength: 5000 type: string state: maxLength: 5000 type: string title: address_specs type: object relationship: description: >- The relationship that this person has with the account's legal entity. properties: director: type: boolean executive: type: boolean legal_guardian: type: boolean owner: type: boolean percent_ownership: anyOf: - type: number - enum: - '' type: string representative: type: boolean title: maxLength: 5000 type: string title: relationship_specs type: object ssn_last_4: description: >- The last four digits of the person's Social Security number (U.S. only). type: string verification: description: The person's verification status. properties: additional_document: properties: back: maxLength: 500 type: string front: maxLength: 500 type: string title: person_verification_document_specs type: object document: properties: back: maxLength: 500 type: string front: maxLength: 500 type: string title: person_verification_document_specs type: object title: person_verification_specs type: object type: object required: false responses: '200': content: application/json: schema: $ref: '#/components/schemas/person' description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. '/v1/accounts/{account}/reject': post: description: >-

With Connect, you may flag accounts as suspicious.

Test-mode Custom and Express accounts can be rejected at any time. Accounts created using live-mode keys may only be rejected once all balances are zero.

operationId: PostAccountsAccountReject parameters: - in: path name: account required: true schema: maxLength: 5000 type: string style: simple requestBody: content: application/x-www-form-urlencoded: encoding: expand: explode: true style: deepObject schema: additionalProperties: false properties: expand: description: Specifies which fields in the response should be expanded. items: maxLength: 5000 type: string type: array reason: description: >- The reason for rejecting the account. Can be `fraud`, `terms_of_service`, or `other`. maxLength: 5000 type: string required: - reason type: object required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/account' description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. /v1/apple_pay/domains: get: description:

List apple pay domains.

operationId: GetApplePayDomains parameters: - in: query name: domain_name required: false schema: maxLength: 5000 type: string style: form - description: >- A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. in: query name: ending_before required: false schema: maxLength: 5000 type: string style: form - description: Specifies which fields in the response should be expanded. explode: true in: query name: expand required: false schema: items: maxLength: 5000 type: string type: array style: deepObject - description: >- A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. in: query name: limit required: false schema: type: integer style: form - description: >- A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. in: query name: starting_after required: false schema: maxLength: 5000 type: string style: form requestBody: content: application/x-www-form-urlencoded: encoding: {} schema: additionalProperties: false properties: {} type: object required: false responses: '200': content: application/json: schema: description: '' properties: data: items: $ref: '#/components/schemas/apple_pay_domain' type: array has_more: description: >- True if this list has another page of items after this one that can be fetched. type: boolean object: description: >- String representing the object's type. Objects of the same type share the same value. Always has the value `list`. enum: - list type: string url: description: The URL where this list can be accessed. maxLength: 5000 pattern: ^/v1/apple_pay/domains type: string required: - data - has_more - object - url title: ApplePayDomainList type: object x-expandableFields: - data description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. post: description:

Create an apple pay domain.

operationId: PostApplePayDomains requestBody: content: application/x-www-form-urlencoded: encoding: expand: explode: true style: deepObject schema: additionalProperties: false properties: domain_name: type: string expand: description: Specifies which fields in the response should be expanded. items: maxLength: 5000 type: string type: array required: - domain_name type: object required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/apple_pay_domain' description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. '/v1/apple_pay/domains/{domain}': delete: description:

Delete an apple pay domain.

operationId: DeleteApplePayDomainsDomain parameters: - in: path name: domain required: true schema: maxLength: 5000 type: string style: simple requestBody: content: application/x-www-form-urlencoded: encoding: {} schema: additionalProperties: false properties: {} type: object required: false responses: '200': content: application/json: schema: $ref: '#/components/schemas/deleted_apple_pay_domain' description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. get: description:

Retrieve an apple pay domain.

operationId: GetApplePayDomainsDomain parameters: - in: path name: domain required: true schema: maxLength: 5000 type: string style: simple - description: Specifies which fields in the response should be expanded. explode: true in: query name: expand required: false schema: items: maxLength: 5000 type: string type: array style: deepObject requestBody: content: application/x-www-form-urlencoded: encoding: {} schema: additionalProperties: false properties: {} type: object required: false responses: '200': content: application/json: schema: $ref: '#/components/schemas/apple_pay_domain' description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. /v1/application_fees: get: description: >-

Returns a list of application fees you’ve previously collected. The application fees are returned in sorted order, with the most recent fees appearing first.

operationId: GetApplicationFees parameters: - description: >- Only return application fees for the charge specified by this charge ID. in: query name: charge required: false schema: maxLength: 5000 type: string style: form - description: >- Only return applications fees that were created during the given date interval. explode: true in: query name: created required: false schema: anyOf: - properties: gt: type: integer gte: type: integer lt: type: integer lte: type: integer title: range_query_specs type: object - type: integer style: deepObject - description: >- A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. in: query name: ending_before required: false schema: maxLength: 5000 type: string style: form - description: Specifies which fields in the response should be expanded. explode: true in: query name: expand required: false schema: items: maxLength: 5000 type: string type: array style: deepObject - description: >- A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. in: query name: limit required: false schema: type: integer style: form - description: >- A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. in: query name: starting_after required: false schema: maxLength: 5000 type: string style: form requestBody: content: application/x-www-form-urlencoded: encoding: {} schema: additionalProperties: false properties: {} type: object required: false responses: '200': content: application/json: schema: description: '' properties: data: items: $ref: '#/components/schemas/application_fee' type: array has_more: description: >- True if this list has another page of items after this one that can be fetched. type: boolean object: description: >- String representing the object's type. Objects of the same type share the same value. Always has the value `list`. enum: - list type: string url: description: The URL where this list can be accessed. maxLength: 5000 pattern: ^/v1/application_fees type: string required: - data - has_more - object - url title: PlatformEarningList type: object x-expandableFields: - data description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. '/v1/application_fees/{fee}/refunds/{id}': get: description: >-

By default, you can see the 10 most recent refunds stored directly on the application fee object, but you can also retrieve details about a specific refund stored on the application fee.

operationId: GetApplicationFeesFeeRefundsId parameters: - description: Specifies which fields in the response should be expanded. explode: true in: query name: expand required: false schema: items: maxLength: 5000 type: string type: array style: deepObject - in: path name: fee required: true schema: maxLength: 5000 type: string style: simple - in: path name: id required: true schema: maxLength: 5000 type: string style: simple requestBody: content: application/x-www-form-urlencoded: encoding: {} schema: additionalProperties: false properties: {} type: object required: false responses: '200': content: application/json: schema: $ref: '#/components/schemas/fee_refund' description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. post: description: >-

Updates the specified application fee refund by setting the values of the parameters passed. Any parameters not provided will be left unchanged.

This request only accepts metadata as an argument.

operationId: PostApplicationFeesFeeRefundsId parameters: - in: path name: fee required: true schema: maxLength: 5000 type: string style: simple - in: path name: id required: true schema: maxLength: 5000 type: string style: simple requestBody: content: application/x-www-form-urlencoded: encoding: expand: explode: true style: deepObject metadata: explode: true style: deepObject schema: additionalProperties: false properties: expand: description: Specifies which fields in the response should be expanded. items: maxLength: 5000 type: string type: array metadata: anyOf: - additionalProperties: type: string type: object - enum: - '' type: string description: >- Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. type: object required: false responses: '200': content: application/json: schema: $ref: '#/components/schemas/fee_refund' description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. '/v1/application_fees/{id}': get: description: >-

Retrieves the details of an application fee that your account has collected. The same information is returned when refunding the application fee.

operationId: GetApplicationFeesId parameters: - description: Specifies which fields in the response should be expanded. explode: true in: query name: expand required: false schema: items: maxLength: 5000 type: string type: array style: deepObject - in: path name: id required: true schema: maxLength: 5000 type: string style: simple requestBody: content: application/x-www-form-urlencoded: encoding: {} schema: additionalProperties: false properties: {} type: object required: false responses: '200': content: application/json: schema: $ref: '#/components/schemas/application_fee' description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. '/v1/application_fees/{id}/refund': post: description: '' operationId: PostApplicationFeesIdRefund parameters: - in: path name: id required: true schema: maxLength: 5000 type: string style: simple requestBody: content: application/x-www-form-urlencoded: encoding: expand: explode: true style: deepObject schema: additionalProperties: false properties: amount: type: integer directive: maxLength: 5000 type: string expand: description: Specifies which fields in the response should be expanded. items: maxLength: 5000 type: string type: array type: object required: false responses: '200': content: application/json: schema: $ref: '#/components/schemas/application_fee' description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. '/v1/application_fees/{id}/refunds': get: description: >-

You can see a list of the refunds belonging to a specific application fee. Note that the 10 most recent refunds are always available by default on the application fee object. If you need more than those 10, you can use this API method and the limit and starting_after parameters to page through additional refunds.

operationId: GetApplicationFeesIdRefunds parameters: - description: >- A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. in: query name: ending_before required: false schema: maxLength: 5000 type: string style: form - description: Specifies which fields in the response should be expanded. explode: true in: query name: expand required: false schema: items: maxLength: 5000 type: string type: array style: deepObject - in: path name: id required: true schema: maxLength: 5000 type: string style: simple - description: >- A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. in: query name: limit required: false schema: type: integer style: form - description: >- A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. in: query name: starting_after required: false schema: maxLength: 5000 type: string style: form requestBody: content: application/x-www-form-urlencoded: encoding: {} schema: additionalProperties: false properties: {} type: object required: false responses: '200': content: application/json: schema: description: '' properties: data: description: Details about each object. items: $ref: '#/components/schemas/fee_refund' type: array has_more: description: >- True if this list has another page of items after this one that can be fetched. type: boolean object: description: >- String representing the object's type. Objects of the same type share the same value. Always has the value `list`. enum: - list type: string url: description: The URL where this list can be accessed. maxLength: 5000 type: string required: - data - has_more - object - url title: FeeRefundList type: object x-expandableFields: - data description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. post: description: >-

Refunds an application fee that has previously been collected but not yet refunded. Funds will be refunded to the Stripe account from which the fee was originally collected.

You can optionally refund only part of an application fee. You can do so multiple times, until the entire fee has been refunded.

Once entirely refunded, an application fee can’t be refunded again. This method will raise an error when called on an already-refunded application fee, or when trying to refund more money than is left on an application fee.

operationId: PostApplicationFeesIdRefunds parameters: - in: path name: id required: true schema: maxLength: 5000 type: string style: simple requestBody: content: application/x-www-form-urlencoded: encoding: expand: explode: true style: deepObject metadata: explode: true style: deepObject schema: additionalProperties: false properties: amount: description: >- A positive integer, in _cents (or local equivalent)_, representing how much of this fee to refund. Can refund only up to the remaining unrefunded amount of the fee. type: integer expand: description: Specifies which fields in the response should be expanded. items: maxLength: 5000 type: string type: array metadata: additionalProperties: type: string description: >- Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. type: object type: object required: false responses: '200': content: application/json: schema: $ref: '#/components/schemas/fee_refund' description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. /v1/apps/secrets: get: description:

List all secrets stored on the given scope.

operationId: GetAppsSecrets parameters: - description: >- A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. in: query name: ending_before required: false schema: maxLength: 5000 type: string style: form - description: Specifies which fields in the response should be expanded. explode: true in: query name: expand required: false schema: items: maxLength: 5000 type: string type: array style: deepObject - description: >- A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. in: query name: limit required: false schema: type: integer style: form - description: >- Specifies the scoping of the secret. Requests originating from UI extensions can only access account-scoped secrets or secrets scoped to their own user. explode: true in: query name: scope required: true schema: properties: type: enum: - account - user type: string user: maxLength: 5000 type: string required: - type title: scope_param type: object style: deepObject - description: >- A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. in: query name: starting_after required: false schema: maxLength: 5000 type: string style: form requestBody: content: application/x-www-form-urlencoded: encoding: {} schema: additionalProperties: false properties: {} type: object required: false responses: '200': content: application/json: schema: description: '' properties: data: items: $ref: '#/components/schemas/apps.secret' type: array has_more: description: >- True if this list has another page of items after this one that can be fetched. type: boolean object: description: >- String representing the object's type. Objects of the same type share the same value. Always has the value `list`. enum: - list type: string url: description: The URL where this list can be accessed. maxLength: 5000 pattern: ^/v1/apps/secrets type: string required: - data - has_more - object - url title: SecretServiceResourceSecretList type: object x-expandableFields: - data description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. post: description:

Create or replace a secret in the secret store.

operationId: PostAppsSecrets requestBody: content: application/x-www-form-urlencoded: encoding: expand: explode: true style: deepObject scope: explode: true style: deepObject schema: additionalProperties: false properties: expand: description: Specifies which fields in the response should be expanded. items: maxLength: 5000 type: string type: array expires_at: description: >- The Unix timestamp for the expiry time of the secret, after which the secret deletes. format: unix-time type: integer name: description: A name for the secret that's unique within the scope. maxLength: 5000 type: string payload: description: The plaintext secret value to be stored. maxLength: 5000 type: string scope: description: >- Specifies the scoping of the secret. Requests originating from UI extensions can only access account-scoped secrets or secrets scoped to their own user. properties: type: enum: - account - user type: string user: maxLength: 5000 type: string required: - type title: scope_param type: object required: - name - payload - scope type: object required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/apps.secret' description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. /v1/apps/secrets/delete: post: description:

Deletes a secret from the secret store by name and scope.

operationId: PostAppsSecretsDelete requestBody: content: application/x-www-form-urlencoded: encoding: expand: explode: true style: deepObject scope: explode: true style: deepObject schema: additionalProperties: false properties: expand: description: Specifies which fields in the response should be expanded. items: maxLength: 5000 type: string type: array name: description: A name for the secret that's unique within the scope. maxLength: 5000 type: string scope: description: >- Specifies the scoping of the secret. Requests originating from UI extensions can only access account-scoped secrets or secrets scoped to their own user. properties: type: enum: - account - user type: string user: maxLength: 5000 type: string required: - type title: scope_param type: object required: - name - scope type: object required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/apps.secret' description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. /v1/apps/secrets/find: get: description:

Finds a secret in the secret store by name and scope.

operationId: GetAppsSecretsFind parameters: - description: Specifies which fields in the response should be expanded. explode: true in: query name: expand required: false schema: items: maxLength: 5000 type: string type: array style: deepObject - description: A name for the secret that's unique within the scope. in: query name: name required: true schema: maxLength: 5000 type: string style: form - description: >- Specifies the scoping of the secret. Requests originating from UI extensions can only access account-scoped secrets or secrets scoped to their own user. explode: true in: query name: scope required: true schema: properties: type: enum: - account - user type: string user: maxLength: 5000 type: string required: - type title: scope_param type: object style: deepObject requestBody: content: application/x-www-form-urlencoded: encoding: {} schema: additionalProperties: false properties: {} type: object required: false responses: '200': content: application/json: schema: $ref: '#/components/schemas/apps.secret' description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. /v1/balance: get: description: >-

Retrieves the current account balance, based on the authentication that was used to make the request. For a sample request, see Accounting for negative balances.

operationId: GetBalance parameters: - description: Specifies which fields in the response should be expanded. explode: true in: query name: expand required: false schema: items: maxLength: 5000 type: string type: array style: deepObject requestBody: content: application/x-www-form-urlencoded: encoding: {} schema: additionalProperties: false properties: {} type: object required: false responses: '200': content: application/json: schema: $ref: '#/components/schemas/balance' description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. /v1/balance/history: get: description: >-

Returns a list of transactions that have contributed to the Stripe account balance (e.g., charges, transfers, and so forth). The transactions are returned in sorted order, with the most recent transactions appearing first.

Note that this endpoint was previously called “Balance history” and used the path /v1/balance/history.

operationId: GetBalanceHistory parameters: - description: >- Only return transactions that were created during the given date interval. explode: true in: query name: created required: false schema: anyOf: - properties: gt: type: integer gte: type: integer lt: type: integer lte: type: integer title: range_query_specs type: object - type: integer style: deepObject - description: >- Only return transactions in a certain currency. Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). in: query name: currency required: false schema: type: string style: form - description: >- A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. in: query name: ending_before required: false schema: maxLength: 5000 type: string style: form - description: Specifies which fields in the response should be expanded. explode: true in: query name: expand required: false schema: items: maxLength: 5000 type: string type: array style: deepObject - description: >- A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. in: query name: limit required: false schema: type: integer style: form - description: >- For automatic Stripe payouts only, only returns transactions that were paid out on the specified payout ID. in: query name: payout required: false schema: maxLength: 5000 type: string style: form - description: Only returns the original transaction. in: query name: source required: false schema: maxLength: 5000 type: string style: form - description: >- A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. in: query name: starting_after required: false schema: maxLength: 5000 type: string style: form - description: >- Only returns transactions of the given type. One of: `adjustment`, `advance`, `advance_funding`, `anticipation_repayment`, `application_fee`, `application_fee_refund`, `charge`, `climate_order_purchase`, `climate_order_refund`, `connect_collection_transfer`, `contribution`, `issuing_authorization_hold`, `issuing_authorization_release`, `issuing_dispute`, `issuing_transaction`, `obligation_outbound`, `obligation_reversal_inbound`, `payment`, `payment_failure_refund`, `payment_network_reserve_hold`, `payment_network_reserve_release`, `payment_refund`, `payment_reversal`, `payment_unreconciled`, `payout`, `payout_cancel`, `payout_failure`, `refund`, `refund_failure`, `reserve_transaction`, `reserved_funds`, `stripe_fee`, `stripe_fx_fee`, `tax_fee`, `topup`, `topup_reversal`, `transfer`, `transfer_cancel`, `transfer_failure`, or `transfer_refund`. in: query name: type required: false schema: maxLength: 5000 type: string style: form requestBody: content: application/x-www-form-urlencoded: encoding: {} schema: additionalProperties: false properties: {} type: object required: false responses: '200': content: application/json: schema: description: '' properties: data: items: $ref: '#/components/schemas/balance_transaction' type: array has_more: description: >- True if this list has another page of items after this one that can be fetched. type: boolean object: description: >- String representing the object's type. Objects of the same type share the same value. Always has the value `list`. enum: - list type: string url: description: The URL where this list can be accessed. maxLength: 5000 pattern: ^/v1/balance_transactions type: string required: - data - has_more - object - url title: BalanceTransactionsList type: object x-expandableFields: - data description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. '/v1/balance/history/{id}': get: description: >-

Retrieves the balance transaction with the given ID.

Note that this endpoint previously used the path /v1/balance/history/:id.

operationId: GetBalanceHistoryId parameters: - description: Specifies which fields in the response should be expanded. explode: true in: query name: expand required: false schema: items: maxLength: 5000 type: string type: array style: deepObject - in: path name: id required: true schema: maxLength: 5000 type: string style: simple requestBody: content: application/x-www-form-urlencoded: encoding: {} schema: additionalProperties: false properties: {} type: object required: false responses: '200': content: application/json: schema: $ref: '#/components/schemas/balance_transaction' description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. /v1/balance_transactions: get: description: >-

Returns a list of transactions that have contributed to the Stripe account balance (e.g., charges, transfers, and so forth). The transactions are returned in sorted order, with the most recent transactions appearing first.

Note that this endpoint was previously called “Balance history” and used the path /v1/balance/history.

operationId: GetBalanceTransactions parameters: - description: >- Only return transactions that were created during the given date interval. explode: true in: query name: created required: false schema: anyOf: - properties: gt: type: integer gte: type: integer lt: type: integer lte: type: integer title: range_query_specs type: object - type: integer style: deepObject - description: >- Only return transactions in a certain currency. Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). in: query name: currency required: false schema: type: string style: form - description: >- A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. in: query name: ending_before required: false schema: maxLength: 5000 type: string style: form - description: Specifies which fields in the response should be expanded. explode: true in: query name: expand required: false schema: items: maxLength: 5000 type: string type: array style: deepObject - description: >- A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. in: query name: limit required: false schema: type: integer style: form - description: >- For automatic Stripe payouts only, only returns transactions that were paid out on the specified payout ID. in: query name: payout required: false schema: maxLength: 5000 type: string style: form - description: Only returns the original transaction. in: query name: source required: false schema: maxLength: 5000 type: string style: form - description: >- A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. in: query name: starting_after required: false schema: maxLength: 5000 type: string style: form - description: >- Only returns transactions of the given type. One of: `adjustment`, `advance`, `advance_funding`, `anticipation_repayment`, `application_fee`, `application_fee_refund`, `charge`, `climate_order_purchase`, `climate_order_refund`, `connect_collection_transfer`, `contribution`, `issuing_authorization_hold`, `issuing_authorization_release`, `issuing_dispute`, `issuing_transaction`, `obligation_outbound`, `obligation_reversal_inbound`, `payment`, `payment_failure_refund`, `payment_network_reserve_hold`, `payment_network_reserve_release`, `payment_refund`, `payment_reversal`, `payment_unreconciled`, `payout`, `payout_cancel`, `payout_failure`, `refund`, `refund_failure`, `reserve_transaction`, `reserved_funds`, `stripe_fee`, `stripe_fx_fee`, `tax_fee`, `topup`, `topup_reversal`, `transfer`, `transfer_cancel`, `transfer_failure`, or `transfer_refund`. in: query name: type required: false schema: maxLength: 5000 type: string style: form requestBody: content: application/x-www-form-urlencoded: encoding: {} schema: additionalProperties: false properties: {} type: object required: false responses: '200': content: application/json: schema: description: '' properties: data: items: $ref: '#/components/schemas/balance_transaction' type: array has_more: description: >- True if this list has another page of items after this one that can be fetched. type: boolean object: description: >- String representing the object's type. Objects of the same type share the same value. Always has the value `list`. enum: - list type: string url: description: The URL where this list can be accessed. maxLength: 5000 pattern: ^/v1/balance_transactions type: string required: - data - has_more - object - url title: BalanceTransactionsList type: object x-expandableFields: - data description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. '/v1/balance_transactions/{id}': get: description: >-

Retrieves the balance transaction with the given ID.

Note that this endpoint previously used the path /v1/balance/history/:id.

operationId: GetBalanceTransactionsId parameters: - description: Specifies which fields in the response should be expanded. explode: true in: query name: expand required: false schema: items: maxLength: 5000 type: string type: array style: deepObject - in: path name: id required: true schema: maxLength: 5000 type: string style: simple requestBody: content: application/x-www-form-urlencoded: encoding: {} schema: additionalProperties: false properties: {} type: object required: false responses: '200': content: application/json: schema: $ref: '#/components/schemas/balance_transaction' description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. /v1/billing/meter_event_adjustments: post: description:

Creates a billing meter event adjustment

operationId: PostBillingMeterEventAdjustments requestBody: content: application/x-www-form-urlencoded: encoding: cancel: explode: true style: deepObject expand: explode: true style: deepObject schema: additionalProperties: false properties: cancel: description: Specifies which event to cancel. properties: identifier: maxLength: 100 type: string title: event_adjustment_cancel_settings_param type: object event_name: description: >- The name of the meter event. Corresponds with the `event_name` field on a meter. maxLength: 100 type: string expand: description: Specifies which fields in the response should be expanded. items: maxLength: 5000 type: string type: array type: description: >- Specifies whether to cancel a single event or a range of events for a time period. Time period cancellation is not supported yet. enum: - cancel type: string required: - event_name - type type: object required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/billing.meter_event_adjustment' description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. /v1/billing/meter_events: post: description:

Creates a billing meter event

operationId: PostBillingMeterEvents requestBody: content: application/x-www-form-urlencoded: encoding: expand: explode: true style: deepObject payload: explode: true style: deepObject schema: additionalProperties: false properties: event_name: description: >- The name of the meter event. Corresponds with the `event_name` field on a meter. maxLength: 100 type: string expand: description: Specifies which fields in the response should be expanded. items: maxLength: 5000 type: string type: array identifier: description: >- A unique identifier for the event. If not provided, one will be generated. We recommend using a globally unique identifier for this. We'll enforce uniqueness within a rolling 24 hour period. maxLength: 100 type: string payload: additionalProperties: type: string description: >- The payload of the event. This must contain the fields corresponding to a meter's `customer_mapping.event_payload_key` (default is `stripe_customer_id`) and `value_settings.event_payload_key` (default is `value`). Read more about the [payload](https://docs.stripe.com/billing/subscriptions/usage-based/recording-usage#payload-key-overrides). type: object timestamp: description: >- The time of the event. Measured in seconds since the Unix epoch. Must be within the past 35 calendar days or up to 5 minutes in the future. Defaults to current timestamp if not specified. format: unix-time type: integer required: - event_name - payload type: object required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/billing.meter_event' description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. /v1/billing/meters: get: description:

Retrieve a list of billing meters.

operationId: GetBillingMeters parameters: - description: >- A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. in: query name: ending_before required: false schema: maxLength: 5000 type: string style: form - description: Specifies which fields in the response should be expanded. explode: true in: query name: expand required: false schema: items: maxLength: 5000 type: string type: array style: deepObject - description: >- A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. in: query name: limit required: false schema: type: integer style: form - description: >- A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. in: query name: starting_after required: false schema: maxLength: 5000 type: string style: form - description: Filter results to only include meters with the given status. in: query name: status required: false schema: enum: - active - inactive type: string style: form requestBody: content: application/x-www-form-urlencoded: encoding: {} schema: additionalProperties: false properties: {} type: object required: false responses: '200': content: application/json: schema: description: '' properties: data: items: $ref: '#/components/schemas/billing.meter' type: array has_more: description: >- True if this list has another page of items after this one that can be fetched. type: boolean object: description: >- String representing the object's type. Objects of the same type share the same value. Always has the value `list`. enum: - list type: string url: description: The URL where this list can be accessed. maxLength: 5000 pattern: ^/v1/billing/meters type: string required: - data - has_more - object - url title: BillingMeterResourceBillingMeterList type: object x-expandableFields: - data description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. post: description:

Creates a billing meter

operationId: PostBillingMeters requestBody: content: application/x-www-form-urlencoded: encoding: customer_mapping: explode: true style: deepObject default_aggregation: explode: true style: deepObject expand: explode: true style: deepObject value_settings: explode: true style: deepObject schema: additionalProperties: false properties: customer_mapping: description: Fields that specify how to map a meter event to a customer. properties: event_payload_key: maxLength: 100 type: string type: enum: - by_id type: string required: - event_payload_key - type title: customer_mapping_param type: object default_aggregation: description: The default settings to aggregate a meter's events with. properties: formula: enum: - count - sum type: string required: - formula title: aggregation_settings_param type: object display_name: description: The meter's name. maxLength: 250 type: string event_name: description: >- The name of the meter event to record usage for. Corresponds with the `event_name` field on meter events. maxLength: 100 type: string event_time_window: description: 'The time window to pre-aggregate meter events for, if any.' enum: - day - hour type: string expand: description: Specifies which fields in the response should be expanded. items: maxLength: 5000 type: string type: array value_settings: description: Fields that specify how to calculate a meter event's value. properties: event_payload_key: maxLength: 100 type: string required: - event_payload_key title: meter_value_settings_param type: object required: - default_aggregation - display_name - event_name type: object required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/billing.meter' description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. '/v1/billing/meters/{id}': get: description:

Retrieves a billing meter given an ID

operationId: GetBillingMetersId parameters: - description: Specifies which fields in the response should be expanded. explode: true in: query name: expand required: false schema: items: maxLength: 5000 type: string type: array style: deepObject - description: Unique identifier for the object. in: path name: id required: true schema: maxLength: 5000 type: string style: simple requestBody: content: application/x-www-form-urlencoded: encoding: {} schema: additionalProperties: false properties: {} type: object required: false responses: '200': content: application/json: schema: $ref: '#/components/schemas/billing.meter' description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. post: description:

Updates a billing meter

operationId: PostBillingMetersId parameters: - description: Unique identifier for the object. in: path name: id required: true schema: maxLength: 5000 type: string style: simple requestBody: content: application/x-www-form-urlencoded: encoding: expand: explode: true style: deepObject schema: additionalProperties: false properties: display_name: description: The meter's name. maxLength: 250 type: string expand: description: Specifies which fields in the response should be expanded. items: maxLength: 5000 type: string type: array type: object required: false responses: '200': content: application/json: schema: $ref: '#/components/schemas/billing.meter' description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. '/v1/billing/meters/{id}/deactivate': post: description:

Deactivates a billing meter

operationId: PostBillingMetersIdDeactivate parameters: - description: Unique identifier for the object. in: path name: id required: true schema: maxLength: 5000 type: string style: simple requestBody: content: application/x-www-form-urlencoded: encoding: expand: explode: true style: deepObject schema: additionalProperties: false properties: expand: description: Specifies which fields in the response should be expanded. items: maxLength: 5000 type: string type: array type: object required: false responses: '200': content: application/json: schema: $ref: '#/components/schemas/billing.meter' description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. '/v1/billing/meters/{id}/event_summaries': get: description:

Retrieve a list of billing meter event summaries.

operationId: GetBillingMetersIdEventSummaries parameters: - description: The customer for which to fetch event summaries. in: query name: customer required: true schema: maxLength: 5000 type: string style: form - description: >- The timestamp from when to stop aggregating meter events (exclusive). in: query name: end_time required: true schema: format: unix-time type: integer style: form - description: >- A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. in: query name: ending_before required: false schema: maxLength: 5000 type: string style: form - description: Specifies which fields in the response should be expanded. explode: true in: query name: expand required: false schema: items: maxLength: 5000 type: string type: array style: deepObject - description: Unique identifier for the object. in: path name: id required: true schema: maxLength: 5000 type: string style: simple - description: >- A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. in: query name: limit required: false schema: type: integer style: form - description: >- The timestamp from when to start aggregating meter events (inclusive). in: query name: start_time required: true schema: format: unix-time type: integer style: form - description: >- A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. in: query name: starting_after required: false schema: maxLength: 5000 type: string style: form - description: >- Specifies what granularity to use when generating event summaries. If not specified, a single event summary would be returned for the specified time range. in: query name: value_grouping_window required: false schema: enum: - hour type: string style: form requestBody: content: application/x-www-form-urlencoded: encoding: {} schema: additionalProperties: false properties: {} type: object required: false responses: '200': content: application/json: schema: description: '' properties: data: items: $ref: '#/components/schemas/billing.meter_event_summary' type: array has_more: description: >- True if this list has another page of items after this one that can be fetched. type: boolean object: description: >- String representing the object's type. Objects of the same type share the same value. Always has the value `list`. enum: - list type: string url: description: The URL where this list can be accessed. maxLength: 5000 pattern: '^/v1/billing/meters/[^/]+/event_summaries' type: string required: - data - has_more - object - url title: BillingMeterResourceBillingMeterEventSummaryList type: object x-expandableFields: - data description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. '/v1/billing/meters/{id}/reactivate': post: description:

Reactivates a billing meter

operationId: PostBillingMetersIdReactivate parameters: - description: Unique identifier for the object. in: path name: id required: true schema: maxLength: 5000 type: string style: simple requestBody: content: application/x-www-form-urlencoded: encoding: expand: explode: true style: deepObject schema: additionalProperties: false properties: expand: description: Specifies which fields in the response should be expanded. items: maxLength: 5000 type: string type: array type: object required: false responses: '200': content: application/json: schema: $ref: '#/components/schemas/billing.meter' description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. /v1/billing_portal/configurations: get: description: >-

Returns a list of configurations that describe the functionality of the customer portal.

operationId: GetBillingPortalConfigurations parameters: - description: >- Only return configurations that are active or inactive (e.g., pass `true` to only list active configurations). in: query name: active required: false schema: type: boolean style: form - description: >- A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. in: query name: ending_before required: false schema: maxLength: 5000 type: string style: form - description: Specifies which fields in the response should be expanded. explode: true in: query name: expand required: false schema: items: maxLength: 5000 type: string type: array style: deepObject - description: >- Only return the default or non-default configurations (e.g., pass `true` to only list the default configuration). in: query name: is_default required: false schema: type: boolean style: form - description: >- A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. in: query name: limit required: false schema: type: integer style: form - description: >- A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. in: query name: starting_after required: false schema: maxLength: 5000 type: string style: form requestBody: content: application/x-www-form-urlencoded: encoding: {} schema: additionalProperties: false properties: {} type: object required: false responses: '200': content: application/json: schema: description: '' properties: data: items: $ref: '#/components/schemas/billing_portal.configuration' type: array has_more: description: >- True if this list has another page of items after this one that can be fetched. type: boolean object: description: >- String representing the object's type. Objects of the same type share the same value. Always has the value `list`. enum: - list type: string url: description: The URL where this list can be accessed. maxLength: 5000 pattern: ^/v1/billing_portal/configurations type: string required: - data - has_more - object - url title: PortalPublicResourceConfigurationList type: object x-expandableFields: - data description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. post: description: >-

Creates a configuration that describes the functionality and behavior of a PortalSession

operationId: PostBillingPortalConfigurations requestBody: content: application/x-www-form-urlencoded: encoding: business_profile: explode: true style: deepObject default_return_url: explode: true style: deepObject expand: explode: true style: deepObject features: explode: true style: deepObject login_page: explode: true style: deepObject metadata: explode: true style: deepObject schema: additionalProperties: false properties: business_profile: description: The business information shown to customers in the portal. properties: headline: anyOf: - maxLength: 60 type: string - enum: - '' type: string privacy_policy_url: type: string terms_of_service_url: type: string title: business_profile_create_param type: object default_return_url: anyOf: - type: string - enum: - '' type: string description: >- The default URL to redirect customers to when they click on the portal's link to return to your website. This can be [overriden](https://stripe.com/docs/api/customer_portal/sessions/create#create_portal_session-return_url) when creating the session. expand: description: Specifies which fields in the response should be expanded. items: maxLength: 5000 type: string type: array features: description: Information about the features available in the portal. properties: customer_update: properties: allowed_updates: anyOf: - items: enum: - address - email - name - phone - shipping - tax_id type: string type: array - enum: - '' type: string enabled: type: boolean required: - enabled title: customer_update_creation_param type: object invoice_history: properties: enabled: type: boolean required: - enabled title: invoice_list_param type: object payment_method_update: properties: enabled: type: boolean required: - enabled title: payment_method_update_param type: object subscription_cancel: properties: cancellation_reason: properties: enabled: type: boolean options: anyOf: - items: enum: - customer_service - low_quality - missing_features - other - switched_service - too_complex - too_expensive - unused type: string type: array - enum: - '' type: string required: - enabled - options title: subscription_cancellation_reason_creation_param type: object enabled: type: boolean mode: enum: - at_period_end - immediately type: string proration_behavior: enum: - always_invoice - create_prorations - none type: string required: - enabled title: subscription_cancel_creation_param type: object subscription_update: properties: default_allowed_updates: anyOf: - items: enum: - price - promotion_code - quantity type: string type: array - enum: - '' type: string enabled: type: boolean products: anyOf: - items: properties: prices: items: maxLength: 5000 type: string type: array product: maxLength: 5000 type: string required: - prices - product title: subscription_update_product_param type: object type: array - enum: - '' type: string proration_behavior: enum: - always_invoice - create_prorations - none type: string required: - default_allowed_updates - enabled - products title: subscription_update_creation_param type: object title: features_creation_param type: object login_page: description: >- The hosted login page for this configuration. Learn more about the portal login page in our [integration docs](https://stripe.com/docs/billing/subscriptions/integrating-customer-portal#share). properties: enabled: type: boolean required: - enabled title: login_page_create_param type: object metadata: additionalProperties: type: string description: >- Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. type: object required: - business_profile - features type: object required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/billing_portal.configuration' description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. '/v1/billing_portal/configurations/{configuration}': get: description: >-

Retrieves a configuration that describes the functionality of the customer portal.

operationId: GetBillingPortalConfigurationsConfiguration parameters: - in: path name: configuration required: true schema: maxLength: 5000 type: string style: simple - description: Specifies which fields in the response should be expanded. explode: true in: query name: expand required: false schema: items: maxLength: 5000 type: string type: array style: deepObject requestBody: content: application/x-www-form-urlencoded: encoding: {} schema: additionalProperties: false properties: {} type: object required: false responses: '200': content: application/json: schema: $ref: '#/components/schemas/billing_portal.configuration' description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. post: description: >-

Updates a configuration that describes the functionality of the customer portal.

operationId: PostBillingPortalConfigurationsConfiguration parameters: - in: path name: configuration required: true schema: maxLength: 5000 type: string style: simple requestBody: content: application/x-www-form-urlencoded: encoding: business_profile: explode: true style: deepObject default_return_url: explode: true style: deepObject expand: explode: true style: deepObject features: explode: true style: deepObject login_page: explode: true style: deepObject metadata: explode: true style: deepObject schema: additionalProperties: false properties: active: description: >- Whether the configuration is active and can be used to create portal sessions. type: boolean business_profile: description: The business information shown to customers in the portal. properties: headline: anyOf: - maxLength: 60 type: string - enum: - '' type: string privacy_policy_url: anyOf: - type: string - enum: - '' type: string terms_of_service_url: anyOf: - type: string - enum: - '' type: string title: business_profile_update_param type: object default_return_url: anyOf: - type: string - enum: - '' type: string description: >- The default URL to redirect customers to when they click on the portal's link to return to your website. This can be [overriden](https://stripe.com/docs/api/customer_portal/sessions/create#create_portal_session-return_url) when creating the session. expand: description: Specifies which fields in the response should be expanded. items: maxLength: 5000 type: string type: array features: description: Information about the features available in the portal. properties: customer_update: properties: allowed_updates: anyOf: - items: enum: - address - email - name - phone - shipping - tax_id type: string type: array - enum: - '' type: string enabled: type: boolean title: customer_update_updating_param type: object invoice_history: properties: enabled: type: boolean required: - enabled title: invoice_list_param type: object payment_method_update: properties: enabled: type: boolean required: - enabled title: payment_method_update_param type: object subscription_cancel: properties: cancellation_reason: properties: enabled: type: boolean options: anyOf: - items: enum: - customer_service - low_quality - missing_features - other - switched_service - too_complex - too_expensive - unused type: string type: array - enum: - '' type: string required: - enabled title: subscription_cancellation_reason_updating_param type: object enabled: type: boolean mode: enum: - at_period_end - immediately type: string proration_behavior: enum: - always_invoice - create_prorations - none type: string title: subscription_cancel_updating_param type: object subscription_update: properties: default_allowed_updates: anyOf: - items: enum: - price - promotion_code - quantity type: string type: array - enum: - '' type: string enabled: type: boolean products: anyOf: - items: properties: prices: items: maxLength: 5000 type: string type: array product: maxLength: 5000 type: string required: - prices - product title: subscription_update_product_param type: object type: array - enum: - '' type: string proration_behavior: enum: - always_invoice - create_prorations - none type: string title: subscription_update_updating_param type: object title: features_updating_param type: object login_page: description: >- The hosted login page for this configuration. Learn more about the portal login page in our [integration docs](https://stripe.com/docs/billing/subscriptions/integrating-customer-portal#share). properties: enabled: type: boolean required: - enabled title: login_page_update_param type: object metadata: anyOf: - additionalProperties: type: string type: object - enum: - '' type: string description: >- Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. type: object required: false responses: '200': content: application/json: schema: $ref: '#/components/schemas/billing_portal.configuration' description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. /v1/billing_portal/sessions: post: description:

Creates a session of the customer portal.

operationId: PostBillingPortalSessions requestBody: content: application/x-www-form-urlencoded: encoding: expand: explode: true style: deepObject flow_data: explode: true style: deepObject schema: additionalProperties: false properties: configuration: description: >- The ID of an existing [configuration](https://stripe.com/docs/api/customer_portal/configuration) to use for this session, describing its functionality and features. If not specified, the session uses the default configuration. maxLength: 5000 type: string customer: description: The ID of an existing customer. maxLength: 5000 type: string expand: description: Specifies which fields in the response should be expanded. items: maxLength: 5000 type: string type: array flow_data: description: >- Information about a specific flow for the customer to go through. See the [docs](https://stripe.com/docs/customer-management/portal-deep-links) to learn more about using customer portal deep links and flows. properties: after_completion: properties: hosted_confirmation: properties: custom_message: maxLength: 500 type: string title: after_completion_hosted_confirmation_param type: object redirect: properties: return_url: type: string required: - return_url title: after_completion_redirect_param type: object type: enum: - hosted_confirmation - portal_homepage - redirect type: string required: - type title: flow_data_after_completion_param type: object subscription_cancel: properties: retention: properties: coupon_offer: properties: coupon: maxLength: 5000 type: string required: - coupon title: coupon_offer_param type: object type: enum: - coupon_offer type: string required: - coupon_offer - type title: retention_param type: object subscription: maxLength: 5000 type: string required: - subscription title: flow_data_subscription_cancel_param type: object subscription_update: properties: subscription: maxLength: 5000 type: string required: - subscription title: flow_data_subscription_update_param type: object subscription_update_confirm: properties: discounts: items: properties: coupon: maxLength: 5000 type: string promotion_code: maxLength: 5000 type: string title: subscription_update_confirm_discount_params type: object type: array items: items: properties: id: maxLength: 5000 type: string price: maxLength: 5000 type: string quantity: type: integer required: - id title: subscription_update_confirm_item_params type: object type: array subscription: maxLength: 5000 type: string required: - items - subscription title: flow_data_subscription_update_confirm_param type: object type: enum: - payment_method_update - subscription_cancel - subscription_update - subscription_update_confirm type: string required: - type title: flow_data_param type: object locale: description: >- The IETF language tag of the locale customer portal is displayed in. If blank or auto, the customer’s `preferred_locales` or browser’s locale is used. enum: - auto - bg - cs - da - de - el - en - en-AU - en-CA - en-GB - en-IE - en-IN - en-NZ - en-SG - es - es-419 - et - fi - fil - fr - fr-CA - hr - hu - id - it - ja - ko - lt - lv - ms - mt - nb - nl - pl - pt - pt-BR - ro - ru - sk - sl - sv - th - tr - vi - zh - zh-HK - zh-TW type: string on_behalf_of: description: >- The `on_behalf_of` account to use for this session. When specified, only subscriptions and invoices with this `on_behalf_of` account appear in the portal. For more information, see the [docs](https://stripe.com/docs/connect/separate-charges-and-transfers#settlement-merchant). Use the [Accounts API](https://stripe.com/docs/api/accounts/object#account_object-settings-branding) to modify the `on_behalf_of` account's branding settings, which the portal displays. type: string return_url: description: >- The default URL to redirect customers to when they click on the portal's link to return to your website. type: string required: - customer type: object required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/billing_portal.session' description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. /v1/charges: get: description: >-

Returns a list of charges you’ve previously created. The charges are returned in sorted order, with the most recent charges appearing first.

operationId: GetCharges parameters: - description: >- Only return charges that were created during the given date interval. explode: true in: query name: created required: false schema: anyOf: - properties: gt: type: integer gte: type: integer lt: type: integer lte: type: integer title: range_query_specs type: object - type: integer style: deepObject - description: Only return charges for the customer specified by this customer ID. in: query name: customer required: false schema: maxLength: 5000 type: string style: form - description: >- A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. in: query name: ending_before required: false schema: type: string style: form - description: Specifies which fields in the response should be expanded. explode: true in: query name: expand required: false schema: items: maxLength: 5000 type: string type: array style: deepObject - description: >- A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. in: query name: limit required: false schema: type: integer style: form - description: >- Only return charges that were created by the PaymentIntent specified by this PaymentIntent ID. in: query name: payment_intent required: false schema: maxLength: 5000 type: string style: form - description: >- A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. in: query name: starting_after required: false schema: type: string style: form - description: Only return charges for this transfer group. in: query name: transfer_group required: false schema: maxLength: 5000 type: string style: form requestBody: content: application/x-www-form-urlencoded: encoding: {} schema: additionalProperties: false properties: {} type: object required: false responses: '200': content: application/json: schema: description: '' properties: data: items: $ref: '#/components/schemas/charge' type: array has_more: description: >- True if this list has another page of items after this one that can be fetched. type: boolean object: description: >- String representing the object's type. Objects of the same type share the same value. Always has the value `list`. enum: - list type: string url: description: The URL where this list can be accessed. maxLength: 5000 pattern: ^/v1/charges type: string required: - data - has_more - object - url title: ChargeList type: object x-expandableFields: - data description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. post: description: >-

This method is no longer recommended—use the Payment Intents API to initiate a new payment instead. Confirmation of the PaymentIntent creates the Charge object used to request payment.

operationId: PostCharges requestBody: content: application/x-www-form-urlencoded: encoding: card: explode: true style: deepObject destination: explode: true style: deepObject expand: explode: true style: deepObject metadata: explode: true style: deepObject radar_options: explode: true style: deepObject shipping: explode: true style: deepObject transfer_data: explode: true style: deepObject schema: additionalProperties: false properties: amount: description: >- 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). type: integer application_fee: type: integer application_fee_amount: description: >- A fee in cents (or local equivalent) that will be applied to the charge and transferred to the application owner's Stripe account. The request must be made with an OAuth key or the `Stripe-Account` header in order to take an application fee. For more information, see the application fees [documentation](https://stripe.com/docs/connect/direct-charges#collect-fees). type: integer capture: description: >- Whether to immediately capture the charge. Defaults to `true`. When `false`, the charge issues an authorization (or pre-authorization), and will need to be [captured](https://stripe.com/docs/api#capture_charge) later. Uncaptured charges expire after a set number of days (7 by default). For more information, see the [authorizing charges and settling later](https://stripe.com/docs/charges/placing-a-hold) documentation. type: boolean card: anyOf: - properties: address_city: maxLength: 5000 type: string address_country: maxLength: 5000 type: string address_line1: maxLength: 5000 type: string address_line2: maxLength: 5000 type: string address_state: maxLength: 5000 type: string address_zip: maxLength: 5000 type: string cvc: maxLength: 5000 type: string exp_month: type: integer exp_year: type: integer metadata: additionalProperties: type: string type: object name: maxLength: 5000 type: string number: maxLength: 5000 type: string object: enum: - card maxLength: 5000 type: string required: - exp_month - exp_year - number title: customer_payment_source_card type: object - maxLength: 5000 type: string description: >- A token, like the ones returned by [Stripe.js](https://stripe.com/docs/js). x-stripeBypassValidation: true currency: description: >- 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). type: string customer: description: >- The ID of an existing customer that will be charged in this request. maxLength: 500 type: string description: description: >- An arbitrary string which you can attach to a `Charge` object. It is displayed when in the web interface alongside the charge. Note that if you use Stripe to send automatic email receipts to your customers, your receipt emails will include the `description` of the charge(s) that they are describing. maxLength: 40000 type: string destination: anyOf: - properties: account: maxLength: 5000 type: string amount: type: integer required: - account title: destination_specs type: object - type: string expand: description: Specifies which fields in the response should be expanded. items: maxLength: 5000 type: string type: array metadata: anyOf: - additionalProperties: type: string type: object - enum: - '' type: string description: >- Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. on_behalf_of: description: >- The Stripe account ID for which these funds are intended. Automatically set if you use the `destination` parameter. For details, see [Creating Separate Charges and Transfers](https://stripe.com/docs/connect/separate-charges-and-transfers#settlement-merchant). maxLength: 5000 type: string radar_options: description: >- Options to configure Radar. See [Radar Session](https://stripe.com/docs/radar/radar-session) for more information. properties: session: maxLength: 5000 type: string title: radar_options_with_hidden_options type: object receipt_email: description: >- The email address to which this charge's [receipt](https://stripe.com/docs/dashboard/receipts) will be sent. The receipt will not be sent until the charge is paid, and no receipts will be sent for test mode charges. If this charge is for a [Customer](https://stripe.com/docs/api/customers/object), the email address specified here will override the customer's email address. If `receipt_email` is specified for a charge in live mode, a receipt will be sent regardless of your [email settings](https://dashboard.stripe.com/account/emails). type: string shipping: description: >- Shipping information for the charge. Helps prevent fraud on charges for physical goods. properties: address: properties: city: maxLength: 5000 type: string country: maxLength: 5000 type: string line1: maxLength: 5000 type: string line2: maxLength: 5000 type: string postal_code: maxLength: 5000 type: string state: maxLength: 5000 type: string title: optional_fields_address type: object carrier: maxLength: 5000 type: string name: maxLength: 5000 type: string phone: maxLength: 5000 type: string tracking_number: maxLength: 5000 type: string required: - address - name title: optional_fields_shipping type: object source: description: >- A payment source to be charged. This can be the ID of a [card](https://stripe.com/docs/api#cards) (i.e., credit or debit card), a [bank account](https://stripe.com/docs/api#bank_accounts), a [source](https://stripe.com/docs/api#sources), a [token](https://stripe.com/docs/api#tokens), or a [connected account](https://stripe.com/docs/connect/account-debits#charging-a-connected-account). For certain sources---namely, [cards](https://stripe.com/docs/api#cards), [bank accounts](https://stripe.com/docs/api#bank_accounts), and attached [sources](https://stripe.com/docs/api#sources)---you must also pass the ID of the associated customer. maxLength: 5000 type: string x-stripeBypassValidation: true statement_descriptor: description: >- For card charges, use `statement_descriptor_suffix` instead. Otherwise, you can use this value as the complete description of a charge on your customers’ statements. Must contain at least one letter, maximum 22 characters. maxLength: 22 type: string statement_descriptor_suffix: description: >- Provides information about the charge that customers see on their statements. Concatenated with the prefix (shortened descriptor) or statement descriptor that’s set on the account to form the complete statement descriptor. Maximum 22 characters for the concatenated descriptor. maxLength: 22 type: string transfer_data: description: >- An optional dictionary including the account to automatically transfer to as part of a destination charge. [See the Connect documentation](https://stripe.com/docs/connect/destination-charges) for details. properties: amount: type: integer destination: maxLength: 5000 type: string required: - destination title: transfer_data_specs type: object transfer_group: description: >- A string that identifies this transaction as part of a group. For details, see [Grouping transactions](https://stripe.com/docs/connect/separate-charges-and-transfers#transfer-options). type: string type: object required: false responses: '200': content: application/json: schema: $ref: '#/components/schemas/charge' description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. /v1/charges/search: get: description: >-

Search for charges you’ve previously created using Stripe’s Search Query Language. Don’t use search in read-after-write flows where strict consistency is necessary. Under normal operating conditions, data is searchable in less than a minute. Occasionally, propagation of new or updated data can be up to an hour behind during outages. Search functionality is not available to merchants in India.

operationId: GetChargesSearch parameters: - description: Specifies which fields in the response should be expanded. explode: true in: query name: expand required: false schema: items: maxLength: 5000 type: string type: array style: deepObject - description: >- A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. in: query name: limit required: false schema: type: integer style: form - description: >- A cursor for pagination across multiple pages of results. Don't include this parameter on the first call. Use the next_page value returned in a previous response to request subsequent results. in: query name: page required: false schema: maxLength: 5000 type: string style: form - description: >- The search query string. See [search query language](https://stripe.com/docs/search#search-query-language) and the list of supported [query fields for charges](https://stripe.com/docs/search#query-fields-for-charges). in: query name: query required: true schema: maxLength: 5000 type: string style: form requestBody: content: application/x-www-form-urlencoded: encoding: {} schema: additionalProperties: false properties: {} type: object required: false responses: '200': content: application/json: schema: description: '' properties: data: items: $ref: '#/components/schemas/charge' type: array has_more: type: boolean next_page: maxLength: 5000 nullable: true type: string object: description: >- String representing the object's type. Objects of the same type share the same value. enum: - search_result type: string total_count: description: >- The total number of objects that match the query, only accurate up to 10,000. type: integer url: maxLength: 5000 type: string required: - data - has_more - object - url title: SearchResult type: object x-expandableFields: - data description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. '/v1/charges/{charge}': get: description: >-

Retrieves the details of a charge that has previously been created. Supply the unique charge ID that was returned from your previous request, and Stripe will return the corresponding charge information. The same information is returned when creating or refunding the charge.

operationId: GetChargesCharge parameters: - in: path name: charge required: true schema: maxLength: 5000 type: string style: simple - description: Specifies which fields in the response should be expanded. explode: true in: query name: expand required: false schema: items: maxLength: 5000 type: string type: array style: deepObject requestBody: content: application/x-www-form-urlencoded: encoding: {} schema: additionalProperties: false properties: {} type: object required: false responses: '200': content: application/json: schema: $ref: '#/components/schemas/charge' description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. post: description: >-

Updates the specified charge by setting the values of the parameters passed. Any parameters not provided will be left unchanged.

operationId: PostChargesCharge parameters: - in: path name: charge required: true schema: maxLength: 5000 type: string style: simple requestBody: content: application/x-www-form-urlencoded: encoding: expand: explode: true style: deepObject fraud_details: explode: true style: deepObject metadata: explode: true style: deepObject shipping: explode: true style: deepObject schema: additionalProperties: false properties: customer: description: >- The ID of an existing customer that will be associated with this request. This field may only be updated if there is no existing associated customer with this charge. maxLength: 5000 type: string description: description: >- An arbitrary string which you can attach to a charge object. It is displayed when in the web interface alongside the charge. Note that if you use Stripe to send automatic email receipts to your customers, your receipt emails will include the `description` of the charge(s) that they are describing. maxLength: 40000 type: string expand: description: Specifies which fields in the response should be expanded. items: maxLength: 5000 type: string type: array fraud_details: description: >- A set of key-value pairs you can attach to a charge giving information about its riskiness. If you believe a charge is fraudulent, include a `user_report` key with a value of `fraudulent`. If you believe a charge is safe, include a `user_report` key with a value of `safe`. Stripe will use the information you send to improve our fraud detection algorithms. properties: user_report: enum: - '' - fraudulent - safe maxLength: 5000 type: string required: - user_report title: fraud_details type: object metadata: anyOf: - additionalProperties: type: string type: object - enum: - '' type: string description: >- Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. receipt_email: description: >- This is the email address that the receipt for this charge will be sent to. If this field is updated, then a new email receipt will be sent to the updated address. maxLength: 5000 type: string shipping: description: >- Shipping information for the charge. Helps prevent fraud on charges for physical goods. properties: address: properties: city: maxLength: 5000 type: string country: maxLength: 5000 type: string line1: maxLength: 5000 type: string line2: maxLength: 5000 type: string postal_code: maxLength: 5000 type: string state: maxLength: 5000 type: string title: optional_fields_address type: object carrier: maxLength: 5000 type: string name: maxLength: 5000 type: string phone: maxLength: 5000 type: string tracking_number: maxLength: 5000 type: string required: - address - name title: optional_fields_shipping type: object transfer_group: description: >- A string that identifies this transaction as part of a group. `transfer_group` may only be provided if it has not been set. See the [Connect documentation](https://stripe.com/docs/connect/separate-charges-and-transfers#transfer-options) for details. type: string type: object required: false responses: '200': content: application/json: schema: $ref: '#/components/schemas/charge' description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. '/v1/charges/{charge}/capture': post: description: >-

Capture the payment of an existing, uncaptured charge that was created with the capture option set to false.

Uncaptured payments expire a set number of days after they are created (7 by default), after which they are marked as refunded and capture attempts will fail.

Don’t use this method to capture a PaymentIntent-initiated charge. Use Capture a PaymentIntent.

operationId: PostChargesChargeCapture parameters: - in: path name: charge required: true schema: maxLength: 5000 type: string style: simple requestBody: content: application/x-www-form-urlencoded: encoding: expand: explode: true style: deepObject transfer_data: explode: true style: deepObject schema: additionalProperties: false properties: amount: description: >- The amount to capture, which must be less than or equal to the original amount. Any additional amount will be automatically refunded. type: integer application_fee: description: An application fee to add on to this charge. type: integer application_fee_amount: description: >- An application fee amount to add on to this charge, which must be less than or equal to the original amount. type: integer expand: description: Specifies which fields in the response should be expanded. items: maxLength: 5000 type: string type: array receipt_email: description: >- The email address to send this charge's receipt to. This will override the previously-specified email address for this charge, if one was set. Receipts will not be sent in test mode. type: string statement_descriptor: description: >- For card charges, use `statement_descriptor_suffix` instead. Otherwise, you can use this value as the complete description of a charge on your customers’ statements. Must contain at least one letter, maximum 22 characters. maxLength: 22 type: string statement_descriptor_suffix: description: >- Provides information about the charge that customers see on their statements. Concatenated with the prefix (shortened descriptor) or statement descriptor that’s set on the account to form the complete statement descriptor. Maximum 22 characters for the concatenated descriptor. maxLength: 22 type: string transfer_data: description: >- An optional dictionary including the account to automatically transfer to as part of a destination charge. [See the Connect documentation](https://stripe.com/docs/connect/destination-charges) for details. properties: amount: type: integer title: transfer_data_specs type: object transfer_group: description: >- A string that identifies this transaction as part of a group. `transfer_group` may only be provided if it has not been set. See the [Connect documentation](https://stripe.com/docs/connect/separate-charges-and-transfers#transfer-options) for details. type: string type: object required: false responses: '200': content: application/json: schema: $ref: '#/components/schemas/charge' description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. '/v1/charges/{charge}/dispute': get: description:

Retrieve a dispute for a specified charge.

operationId: GetChargesChargeDispute parameters: - in: path name: charge required: true schema: maxLength: 5000 type: string style: simple - description: Specifies which fields in the response should be expanded. explode: true in: query name: expand required: false schema: items: maxLength: 5000 type: string type: array style: deepObject requestBody: content: application/x-www-form-urlencoded: encoding: {} schema: additionalProperties: false properties: {} type: object required: false responses: '200': content: application/json: schema: $ref: '#/components/schemas/dispute' description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. post: description: '' operationId: PostChargesChargeDispute parameters: - in: path name: charge required: true schema: maxLength: 5000 type: string style: simple requestBody: content: application/x-www-form-urlencoded: encoding: evidence: explode: true style: deepObject expand: explode: true style: deepObject metadata: explode: true style: deepObject schema: additionalProperties: false properties: evidence: description: >- Evidence to upload, to respond to a dispute. Updating any field in the hash will submit all fields in the hash for review. The combined character count of all fields is limited to 150,000. properties: access_activity_log: maxLength: 20000 type: string billing_address: maxLength: 5000 type: string cancellation_policy: type: string cancellation_policy_disclosure: maxLength: 20000 type: string cancellation_rebuttal: maxLength: 20000 type: string customer_communication: type: string customer_email_address: maxLength: 5000 type: string customer_name: maxLength: 5000 type: string customer_purchase_ip: maxLength: 5000 type: string customer_signature: type: string duplicate_charge_documentation: type: string duplicate_charge_explanation: maxLength: 20000 type: string duplicate_charge_id: maxLength: 5000 type: string product_description: maxLength: 20000 type: string receipt: type: string refund_policy: type: string refund_policy_disclosure: maxLength: 20000 type: string refund_refusal_explanation: maxLength: 20000 type: string service_date: maxLength: 5000 type: string service_documentation: type: string shipping_address: maxLength: 5000 type: string shipping_carrier: maxLength: 5000 type: string shipping_date: maxLength: 5000 type: string shipping_documentation: type: string shipping_tracking_number: maxLength: 5000 type: string uncategorized_file: type: string uncategorized_text: maxLength: 20000 type: string title: dispute_evidence_params type: object expand: description: Specifies which fields in the response should be expanded. items: maxLength: 5000 type: string type: array metadata: anyOf: - additionalProperties: type: string type: object - enum: - '' type: string description: >- Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. submit: description: >- Whether to immediately submit evidence to the bank. If `false`, evidence is staged on the dispute. Staged evidence is visible in the API and Dashboard, and can be submitted to the bank by making another request with this attribute set to `true` (the default). type: boolean type: object required: false responses: '200': content: application/json: schema: $ref: '#/components/schemas/dispute' description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. '/v1/charges/{charge}/dispute/close': post: description: '' operationId: PostChargesChargeDisputeClose parameters: - in: path name: charge required: true schema: maxLength: 5000 type: string style: simple requestBody: content: application/x-www-form-urlencoded: encoding: expand: explode: true style: deepObject schema: additionalProperties: false properties: expand: description: Specifies which fields in the response should be expanded. items: maxLength: 5000 type: string type: array type: object required: false responses: '200': content: application/json: schema: $ref: '#/components/schemas/dispute' description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. '/v1/charges/{charge}/refund': post: description: >-

When you create a new refund, you must specify either a Charge or a PaymentIntent object.

This action refunds a previously created charge that’s not refunded yet. Funds are refunded to the credit or debit card that’s originally charged.

You can optionally refund only part of a charge. You can repeat this until the entire charge is refunded.

After you entirely refund a charge, you can’t refund it again. This method raises an error when it’s called on an already-refunded charge, or when you attempt to refund more money than is left on a charge.

operationId: PostChargesChargeRefund parameters: - description: The identifier of the charge to refund. in: path name: charge required: true schema: maxLength: 5000 type: string style: simple requestBody: content: application/x-www-form-urlencoded: encoding: expand: explode: true style: deepObject metadata: explode: true style: deepObject schema: additionalProperties: false properties: amount: description: >- A positive integer in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal) representing how much of this charge to refund. Can refund only up to the remaining, unrefunded amount of the charge. type: integer expand: description: Specifies which fields in the response should be expanded. items: maxLength: 5000 type: string type: array instructions_email: description: >- For payment methods without native refund support (e.g., Konbini, PromptPay), use this email from the customer to receive refund instructions. type: string metadata: anyOf: - additionalProperties: type: string type: object - enum: - '' type: string description: >- Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. payment_intent: description: The identifier of the PaymentIntent to refund. maxLength: 5000 type: string reason: description: >- String indicating the reason for the refund. If set, possible values are `duplicate`, `fraudulent`, and `requested_by_customer`. If you believe the charge to be fraudulent, specifying `fraudulent` as the reason will add the associated card and email to your [block lists](https://stripe.com/docs/radar/lists), and will also help us improve our fraud detection algorithms. enum: - duplicate - fraudulent - requested_by_customer maxLength: 5000 type: string refund_application_fee: description: >- Boolean indicating whether the application fee should be refunded when refunding this charge. If a full charge refund is given, the full application fee will be refunded. Otherwise, the application fee will be refunded in an amount proportional to the amount of the charge refunded. An application fee can be refunded only by the application that created the charge. type: boolean reverse_transfer: description: >- Boolean indicating whether the transfer should be reversed when refunding this charge. The transfer will be reversed proportionally to the amount being refunded (either the entire or partial amount).

A transfer can be reversed only by the application that created the charge. type: boolean type: object required: false responses: '200': content: application/json: schema: $ref: '#/components/schemas/charge' description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. '/v1/charges/{charge}/refunds': get: description: >-

You can see a list of the refunds belonging to a specific charge. Note that the 10 most recent refunds are always available by default on the charge object. If you need more than those 10, you can use this API method and the limit and starting_after parameters to page through additional refunds.

operationId: GetChargesChargeRefunds parameters: - in: path name: charge required: true schema: type: string style: simple - description: >- A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. in: query name: ending_before required: false schema: type: string style: form - description: Specifies which fields in the response should be expanded. explode: true in: query name: expand required: false schema: items: maxLength: 5000 type: string type: array style: deepObject - description: >- A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. in: query name: limit required: false schema: type: integer style: form - description: >- A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. in: query name: starting_after required: false schema: type: string style: form requestBody: content: application/x-www-form-urlencoded: encoding: {} schema: additionalProperties: false properties: {} type: object required: false responses: '200': content: application/json: schema: description: '' properties: data: description: Details about each object. items: $ref: '#/components/schemas/refund' type: array has_more: description: >- True if this list has another page of items after this one that can be fetched. type: boolean object: description: >- String representing the object's type. Objects of the same type share the same value. Always has the value `list`. enum: - list type: string url: description: The URL where this list can be accessed. maxLength: 5000 type: string required: - data - has_more - object - url title: RefundList type: object x-expandableFields: - data description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. post: description: >-

When you create a new refund, you must specify a Charge or a PaymentIntent object on which to create it.

Creating a new refund will refund a charge that has previously been created but not yet refunded. Funds will be refunded to the credit or debit card that was originally charged.

You can optionally refund only part of a charge. You can do so multiple times, until the entire charge has been refunded.

Once entirely refunded, a charge can’t be refunded again. This method will raise an error when called on an already-refunded charge, or when trying to refund more money than is left on a charge.

operationId: PostChargesChargeRefunds parameters: - description: The identifier of the charge to refund. in: path name: charge required: true schema: maxLength: 5000 type: string style: simple requestBody: content: application/x-www-form-urlencoded: encoding: expand: explode: true style: deepObject metadata: explode: true style: deepObject schema: additionalProperties: false properties: amount: type: integer currency: description: >- 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). type: string customer: description: Customer whose customer balance to refund from. maxLength: 5000 type: string expand: description: Specifies which fields in the response should be expanded. items: maxLength: 5000 type: string type: array instructions_email: description: >- For payment methods without native refund support (e.g., Konbini, PromptPay), use this email from the customer to receive refund instructions. type: string metadata: anyOf: - additionalProperties: type: string type: object - enum: - '' type: string description: >- Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. origin: description: Origin of the refund enum: - customer_balance type: string payment_intent: description: The identifier of the PaymentIntent to refund. maxLength: 5000 type: string reason: description: >- String indicating the reason for the refund. If set, possible values are `duplicate`, `fraudulent`, and `requested_by_customer`. If you believe the charge to be fraudulent, specifying `fraudulent` as the reason will add the associated card and email to your [block lists](https://stripe.com/docs/radar/lists), and will also help us improve our fraud detection algorithms. enum: - duplicate - fraudulent - requested_by_customer maxLength: 5000 type: string refund_application_fee: description: >- Boolean indicating whether the application fee should be refunded when refunding this charge. If a full charge refund is given, the full application fee will be refunded. Otherwise, the application fee will be refunded in an amount proportional to the amount of the charge refunded. An application fee can be refunded only by the application that created the charge. type: boolean reverse_transfer: description: >- Boolean indicating whether the transfer should be reversed when refunding this charge. The transfer will be reversed proportionally to the amount being refunded (either the entire or partial amount).

A transfer can be reversed only by the application that created the charge. type: boolean type: object required: false responses: '200': content: application/json: schema: $ref: '#/components/schemas/refund' description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. '/v1/charges/{charge}/refunds/{refund}': get: description:

Retrieves the details of an existing refund.

operationId: GetChargesChargeRefundsRefund parameters: - in: path name: charge required: true schema: type: string style: simple - description: Specifies which fields in the response should be expanded. explode: true in: query name: expand required: false schema: items: maxLength: 5000 type: string type: array style: deepObject - in: path name: refund required: true schema: type: string style: simple requestBody: content: application/x-www-form-urlencoded: encoding: {} schema: additionalProperties: false properties: {} type: object required: false responses: '200': content: application/json: schema: $ref: '#/components/schemas/refund' description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. post: description:

Update a specified refund.

operationId: PostChargesChargeRefundsRefund parameters: - in: path name: charge required: true schema: type: string style: simple - in: path name: refund required: true schema: type: string style: simple requestBody: content: application/x-www-form-urlencoded: encoding: expand: explode: true style: deepObject metadata: explode: true style: deepObject schema: additionalProperties: false properties: expand: description: Specifies which fields in the response should be expanded. items: maxLength: 5000 type: string type: array metadata: anyOf: - additionalProperties: type: string type: object - enum: - '' type: string type: object required: false responses: '200': content: application/json: schema: $ref: '#/components/schemas/refund' description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. /v1/checkout/sessions: get: description:

Returns a list of Checkout Sessions.

operationId: GetCheckoutSessions parameters: - description: >- Only return Checkout Sessions that were created during the given date interval. explode: true in: query name: created required: false schema: anyOf: - properties: gt: type: integer gte: type: integer lt: type: integer lte: type: integer title: range_query_specs type: object - type: integer style: deepObject - description: Only return the Checkout Sessions for the Customer specified. in: query name: customer required: false schema: maxLength: 5000 type: string style: form - description: >- Only return the Checkout Sessions for the Customer details specified. explode: true in: query name: customer_details required: false schema: properties: email: type: string required: - email title: customer_details_params type: object style: deepObject - description: >- A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. in: query name: ending_before required: false schema: maxLength: 5000 type: string style: form - description: Specifies which fields in the response should be expanded. explode: true in: query name: expand required: false schema: items: maxLength: 5000 type: string type: array style: deepObject - description: >- A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. in: query name: limit required: false schema: type: integer style: form - description: Only return the Checkout Session for the PaymentIntent specified. in: query name: payment_intent required: false schema: maxLength: 5000 type: string style: form - description: Only return the Checkout Sessions for the Payment Link specified. in: query name: payment_link required: false schema: maxLength: 5000 type: string style: form - description: >- A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. in: query name: starting_after required: false schema: maxLength: 5000 type: string style: form - description: Only return the Checkout Sessions matching the given status. in: query name: status required: false schema: enum: - complete - expired - open type: string style: form - description: Only return the Checkout Session for the subscription specified. in: query name: subscription required: false schema: maxLength: 5000 type: string style: form requestBody: content: application/x-www-form-urlencoded: encoding: {} schema: additionalProperties: false properties: {} type: object required: false responses: '200': content: application/json: schema: description: '' properties: data: items: $ref: '#/components/schemas/checkout.session' type: array has_more: description: >- True if this list has another page of items after this one that can be fetched. type: boolean object: description: >- String representing the object's type. Objects of the same type share the same value. Always has the value `list`. enum: - list type: string url: description: The URL where this list can be accessed. maxLength: 5000 type: string required: - data - has_more - object - url title: PaymentPagesCheckoutSessionList type: object x-expandableFields: - data description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. post: description:

Creates a Session object.

operationId: PostCheckoutSessions requestBody: content: application/x-www-form-urlencoded: encoding: after_expiration: explode: true style: deepObject automatic_tax: explode: true style: deepObject consent_collection: explode: true style: deepObject custom_fields: explode: true style: deepObject custom_text: explode: true style: deepObject customer_update: explode: true style: deepObject discounts: explode: true style: deepObject expand: explode: true style: deepObject invoice_creation: explode: true style: deepObject line_items: explode: true style: deepObject metadata: explode: true style: deepObject payment_intent_data: explode: true style: deepObject payment_method_data: explode: true style: deepObject payment_method_options: explode: true style: deepObject payment_method_types: explode: true style: deepObject phone_number_collection: explode: true style: deepObject saved_payment_method_options: explode: true style: deepObject setup_intent_data: explode: true style: deepObject shipping_address_collection: explode: true style: deepObject shipping_options: explode: true style: deepObject subscription_data: explode: true style: deepObject tax_id_collection: explode: true style: deepObject schema: additionalProperties: false properties: after_expiration: description: Configure actions after a Checkout Session has expired. properties: recovery: properties: allow_promotion_codes: type: boolean enabled: type: boolean required: - enabled title: recovery_params type: object title: after_expiration_params type: object allow_promotion_codes: description: Enables user redeemable promotion codes. type: boolean automatic_tax: description: >- Settings for automatic tax lookup for this session and resulting payments, invoices, and subscriptions. properties: enabled: type: boolean liability: properties: account: type: string type: enum: - account - self type: string required: - type title: param type: object required: - enabled title: automatic_tax_params type: object billing_address_collection: description: >- Specify whether Checkout should collect the customer's billing address. Defaults to `auto`. enum: - auto - required type: string cancel_url: description: >- If set, Checkout displays a back button and customers will be directed to this URL if they decide to cancel payment and return to your website. maxLength: 5000 type: string client_reference_id: description: >- A unique string to reference the Checkout Session. This can be a customer ID, a cart ID, or similar, and can be used to reconcile the session with your internal systems. maxLength: 200 type: string consent_collection: description: >- Configure fields for the Checkout Session to gather active consent from customers. properties: payment_method_reuse_agreement: properties: position: enum: - auto - hidden type: string required: - position title: payment_method_reuse_agreement_params type: object promotions: enum: - auto - none type: string terms_of_service: enum: - none - required type: string title: consent_collection_params type: object currency: description: >- Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). Required in `setup` mode when `payment_method_types` is not set. type: string custom_fields: description: >- Collect additional information from your customer using custom fields. Up to 3 fields are supported. items: properties: dropdown: properties: options: items: properties: label: maxLength: 100 type: string value: maxLength: 100 type: string required: - label - value title: custom_field_option_param type: object type: array required: - options title: custom_field_dropdown_param type: object key: maxLength: 200 type: string label: properties: custom: maxLength: 50 type: string type: enum: - custom type: string required: - custom - type title: custom_field_label_param type: object numeric: properties: maximum_length: type: integer minimum_length: type: integer title: custom_field_numeric_param type: object optional: type: boolean text: properties: maximum_length: type: integer minimum_length: type: integer title: custom_field_text_param type: object type: enum: - dropdown - numeric - text type: string required: - key - label - type title: custom_field_param type: object type: array custom_text: description: >- Display additional text for your customers using custom text. properties: after_submit: anyOf: - properties: message: maxLength: 1200 type: string required: - message title: custom_text_position_param type: object - enum: - '' type: string shipping_address: anyOf: - properties: message: maxLength: 1200 type: string required: - message title: custom_text_position_param type: object - enum: - '' type: string submit: anyOf: - properties: message: maxLength: 1200 type: string required: - message title: custom_text_position_param type: object - enum: - '' type: string terms_of_service_acceptance: anyOf: - properties: message: maxLength: 1200 type: string required: - message title: custom_text_position_param type: object - enum: - '' type: string title: custom_text_param type: object customer: description: >- ID of an existing Customer, if one exists. In `payment` mode, the customer’s most recently saved card payment method will be used to prefill the email, name, card details, and billing address on the Checkout page. In `subscription` mode, the customer’s [default payment method](https://stripe.com/docs/api/customers/update#update_customer-invoice_settings-default_payment_method) will be used if it’s a card, otherwise the most recently saved card will be used. A valid billing address, billing name and billing email are required on the payment method for Checkout to prefill the customer's card details. If the Customer already has a valid [email](https://stripe.com/docs/api/customers/object#customer_object-email) set, the email will be prefilled and not editable in Checkout. If the Customer does not have a valid `email`, Checkout will set the email entered during the session on the Customer. If blank for Checkout Sessions in `subscription` mode or with `customer_creation` set as `always` in `payment` mode, Checkout will create a new Customer object based on information provided during the payment flow. You can set [`payment_intent_data.setup_future_usage`](https://stripe.com/docs/api/checkout/sessions/create#create_checkout_session-payment_intent_data-setup_future_usage) to have Checkout automatically attach the payment method to the Customer you pass in for future reuse. maxLength: 5000 type: string customer_creation: description: >- Configure whether a Checkout Session creates a [Customer](https://stripe.com/docs/api/customers) during Session confirmation. When a Customer is not created, you can still retrieve email, address, and other customer data entered in Checkout with [customer_details](https://stripe.com/docs/api/checkout/sessions/object#checkout_session_object-customer_details). Sessions that don't create Customers instead are grouped by [guest customers](https://stripe.com/docs/payments/checkout/guest-customers) in the Dashboard. Promotion codes limited to first time customers will return invalid for these Sessions. Can only be set in `payment` and `setup` mode. enum: - always - if_required type: string customer_email: description: >- If provided, this value will be used when the Customer object is created. If not provided, customers will be asked to enter their email address. Use this parameter to prefill customer data if you already have an email on file. To access information about the customer once a session is complete, use the `customer` field. type: string customer_update: description: >- Controls what fields on Customer can be updated by the Checkout Session. Can only be provided when `customer` is provided. properties: address: enum: - auto - never type: string x-stripeBypassValidation: true name: enum: - auto - never type: string x-stripeBypassValidation: true shipping: enum: - auto - never type: string x-stripeBypassValidation: true title: customer_update_params type: object discounts: description: >- The coupon or promotion code to apply to this Session. Currently, only up to one may be specified. items: properties: coupon: maxLength: 5000 type: string promotion_code: maxLength: 5000 type: string title: discount_params type: object type: array expand: description: Specifies which fields in the response should be expanded. items: maxLength: 5000 type: string type: array expires_at: description: >- The Epoch time in seconds at which the Checkout Session will expire. It can be anywhere from 30 minutes to 24 hours after Checkout Session creation. By default, this value is 24 hours from creation. format: unix-time type: integer invoice_creation: description: Generate a post-purchase Invoice for one-time payments. properties: enabled: type: boolean invoice_data: properties: account_tax_ids: anyOf: - items: maxLength: 5000 type: string type: array - enum: - '' type: string custom_fields: anyOf: - items: properties: name: maxLength: 40 type: string value: maxLength: 140 type: string required: - name - value title: custom_field_params type: object type: array - enum: - '' type: string description: maxLength: 1500 type: string footer: maxLength: 5000 type: string issuer: properties: account: type: string type: enum: - account - self type: string required: - type title: param type: object metadata: additionalProperties: type: string type: object rendering_options: anyOf: - properties: amount_tax_display: enum: - '' - exclude_tax - include_inclusive_tax type: string title: rendering_options_param type: object - enum: - '' type: string title: invoice_data_params type: object required: - enabled title: invoice_creation_params type: object line_items: description: >- A list of items the customer is purchasing. Use this parameter to pass one-time or recurring [Prices](https://stripe.com/docs/api/prices). For `payment` mode, there is a maximum of 100 line items, however it is recommended to consolidate line items if there are more than a few dozen. For `subscription` mode, there is a maximum of 20 line items with recurring Prices and 20 line items with one-time Prices. Line items with one-time Prices will be on the initial invoice only. items: properties: adjustable_quantity: properties: enabled: type: boolean maximum: type: integer minimum: type: integer required: - enabled title: adjustable_quantity_params type: object dynamic_tax_rates: items: maxLength: 5000 type: string type: array price: maxLength: 5000 type: string price_data: properties: currency: type: string product: maxLength: 5000 type: string product_data: properties: description: maxLength: 40000 type: string images: items: type: string type: array metadata: additionalProperties: type: string type: object name: maxLength: 5000 type: string tax_code: maxLength: 5000 type: string required: - name title: product_data type: object recurring: properties: interval: enum: - day - month - week - year type: string interval_count: type: integer required: - interval title: recurring_adhoc type: object tax_behavior: enum: - exclusive - inclusive - unspecified type: string unit_amount: type: integer unit_amount_decimal: format: decimal type: string required: - currency title: price_data_with_product_data type: object quantity: type: integer tax_rates: items: maxLength: 5000 type: string type: array title: line_item_params type: object type: array locale: description: >- The IETF language tag of the locale Checkout is displayed in. If blank or `auto`, the browser's locale is used. enum: - auto - bg - cs - da - de - el - en - en-GB - es - es-419 - et - fi - fil - fr - fr-CA - hr - hu - id - it - ja - ko - lt - lv - ms - mt - nb - nl - pl - pt - pt-BR - ro - ru - sk - sl - sv - th - tr - vi - zh - zh-HK - zh-TW type: string x-stripeBypassValidation: true metadata: additionalProperties: type: string description: >- Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. type: object mode: description: >- The mode of the Checkout Session. Pass `subscription` if the Checkout Session includes at least one recurring item. enum: - payment - setup - subscription type: string payment_intent_data: description: >- A subset of parameters to be passed to PaymentIntent creation for Checkout Sessions in `payment` mode. properties: application_fee_amount: type: integer capture_method: enum: - automatic - automatic_async - manual type: string description: maxLength: 1000 type: string metadata: additionalProperties: type: string type: object on_behalf_of: type: string receipt_email: type: string setup_future_usage: enum: - off_session - on_session type: string shipping: properties: address: properties: city: maxLength: 5000 type: string country: maxLength: 5000 type: string line1: maxLength: 5000 type: string line2: maxLength: 5000 type: string postal_code: maxLength: 5000 type: string state: maxLength: 5000 type: string required: - line1 title: address type: object carrier: maxLength: 5000 type: string name: maxLength: 5000 type: string phone: maxLength: 5000 type: string tracking_number: maxLength: 5000 type: string required: - address - name title: shipping type: object statement_descriptor: maxLength: 22 type: string statement_descriptor_suffix: maxLength: 22 type: string transfer_data: properties: amount: type: integer destination: type: string required: - destination title: transfer_data_params type: object transfer_group: type: string title: payment_intent_data_params type: object payment_method_collection: description: >- Specify whether Checkout should collect a payment method. When set to `if_required`, Checkout will not collect a payment method when the total due for the session is 0. This may occur if the Checkout Session includes a free trial or a discount. Can only be set in `subscription` mode. Defaults to `always`. If you'd like information on how to collect a payment method outside of Checkout, read the guide on configuring [subscriptions with a free trial](https://stripe.com/docs/payments/checkout/free-trials). enum: - always - if_required type: string payment_method_configuration: description: >- The ID of the payment method configuration to use with this Checkout session. maxLength: 100 type: string payment_method_data: description: >- This parameter allows you to set some attributes on the payment method created during a Checkout session. properties: allow_redisplay: enum: - always - limited - unspecified type: string title: payment_method_data_param type: object payment_method_options: description: Payment-method-specific configuration. properties: acss_debit: properties: currency: enum: - cad - usd type: string mandate_options: properties: custom_mandate_url: anyOf: - type: string - enum: - '' type: string default_for: items: enum: - invoice - subscription type: string type: array interval_description: maxLength: 500 type: string payment_schedule: enum: - combined - interval - sporadic type: string transaction_type: enum: - business - personal type: string title: mandate_options_param type: object setup_future_usage: enum: - none - off_session - on_session type: string verification_method: enum: - automatic - instant - microdeposits type: string x-stripeBypassValidation: true title: payment_method_options_param type: object affirm: properties: setup_future_usage: enum: - none type: string title: payment_method_options_param type: object afterpay_clearpay: properties: setup_future_usage: enum: - none type: string title: payment_method_options_param type: object alipay: properties: setup_future_usage: enum: - none type: string title: payment_method_options_param type: object amazon_pay: properties: setup_future_usage: enum: - none - off_session type: string title: payment_method_options_param type: object au_becs_debit: properties: setup_future_usage: enum: - none type: string title: payment_method_options_param type: object bacs_debit: properties: setup_future_usage: enum: - none - off_session - on_session type: string title: payment_method_options_param type: object bancontact: properties: setup_future_usage: enum: - none type: string title: payment_method_options_param type: object boleto: properties: expires_after_days: type: integer setup_future_usage: enum: - none - off_session - on_session type: string title: payment_method_options_param type: object card: properties: installments: properties: enabled: type: boolean title: installments_param type: object request_three_d_secure: enum: - any - automatic - challenge type: string x-stripeBypassValidation: true setup_future_usage: enum: - off_session - on_session type: string statement_descriptor_suffix_kana: maxLength: 22 type: string statement_descriptor_suffix_kanji: maxLength: 17 type: string title: payment_method_options_param type: object cashapp: properties: setup_future_usage: enum: - none - off_session - on_session type: string title: payment_method_options_param type: object customer_balance: properties: bank_transfer: properties: eu_bank_transfer: properties: country: maxLength: 5000 type: string required: - country title: eu_bank_transfer_params type: object requested_address_types: items: enum: - aba - iban - sepa - sort_code - spei - swift - zengin type: string x-stripeBypassValidation: true type: array type: enum: - eu_bank_transfer - gb_bank_transfer - jp_bank_transfer - mx_bank_transfer - us_bank_transfer type: string x-stripeBypassValidation: true required: - type title: bank_transfer_param type: object funding_type: enum: - bank_transfer type: string setup_future_usage: enum: - none type: string title: payment_method_options_param type: object eps: properties: setup_future_usage: enum: - none type: string title: payment_method_options_param type: object fpx: properties: setup_future_usage: enum: - none type: string title: payment_method_options_param type: object giropay: properties: setup_future_usage: enum: - none type: string title: payment_method_options_param type: object grabpay: properties: setup_future_usage: enum: - none type: string title: payment_method_options_param type: object ideal: properties: setup_future_usage: enum: - none type: string title: payment_method_options_param type: object klarna: properties: setup_future_usage: enum: - none type: string title: payment_method_options_param type: object konbini: properties: expires_after_days: type: integer setup_future_usage: enum: - none type: string title: payment_method_options_param type: object link: properties: setup_future_usage: enum: - none - off_session type: string title: payment_method_options_param type: object mobilepay: properties: setup_future_usage: enum: - none type: string title: payment_method_options_param type: object oxxo: properties: expires_after_days: type: integer setup_future_usage: enum: - none type: string title: payment_method_options_param type: object p24: properties: setup_future_usage: enum: - none type: string tos_shown_and_accepted: type: boolean title: payment_method_options_param type: object paynow: properties: setup_future_usage: enum: - none type: string title: payment_method_options_param type: object paypal: properties: capture_method: enum: - '' - manual type: string preferred_locale: enum: - cs-CZ - da-DK - de-AT - de-DE - de-LU - el-GR - en-GB - en-US - es-ES - fi-FI - fr-BE - fr-FR - fr-LU - hu-HU - it-IT - nl-BE - nl-NL - pl-PL - pt-PT - sk-SK - sv-SE type: string x-stripeBypassValidation: true reference: maxLength: 127 type: string risk_correlation_id: maxLength: 32 type: string setup_future_usage: enum: - '' - none - off_session type: string title: payment_method_options_param type: object pix: properties: expires_after_seconds: type: integer title: payment_method_options_param type: object revolut_pay: properties: setup_future_usage: enum: - none - off_session type: string title: payment_method_options_param type: object sepa_debit: properties: setup_future_usage: enum: - none - off_session - on_session type: string title: payment_method_options_param type: object sofort: properties: setup_future_usage: enum: - none type: string title: payment_method_options_param type: object swish: properties: reference: maxLength: 5000 type: string title: payment_method_options_param type: object us_bank_account: properties: financial_connections: properties: permissions: items: enum: - balances - ownership - payment_method - transactions maxLength: 5000 type: string x-stripeBypassValidation: true type: array prefetch: items: enum: - balances - ownership - transactions type: string x-stripeBypassValidation: true type: array title: linked_account_options_param type: object setup_future_usage: enum: - none - off_session - on_session type: string verification_method: enum: - automatic - instant type: string x-stripeBypassValidation: true title: payment_method_options_param type: object wechat_pay: properties: app_id: maxLength: 5000 type: string client: enum: - android - ios - web type: string x-stripeBypassValidation: true setup_future_usage: enum: - none type: string required: - client title: payment_method_options_param type: object title: payment_method_options_param type: object payment_method_types: description: >- A list of the types of payment methods (e.g., `card`) this Checkout Session can accept. You can omit this attribute to manage your payment methods from the [Stripe Dashboard](https://dashboard.stripe.com/settings/payment_methods). See [Dynamic Payment Methods](https://stripe.com/docs/payments/payment-methods/integration-options#using-dynamic-payment-methods) for more details. Read more about the supported payment methods and their requirements in our [payment method details guide](/docs/payments/checkout/payment-methods). If multiple payment methods are passed, Checkout will dynamically reorder them to prioritize the most relevant payment methods based on the customer's location and other characteristics. items: enum: - acss_debit - affirm - afterpay_clearpay - alipay - amazon_pay - au_becs_debit - bacs_debit - bancontact - blik - boleto - card - cashapp - customer_balance - eps - fpx - giropay - grabpay - ideal - klarna - konbini - link - mobilepay - oxxo - p24 - paynow - paypal - pix - promptpay - revolut_pay - sepa_debit - sofort - swish - us_bank_account - wechat_pay - zip type: string x-stripeBypassValidation: true type: array phone_number_collection: description: >- Controls phone number collection settings for the session. We recommend that you review your privacy policy and check with your legal contacts before using this feature. Learn more about [collecting phone numbers with Checkout](https://stripe.com/docs/payments/checkout/phone-numbers). properties: enabled: type: boolean required: - enabled title: phone_number_collection_params type: object redirect_on_completion: description: >- This parameter applies to `ui_mode: embedded`. Learn more about the [redirect behavior](https://stripe.com/docs/payments/checkout/custom-redirect-behavior) of embedded sessions. Defaults to `always`. enum: - always - if_required - never type: string return_url: description: >- The URL to redirect your customer back to after they authenticate or cancel their payment on the payment method's app or site. This parameter is required if ui_mode is `embedded` and redirect-based payment methods are enabled on the session. maxLength: 5000 type: string saved_payment_method_options: description: >- Controls saved payment method settings for the session. Only available in `payment` and `subscription` mode. properties: allow_redisplay_filters: items: enum: - always - limited - unspecified type: string type: array payment_method_save: enum: - disabled - enabled type: string title: saved_payment_method_options_param type: object setup_intent_data: description: >- A subset of parameters to be passed to SetupIntent creation for Checkout Sessions in `setup` mode. properties: description: maxLength: 1000 type: string metadata: additionalProperties: type: string type: object on_behalf_of: type: string title: setup_intent_data_param type: object shipping_address_collection: description: >- When set, provides configuration for Checkout to collect a shipping address from a customer. properties: allowed_countries: items: enum: - AC - AD - AE - AF - AG - AI - AL - AM - AO - AQ - AR - AT - AU - AW - AX - AZ - BA - BB - BD - BE - BF - BG - BH - BI - BJ - BL - BM - BN - BO - BQ - BR - BS - BT - BV - BW - BY - BZ - CA - CD - CF - CG - CH - CI - CK - CL - CM - CN - CO - CR - CV - CW - CY - CZ - DE - DJ - DK - DM - DO - DZ - EC - EE - EG - EH - ER - ES - ET - FI - FJ - FK - FO - FR - GA - GB - GD - GE - GF - GG - GH - GI - GL - GM - GN - GP - GQ - GR - GS - GT - GU - GW - GY - HK - HN - HR - HT - HU - ID - IE - IL - IM - IN - IO - IQ - IS - IT - JE - JM - JO - JP - KE - KG - KH - KI - KM - KN - KR - KW - KY - KZ - LA - LB - LC - LI - LK - LR - LS - LT - LU - LV - LY - MA - MC - MD - ME - MF - MG - MK - ML - MM - MN - MO - MQ - MR - MS - MT - MU - MV - MW - MX - MY - MZ - NA - NC - NE - NG - NI - NL - 'NO' - NP - NR - NU - NZ - OM - PA - PE - PF - PG - PH - PK - PL - PM - PN - PR - PS - PT - PY - QA - RE - RO - RS - RU - RW - SA - SB - SC - SE - SG - SH - SI - SJ - SK - SL - SM - SN - SO - SR - SS - ST - SV - SX - SZ - TA - TC - TD - TF - TG - TH - TJ - TK - TL - TM - TN - TO - TR - TT - TV - TW - TZ - UA - UG - US - UY - UZ - VA - VC - VE - VG - VN - VU - WF - WS - XK - YE - YT - ZA - ZM - ZW - ZZ type: string type: array required: - allowed_countries title: shipping_address_collection_params type: object shipping_options: description: >- The shipping rate options to apply to this Session. Up to a maximum of 5. items: properties: shipping_rate: maxLength: 5000 type: string shipping_rate_data: properties: delivery_estimate: properties: maximum: properties: unit: enum: - business_day - day - hour - month - week type: string value: type: integer required: - unit - value title: delivery_estimate_bound type: object minimum: properties: unit: enum: - business_day - day - hour - month - week type: string value: type: integer required: - unit - value title: delivery_estimate_bound type: object title: delivery_estimate type: object display_name: maxLength: 100 type: string fixed_amount: properties: amount: type: integer currency: type: string currency_options: additionalProperties: properties: amount: type: integer tax_behavior: enum: - exclusive - inclusive - unspecified type: string required: - amount title: currency_option type: object type: object required: - amount - currency title: fixed_amount type: object metadata: additionalProperties: type: string type: object tax_behavior: enum: - exclusive - inclusive - unspecified type: string tax_code: type: string type: enum: - fixed_amount type: string required: - display_name title: method_params type: object title: shipping_option_params type: object type: array submit_type: description: >- Describes the type of transaction being performed by Checkout in order to customize relevant text on the page, such as the submit button. `submit_type` can only be specified on Checkout Sessions in `payment` mode. If blank or `auto`, `pay` is used. enum: - auto - book - donate - pay type: string subscription_data: description: >- A subset of parameters to be passed to subscription creation for Checkout Sessions in `subscription` mode. properties: application_fee_percent: type: number billing_cycle_anchor: format: unix-time type: integer default_tax_rates: items: maxLength: 5000 type: string type: array description: maxLength: 500 type: string invoice_settings: properties: issuer: properties: account: type: string type: enum: - account - self type: string required: - type title: param type: object title: invoice_settings_params type: object metadata: additionalProperties: type: string type: object on_behalf_of: type: string proration_behavior: enum: - create_prorations - none type: string transfer_data: properties: amount_percent: type: number destination: type: string required: - destination title: transfer_data_specs type: object trial_end: format: unix-time type: integer trial_period_days: type: integer trial_settings: properties: end_behavior: properties: missing_payment_method: enum: - cancel - create_invoice - pause type: string required: - missing_payment_method title: end_behavior type: object required: - end_behavior title: trial_settings_config type: object title: subscription_data_params type: object success_url: description: >- The URL to which Stripe should send customers when payment or setup is complete. This parameter is not allowed if ui_mode is `embedded`. If you’d like to use information from the successful Checkout Session on your page, read the guide on [customizing your success page](https://stripe.com/docs/payments/checkout/custom-success-page). maxLength: 5000 type: string tax_id_collection: description: Controls tax ID collection settings for the session. properties: enabled: type: boolean required: - enabled title: tax_id_collection_params type: object ui_mode: description: The UI mode of the Session. Defaults to `hosted`. enum: - embedded - hosted type: string x-stripeBypassValidation: true type: object required: false responses: '200': content: application/json: schema: $ref: '#/components/schemas/checkout.session' description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. '/v1/checkout/sessions/{session}': get: description:

Retrieves a Session object.

operationId: GetCheckoutSessionsSession parameters: - description: Specifies which fields in the response should be expanded. explode: true in: query name: expand required: false schema: items: maxLength: 5000 type: string type: array style: deepObject - in: path name: session required: true schema: maxLength: 66 type: string style: simple requestBody: content: application/x-www-form-urlencoded: encoding: {} schema: additionalProperties: false properties: {} type: object required: false responses: '200': content: application/json: schema: $ref: '#/components/schemas/checkout.session' description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. '/v1/checkout/sessions/{session}/expire': post: description: >-

A Session can be expired when it is in one of these statuses: open

After it expires, a customer can’t complete a Session and customers loading the Session see a message saying the Session is expired.

operationId: PostCheckoutSessionsSessionExpire parameters: - in: path name: session required: true schema: maxLength: 5000 type: string style: simple requestBody: content: application/x-www-form-urlencoded: encoding: expand: explode: true style: deepObject schema: additionalProperties: false properties: expand: description: Specifies which fields in the response should be expanded. items: maxLength: 5000 type: string type: array type: object required: false responses: '200': content: application/json: schema: $ref: '#/components/schemas/checkout.session' description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. '/v1/checkout/sessions/{session}/line_items': get: description: >-

When retrieving a Checkout Session, there is an includable line_items property containing the first handful of those items. There is also a URL where you can retrieve the full (paginated) list of line items.

operationId: GetCheckoutSessionsSessionLineItems parameters: - description: >- A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. in: query name: ending_before required: false schema: maxLength: 5000 type: string style: form - description: Specifies which fields in the response should be expanded. explode: true in: query name: expand required: false schema: items: maxLength: 5000 type: string type: array style: deepObject - description: >- A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. in: query name: limit required: false schema: type: integer style: form - in: path name: session required: true schema: maxLength: 5000 type: string style: simple - description: >- A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. in: query name: starting_after required: false schema: maxLength: 5000 type: string style: form requestBody: content: application/x-www-form-urlencoded: encoding: {} schema: additionalProperties: false properties: {} type: object required: false responses: '200': content: application/json: schema: description: '' properties: data: description: Details about each object. items: $ref: '#/components/schemas/item' type: array has_more: description: >- True if this list has another page of items after this one that can be fetched. type: boolean object: description: >- String representing the object's type. Objects of the same type share the same value. Always has the value `list`. enum: - list type: string url: description: The URL where this list can be accessed. maxLength: 5000 type: string required: - data - has_more - object - url title: PaymentPagesCheckoutSessionListLineItems type: object x-expandableFields: - data description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. /v1/climate/orders: get: description: >-

Lists all Climate order objects. The orders are returned sorted by creation date, with the most recently created orders appearing first.

operationId: GetClimateOrders parameters: - description: >- A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. in: query name: ending_before required: false schema: maxLength: 5000 type: string style: form - description: Specifies which fields in the response should be expanded. explode: true in: query name: expand required: false schema: items: maxLength: 5000 type: string type: array style: deepObject - description: >- A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. in: query name: limit required: false schema: type: integer style: form - description: >- A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. in: query name: starting_after required: false schema: maxLength: 5000 type: string style: form requestBody: content: application/x-www-form-urlencoded: encoding: {} schema: additionalProperties: false properties: {} type: object required: false responses: '200': content: application/json: schema: description: '' properties: data: items: $ref: '#/components/schemas/climate.order' type: array has_more: description: >- True if this list has another page of items after this one that can be fetched. type: boolean object: description: >- String representing the object's type. Objects of the same type share the same value. Always has the value `list`. enum: - list type: string url: description: The URL where this list can be accessed. maxLength: 5000 pattern: ^/v1/climate/orders type: string required: - data - has_more - object - url title: ClimateRemovalsOrdersList type: object x-expandableFields: - data description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. post: description: >-

Creates a Climate order object for a given Climate product. The order will be processed immediately after creation and payment will be deducted your Stripe balance.

operationId: PostClimateOrders requestBody: content: application/x-www-form-urlencoded: encoding: beneficiary: explode: true style: deepObject expand: explode: true style: deepObject metadata: explode: true style: deepObject schema: additionalProperties: false properties: amount: description: >- Requested amount of carbon removal units. Either this or `metric_tons` must be specified. type: integer beneficiary: description: >- Publicly sharable reference for the end beneficiary of carbon removal. Assumed to be the Stripe account if not set. properties: public_name: maxLength: 5000 type: string required: - public_name title: beneficiary_params type: object currency: description: >- Request currency for the order as a three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a supported [settlement currency for your account](https://stripe.com/docs/currencies). If omitted, the account's default currency will be used. maxLength: 5000 type: string expand: description: Specifies which fields in the response should be expanded. items: maxLength: 5000 type: string type: array metadata: additionalProperties: type: string description: >- Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. type: object metric_tons: description: >- Requested number of tons for the order. Either this or `amount` must be specified. format: decimal type: string product: description: Unique identifier of the Climate product. maxLength: 5000 type: string required: - product type: object required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/climate.order' description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. '/v1/climate/orders/{order}': get: description: >-

Retrieves the details of a Climate order object with the given ID.

operationId: GetClimateOrdersOrder parameters: - description: Specifies which fields in the response should be expanded. explode: true in: query name: expand required: false schema: items: maxLength: 5000 type: string type: array style: deepObject - description: Unique identifier of the order. in: path name: order required: true schema: maxLength: 5000 type: string style: simple requestBody: content: application/x-www-form-urlencoded: encoding: {} schema: additionalProperties: false properties: {} type: object required: false responses: '200': content: application/json: schema: $ref: '#/components/schemas/climate.order' description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. post: description: >-

Updates the specified order by setting the values of the parameters passed.

operationId: PostClimateOrdersOrder parameters: - description: Unique identifier of the order. in: path name: order required: true schema: maxLength: 5000 type: string style: simple requestBody: content: application/x-www-form-urlencoded: encoding: beneficiary: explode: true style: deepObject expand: explode: true style: deepObject metadata: explode: true style: deepObject schema: additionalProperties: false properties: beneficiary: anyOf: - properties: public_name: anyOf: - maxLength: 5000 type: string - enum: - '' type: string required: - public_name title: beneficiary_params type: object - enum: - '' type: string description: >- Publicly sharable reference for the end beneficiary of carbon removal. Assumed to be the Stripe account if not set. expand: description: Specifies which fields in the response should be expanded. items: maxLength: 5000 type: string type: array metadata: additionalProperties: type: string description: >- Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. type: object type: object required: false responses: '200': content: application/json: schema: $ref: '#/components/schemas/climate.order' description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. '/v1/climate/orders/{order}/cancel': post: description: >-

Cancels a Climate order. You can cancel an order within 30 days of creation. Stripe refunds the reservation amount_subtotal, but not the amount_fees for user-triggered cancellations. Frontier might cancel reservations if suppliers fail to deliver. If Frontier cancels the reservation, Stripe provides 90 days advance notice and refunds the amount_total.

operationId: PostClimateOrdersOrderCancel parameters: - description: Unique identifier of the order. in: path name: order required: true schema: maxLength: 5000 type: string style: simple requestBody: content: application/x-www-form-urlencoded: encoding: expand: explode: true style: deepObject schema: additionalProperties: false properties: expand: description: Specifies which fields in the response should be expanded. items: maxLength: 5000 type: string type: array type: object required: false responses: '200': content: application/json: schema: $ref: '#/components/schemas/climate.order' description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. /v1/climate/products: get: description:

Lists all available Climate product objects.

operationId: GetClimateProducts parameters: - description: >- A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. in: query name: ending_before required: false schema: maxLength: 5000 type: string style: form - description: Specifies which fields in the response should be expanded. explode: true in: query name: expand required: false schema: items: maxLength: 5000 type: string type: array style: deepObject - description: >- A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. in: query name: limit required: false schema: type: integer style: form - description: >- A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. in: query name: starting_after required: false schema: maxLength: 5000 type: string style: form requestBody: content: application/x-www-form-urlencoded: encoding: {} schema: additionalProperties: false properties: {} type: object required: false responses: '200': content: application/json: schema: description: '' properties: data: items: $ref: '#/components/schemas/climate.product' type: array has_more: description: >- True if this list has another page of items after this one that can be fetched. type: boolean object: description: >- String representing the object's type. Objects of the same type share the same value. Always has the value `list`. enum: - list type: string url: description: The URL where this list can be accessed. maxLength: 5000 pattern: ^/v1/climate/products type: string required: - data - has_more - object - url title: ClimateRemovalsProductsList type: object x-expandableFields: - data description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. '/v1/climate/products/{product}': get: description:

Retrieves the details of a Climate product with the given ID.

operationId: GetClimateProductsProduct parameters: - description: Specifies which fields in the response should be expanded. explode: true in: query name: expand required: false schema: items: maxLength: 5000 type: string type: array style: deepObject - in: path name: product required: true schema: maxLength: 5000 type: string style: simple requestBody: content: application/x-www-form-urlencoded: encoding: {} schema: additionalProperties: false properties: {} type: object required: false responses: '200': content: application/json: schema: $ref: '#/components/schemas/climate.product' description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. /v1/climate/suppliers: get: description:

Lists all available Climate supplier objects.

operationId: GetClimateSuppliers parameters: - description: >- A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. in: query name: ending_before required: false schema: maxLength: 5000 type: string style: form - description: Specifies which fields in the response should be expanded. explode: true in: query name: expand required: false schema: items: maxLength: 5000 type: string type: array style: deepObject - description: >- A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. in: query name: limit required: false schema: type: integer style: form - description: >- A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. in: query name: starting_after required: false schema: maxLength: 5000 type: string style: form requestBody: content: application/x-www-form-urlencoded: encoding: {} schema: additionalProperties: false properties: {} type: object required: false responses: '200': content: application/json: schema: description: '' properties: data: items: $ref: '#/components/schemas/climate.supplier' type: array has_more: description: >- True if this list has another page of items after this one that can be fetched. type: boolean object: description: >- String representing the object's type. Objects of the same type share the same value. Always has the value `list`. enum: - list type: string url: description: The URL where this list can be accessed. maxLength: 5000 pattern: ^/v1/climate/suppliers type: string required: - data - has_more - object - url title: ClimateRemovalsSuppliersList type: object x-expandableFields: - data description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. '/v1/climate/suppliers/{supplier}': get: description:

Retrieves a Climate supplier object.

operationId: GetClimateSuppliersSupplier parameters: - description: Specifies which fields in the response should be expanded. explode: true in: query name: expand required: false schema: items: maxLength: 5000 type: string type: array style: deepObject - in: path name: supplier required: true schema: maxLength: 5000 type: string style: simple requestBody: content: application/x-www-form-urlencoded: encoding: {} schema: additionalProperties: false properties: {} type: object required: false responses: '200': content: application/json: schema: $ref: '#/components/schemas/climate.supplier' description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. '/v1/confirmation_tokens/{confirmation_token}': get: description:

Retrieves an existing ConfirmationToken object

operationId: GetConfirmationTokensConfirmationToken parameters: - in: path name: confirmation_token required: true schema: maxLength: 5000 type: string style: simple - description: Specifies which fields in the response should be expanded. explode: true in: query name: expand required: false schema: items: maxLength: 5000 type: string type: array style: deepObject requestBody: content: application/x-www-form-urlencoded: encoding: {} schema: additionalProperties: false properties: {} type: object required: false responses: '200': content: application/json: schema: $ref: '#/components/schemas/confirmation_token' description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. /v1/country_specs: get: description:

Lists all Country Spec objects available in the API.

operationId: GetCountrySpecs parameters: - description: >- A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. in: query name: ending_before required: false schema: maxLength: 5000 type: string style: form - description: Specifies which fields in the response should be expanded. explode: true in: query name: expand required: false schema: items: maxLength: 5000 type: string type: array style: deepObject - description: >- A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. in: query name: limit required: false schema: type: integer style: form - description: >- A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. in: query name: starting_after required: false schema: maxLength: 5000 type: string style: form requestBody: content: application/x-www-form-urlencoded: encoding: {} schema: additionalProperties: false properties: {} type: object required: false responses: '200': content: application/json: schema: description: '' properties: data: items: $ref: '#/components/schemas/country_spec' type: array has_more: description: >- True if this list has another page of items after this one that can be fetched. type: boolean object: description: >- String representing the object's type. Objects of the same type share the same value. Always has the value `list`. enum: - list type: string url: description: The URL where this list can be accessed. maxLength: 5000 pattern: ^/v1/country_specs type: string required: - data - has_more - object - url title: CountrySpecList type: object x-expandableFields: - data description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. '/v1/country_specs/{country}': get: description:

Returns a Country Spec for a given Country code.

operationId: GetCountrySpecsCountry parameters: - in: path name: country required: true schema: maxLength: 5000 type: string style: simple - description: Specifies which fields in the response should be expanded. explode: true in: query name: expand required: false schema: items: maxLength: 5000 type: string type: array style: deepObject requestBody: content: application/x-www-form-urlencoded: encoding: {} schema: additionalProperties: false properties: {} type: object required: false responses: '200': content: application/json: schema: $ref: '#/components/schemas/country_spec' description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. /v1/coupons: get: description:

Returns a list of your coupons.

operationId: GetCoupons parameters: - description: >- A filter on the list, based on the object `created` field. The value can be a string with an integer Unix timestamp, or it can be a dictionary with a number of different query options. explode: true in: query name: created required: false schema: anyOf: - properties: gt: type: integer gte: type: integer lt: type: integer lte: type: integer title: range_query_specs type: object - type: integer style: deepObject - description: >- A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. in: query name: ending_before required: false schema: maxLength: 5000 type: string style: form - description: Specifies which fields in the response should be expanded. explode: true in: query name: expand required: false schema: items: maxLength: 5000 type: string type: array style: deepObject - description: >- A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. in: query name: limit required: false schema: type: integer style: form - description: >- A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. in: query name: starting_after required: false schema: maxLength: 5000 type: string style: form requestBody: content: application/x-www-form-urlencoded: encoding: {} schema: additionalProperties: false properties: {} type: object required: false responses: '200': content: application/json: schema: description: '' properties: data: items: $ref: '#/components/schemas/coupon' type: array has_more: description: >- True if this list has another page of items after this one that can be fetched. type: boolean object: description: >- String representing the object's type. Objects of the same type share the same value. Always has the value `list`. enum: - list type: string url: description: The URL where this list can be accessed. maxLength: 5000 pattern: ^/v1/coupons type: string required: - data - has_more - object - url title: CouponsResourceCouponList type: object x-expandableFields: - data description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. post: description: >-

You can create coupons easily via the coupon management page of the Stripe dashboard. Coupon creation is also accessible via the API if you need to create coupons on the fly.

A coupon has either a percent_off or an amount_off and currency. If you set an amount_off, that amount will be subtracted from any invoice’s subtotal. For example, an invoice with a subtotal of 100 will have a final total of 0 if a coupon with an amount_off of 200 is applied to it and an invoice with a subtotal of 300 will have a final total of 100 if a coupon with an amount_off of 200 is applied to it.

operationId: PostCoupons requestBody: content: application/x-www-form-urlencoded: encoding: applies_to: explode: true style: deepObject currency_options: explode: true style: deepObject expand: explode: true style: deepObject metadata: explode: true style: deepObject schema: additionalProperties: false properties: amount_off: description: >- A positive integer representing the amount to subtract from an invoice total (required if `percent_off` is not passed). type: integer applies_to: description: >- A hash containing directions for what this Coupon will apply discounts to. properties: products: items: maxLength: 5000 type: string type: array title: applies_to_params type: object currency: description: >- Three-letter [ISO code for the currency](https://stripe.com/docs/currencies) of the `amount_off` parameter (required if `amount_off` is passed). type: string currency_options: additionalProperties: properties: amount_off: type: integer required: - amount_off title: currency_option type: object description: >- Coupons defined in each available currency option (only supported if `amount_off` is passed). 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). type: object duration: description: >- Specifies how long the discount will be in effect if used on a subscription. Defaults to `once`. enum: - forever - once - repeating type: string x-stripeBypassValidation: true duration_in_months: description: >- Required only if `duration` is `repeating`, in which case it must be a positive integer that specifies the number of months the discount will be in effect. type: integer expand: description: Specifies which fields in the response should be expanded. items: maxLength: 5000 type: string type: array id: description: >- Unique string of your choice that will be used to identify this coupon when applying it to a customer. If you don't want to specify a particular code, you can leave the ID blank and we'll generate a random code for you. maxLength: 5000 type: string max_redemptions: description: >- A positive integer specifying the number of times the coupon can be redeemed before it's no longer valid. For example, you might have a 50% off coupon that the first 20 readers of your blog can use. type: integer metadata: anyOf: - additionalProperties: type: string type: object - enum: - '' type: string description: >- Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. name: description: >- Name of the coupon displayed to customers on, for instance invoices, or receipts. By default the `id` is shown if `name` is not set. maxLength: 40 type: string percent_off: description: >- A positive float larger than 0, and smaller or equal to 100, that represents the discount the coupon will apply (required if `amount_off` is not passed). type: number redeem_by: description: >- Unix timestamp specifying the last time at which the coupon can be redeemed. After the redeem_by date, the coupon can no longer be applied to new customers. format: unix-time type: integer type: object required: false responses: '200': content: application/json: schema: $ref: '#/components/schemas/coupon' description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. '/v1/coupons/{coupon}': delete: description: >-

You can delete coupons via the coupon management page of the Stripe dashboard. However, deleting a coupon does not affect any customers who have already applied the coupon; it means that new customers can’t redeem the coupon. You can also delete coupons via the API.

operationId: DeleteCouponsCoupon parameters: - in: path name: coupon required: true schema: maxLength: 5000 type: string style: simple requestBody: content: application/x-www-form-urlencoded: encoding: {} schema: additionalProperties: false properties: {} type: object required: false responses: '200': content: application/json: schema: $ref: '#/components/schemas/deleted_coupon' description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. get: description:

Retrieves the coupon with the given ID.

operationId: GetCouponsCoupon parameters: - in: path name: coupon required: true schema: maxLength: 5000 type: string style: simple - description: Specifies which fields in the response should be expanded. explode: true in: query name: expand required: false schema: items: maxLength: 5000 type: string type: array style: deepObject requestBody: content: application/x-www-form-urlencoded: encoding: {} schema: additionalProperties: false properties: {} type: object required: false responses: '200': content: application/json: schema: $ref: '#/components/schemas/coupon' description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. post: description: >-

Updates the metadata of a coupon. Other coupon details (currency, duration, amount_off) are, by design, not editable.

operationId: PostCouponsCoupon parameters: - in: path name: coupon required: true schema: maxLength: 5000 type: string style: simple requestBody: content: application/x-www-form-urlencoded: encoding: currency_options: explode: true style: deepObject expand: explode: true style: deepObject metadata: explode: true style: deepObject schema: additionalProperties: false properties: currency_options: additionalProperties: properties: amount_off: type: integer required: - amount_off title: currency_option type: object description: >- Coupons defined in each available currency option (only supported if the coupon is amount-based). 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). type: object expand: description: Specifies which fields in the response should be expanded. items: maxLength: 5000 type: string type: array metadata: anyOf: - additionalProperties: type: string type: object - enum: - '' type: string description: >- Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. name: description: >- Name of the coupon displayed to customers on, for instance invoices, or receipts. By default the `id` is shown if `name` is not set. maxLength: 40 type: string type: object required: false responses: '200': content: application/json: schema: $ref: '#/components/schemas/coupon' description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. /v1/credit_notes: get: description:

Returns a list of credit notes.

operationId: GetCreditNotes parameters: - description: >- Only return credit notes that were created during the given date interval. explode: true in: query name: created required: false schema: anyOf: - properties: gt: type: integer gte: type: integer lt: type: integer lte: type: integer title: range_query_specs type: object - type: integer style: deepObject - description: >- Only return credit notes for the customer specified by this customer ID. in: query name: customer required: false schema: maxLength: 5000 type: string style: form - description: >- A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. in: query name: ending_before required: false schema: maxLength: 5000 type: string style: form - description: Specifies which fields in the response should be expanded. explode: true in: query name: expand required: false schema: items: maxLength: 5000 type: string type: array style: deepObject - description: >- Only return credit notes for the invoice specified by this invoice ID. in: query name: invoice required: false schema: maxLength: 5000 type: string style: form - description: >- A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. in: query name: limit required: false schema: type: integer style: form - description: >- A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. in: query name: starting_after required: false schema: maxLength: 5000 type: string style: form requestBody: content: application/x-www-form-urlencoded: encoding: {} schema: additionalProperties: false properties: {} type: object required: false responses: '200': content: application/json: schema: description: '' properties: data: items: $ref: '#/components/schemas/credit_note' type: array has_more: description: >- True if this list has another page of items after this one that can be fetched. type: boolean object: description: >- String representing the object's type. Objects of the same type share the same value. Always has the value `list`. enum: - list type: string url: description: The URL where this list can be accessed. maxLength: 5000 type: string required: - data - has_more - object - url title: CreditNotesList type: object x-expandableFields: - data description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. post: description: >-

Issue a credit note to adjust the amount of a finalized invoice. For a status=open invoice, a credit note reduces its amount_due. For a status=paid invoice, a credit note does not affect its amount_due. Instead, it can result in any combination of the following:

  • Refund: create a new refund (using refund_amount) or link an existing refund (using refund).
  • Customer balance credit: credit the customer’s balance (using credit_amount) which will be automatically applied to their next invoice when it’s finalized.
  • Outside of Stripe credit: record the amount that is or will be credited outside of Stripe (using out_of_band_amount).

For post-payment credit notes the sum of the refund, credit and outside of Stripe amounts must equal the credit note total.

You may issue multiple credit notes for an invoice. Each credit note will increment the invoice’s pre_payment_credit_notes_amount or post_payment_credit_notes_amount depending on its status at the time of credit note creation.

operationId: PostCreditNotes requestBody: content: application/x-www-form-urlencoded: encoding: expand: explode: true style: deepObject lines: explode: true style: deepObject metadata: explode: true style: deepObject shipping_cost: explode: true style: deepObject schema: additionalProperties: false properties: amount: description: >- The integer amount in cents (or local equivalent) representing the total amount of the credit note. type: integer credit_amount: description: >- The integer amount in cents (or local equivalent) representing the amount to credit the customer's balance, which will be automatically applied to their next invoice. type: integer effective_at: description: >- The date when this credit note is in effect. Same as `created` unless overwritten. When defined, this value replaces the system-generated 'Date of issue' printed on the credit note PDF. format: unix-time type: integer expand: description: Specifies which fields in the response should be expanded. items: maxLength: 5000 type: string type: array invoice: description: ID of the invoice. maxLength: 5000 type: string lines: description: Line items that make up the credit note. items: properties: amount: type: integer description: maxLength: 5000 type: string invoice_line_item: maxLength: 5000 type: string quantity: type: integer tax_amounts: anyOf: - items: properties: amount: type: integer tax_rate: maxLength: 5000 type: string taxable_amount: type: integer required: - amount - tax_rate - taxable_amount title: tax_amount_with_tax_rate_param type: object type: array - enum: - '' type: string tax_rates: anyOf: - items: maxLength: 5000 type: string type: array - enum: - '' type: string type: enum: - custom_line_item - invoice_line_item type: string unit_amount: type: integer unit_amount_decimal: format: decimal type: string required: - type title: credit_note_line_item_params type: object type: array memo: description: The credit note's memo appears on the credit note PDF. maxLength: 5000 type: string metadata: additionalProperties: type: string description: >- Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. type: object out_of_band_amount: description: >- The integer amount in cents (or local equivalent) representing the amount that is credited outside of Stripe. type: integer reason: description: >- Reason for issuing this credit note, one of `duplicate`, `fraudulent`, `order_change`, or `product_unsatisfactory` enum: - duplicate - fraudulent - order_change - product_unsatisfactory type: string refund: description: ID of an existing refund to link this credit note to. type: string refund_amount: description: >- The integer amount in cents (or local equivalent) representing the amount to refund. If set, a refund will be created for the charge associated with the invoice. type: integer shipping_cost: description: >- When shipping_cost contains the shipping_rate from the invoice, the shipping_cost is included in the credit note. properties: shipping_rate: maxLength: 5000 type: string title: credit_note_shipping_cost type: object required: - invoice type: object required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/credit_note' description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. /v1/credit_notes/preview: get: description:

Get a preview of a credit note without creating it.

operationId: GetCreditNotesPreview parameters: - description: >- The integer amount in cents (or local equivalent) representing the total amount of the credit note. in: query name: amount required: false schema: type: integer style: form - description: >- The integer amount in cents (or local equivalent) representing the amount to credit the customer's balance, which will be automatically applied to their next invoice. in: query name: credit_amount required: false schema: type: integer style: form - description: >- The date when this credit note is in effect. Same as `created` unless overwritten. When defined, this value replaces the system-generated 'Date of issue' printed on the credit note PDF. in: query name: effective_at required: false schema: format: unix-time type: integer style: form - description: Specifies which fields in the response should be expanded. explode: true in: query name: expand required: false schema: items: maxLength: 5000 type: string type: array style: deepObject - description: ID of the invoice. in: query name: invoice required: true schema: maxLength: 5000 type: string style: form - description: Line items that make up the credit note. explode: true in: query name: lines required: false schema: items: properties: amount: type: integer description: maxLength: 5000 type: string invoice_line_item: maxLength: 5000 type: string quantity: type: integer tax_amounts: anyOf: - items: properties: amount: type: integer tax_rate: maxLength: 5000 type: string taxable_amount: type: integer required: - amount - tax_rate - taxable_amount title: tax_amount_with_tax_rate_param type: object type: array - enum: - '' type: string tax_rates: anyOf: - items: maxLength: 5000 type: string type: array - enum: - '' type: string type: enum: - custom_line_item - invoice_line_item type: string unit_amount: type: integer unit_amount_decimal: format: decimal type: string required: - type title: credit_note_line_item_params type: object type: array style: deepObject - description: The credit note's memo appears on the credit note PDF. in: query name: memo required: false schema: maxLength: 5000 type: string style: form - description: >- Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. explode: true in: query name: metadata required: false schema: additionalProperties: type: string type: object style: deepObject - description: >- The integer amount in cents (or local equivalent) representing the amount that is credited outside of Stripe. in: query name: out_of_band_amount required: false schema: type: integer style: form - description: >- Reason for issuing this credit note, one of `duplicate`, `fraudulent`, `order_change`, or `product_unsatisfactory` in: query name: reason required: false schema: enum: - duplicate - fraudulent - order_change - product_unsatisfactory type: string style: form - description: ID of an existing refund to link this credit note to. in: query name: refund required: false schema: type: string style: form - description: >- The integer amount in cents (or local equivalent) representing the amount to refund. If set, a refund will be created for the charge associated with the invoice. in: query name: refund_amount required: false schema: type: integer style: form - description: >- When shipping_cost contains the shipping_rate from the invoice, the shipping_cost is included in the credit note. explode: true in: query name: shipping_cost required: false schema: properties: shipping_rate: maxLength: 5000 type: string title: credit_note_shipping_cost type: object style: deepObject requestBody: content: application/x-www-form-urlencoded: encoding: {} schema: additionalProperties: false properties: {} type: object required: false responses: '200': content: application/json: schema: $ref: '#/components/schemas/credit_note' description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. /v1/credit_notes/preview/lines: get: description: >-

When retrieving a credit note preview, you’ll get a lines property containing the first handful of those items. This URL you can retrieve the full (paginated) list of line items.

operationId: GetCreditNotesPreviewLines parameters: - description: >- The integer amount in cents (or local equivalent) representing the total amount of the credit note. in: query name: amount required: false schema: type: integer style: form - description: >- The integer amount in cents (or local equivalent) representing the amount to credit the customer's balance, which will be automatically applied to their next invoice. in: query name: credit_amount required: false schema: type: integer style: form - description: >- The date when this credit note is in effect. Same as `created` unless overwritten. When defined, this value replaces the system-generated 'Date of issue' printed on the credit note PDF. in: query name: effective_at required: false schema: format: unix-time type: integer style: form - description: >- A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. in: query name: ending_before required: false schema: maxLength: 5000 type: string style: form - description: Specifies which fields in the response should be expanded. explode: true in: query name: expand required: false schema: items: maxLength: 5000 type: string type: array style: deepObject - description: ID of the invoice. in: query name: invoice required: true schema: maxLength: 5000 type: string style: form - description: >- A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. in: query name: limit required: false schema: type: integer style: form - description: Line items that make up the credit note. explode: true in: query name: lines required: false schema: items: properties: amount: type: integer description: maxLength: 5000 type: string invoice_line_item: maxLength: 5000 type: string quantity: type: integer tax_amounts: anyOf: - items: properties: amount: type: integer tax_rate: maxLength: 5000 type: string taxable_amount: type: integer required: - amount - tax_rate - taxable_amount title: tax_amount_with_tax_rate_param type: object type: array - enum: - '' type: string tax_rates: anyOf: - items: maxLength: 5000 type: string type: array - enum: - '' type: string type: enum: - custom_line_item - invoice_line_item type: string unit_amount: type: integer unit_amount_decimal: format: decimal type: string required: - type title: credit_note_line_item_params type: object type: array style: deepObject - description: The credit note's memo appears on the credit note PDF. in: query name: memo required: false schema: maxLength: 5000 type: string style: form - description: >- Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. explode: true in: query name: metadata required: false schema: additionalProperties: type: string type: object style: deepObject - description: >- The integer amount in cents (or local equivalent) representing the amount that is credited outside of Stripe. in: query name: out_of_band_amount required: false schema: type: integer style: form - description: >- Reason for issuing this credit note, one of `duplicate`, `fraudulent`, `order_change`, or `product_unsatisfactory` in: query name: reason required: false schema: enum: - duplicate - fraudulent - order_change - product_unsatisfactory type: string style: form - description: ID of an existing refund to link this credit note to. in: query name: refund required: false schema: type: string style: form - description: >- The integer amount in cents (or local equivalent) representing the amount to refund. If set, a refund will be created for the charge associated with the invoice. in: query name: refund_amount required: false schema: type: integer style: form - description: >- When shipping_cost contains the shipping_rate from the invoice, the shipping_cost is included in the credit note. explode: true in: query name: shipping_cost required: false schema: properties: shipping_rate: maxLength: 5000 type: string title: credit_note_shipping_cost type: object style: deepObject - description: >- A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. in: query name: starting_after required: false schema: maxLength: 5000 type: string style: form requestBody: content: application/x-www-form-urlencoded: encoding: {} schema: additionalProperties: false properties: {} type: object required: false responses: '200': content: application/json: schema: description: '' properties: data: description: Details about each object. items: $ref: '#/components/schemas/credit_note_line_item' type: array has_more: description: >- True if this list has another page of items after this one that can be fetched. type: boolean object: description: >- String representing the object's type. Objects of the same type share the same value. Always has the value `list`. enum: - list type: string url: description: The URL where this list can be accessed. maxLength: 5000 type: string required: - data - has_more - object - url title: CreditNoteLinesList type: object x-expandableFields: - data description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. '/v1/credit_notes/{credit_note}/lines': get: description: >-

When retrieving a credit note, you’ll get a lines property containing the the first handful of those items. There is also a URL where you can retrieve the full (paginated) list of line items.

operationId: GetCreditNotesCreditNoteLines parameters: - in: path name: credit_note required: true schema: maxLength: 5000 type: string style: simple - description: >- A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. in: query name: ending_before required: false schema: maxLength: 5000 type: string style: form - description: Specifies which fields in the response should be expanded. explode: true in: query name: expand required: false schema: items: maxLength: 5000 type: string type: array style: deepObject - description: >- A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. in: query name: limit required: false schema: type: integer style: form - description: >- A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. in: query name: starting_after required: false schema: maxLength: 5000 type: string style: form requestBody: content: application/x-www-form-urlencoded: encoding: {} schema: additionalProperties: false properties: {} type: object required: false responses: '200': content: application/json: schema: description: '' properties: data: description: Details about each object. items: $ref: '#/components/schemas/credit_note_line_item' type: array has_more: description: >- True if this list has another page of items after this one that can be fetched. type: boolean object: description: >- String representing the object's type. Objects of the same type share the same value. Always has the value `list`. enum: - list type: string url: description: The URL where this list can be accessed. maxLength: 5000 type: string required: - data - has_more - object - url title: CreditNoteLinesList type: object x-expandableFields: - data description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. '/v1/credit_notes/{id}': get: description:

Retrieves the credit note object with the given identifier.

operationId: GetCreditNotesId parameters: - description: Specifies which fields in the response should be expanded. explode: true in: query name: expand required: false schema: items: maxLength: 5000 type: string type: array style: deepObject - in: path name: id required: true schema: maxLength: 5000 type: string style: simple requestBody: content: application/x-www-form-urlencoded: encoding: {} schema: additionalProperties: false properties: {} type: object required: false responses: '200': content: application/json: schema: $ref: '#/components/schemas/credit_note' description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. post: description:

Updates an existing credit note.

operationId: PostCreditNotesId parameters: - in: path name: id required: true schema: maxLength: 5000 type: string style: simple requestBody: content: application/x-www-form-urlencoded: encoding: expand: explode: true style: deepObject metadata: explode: true style: deepObject schema: additionalProperties: false properties: expand: description: Specifies which fields in the response should be expanded. items: maxLength: 5000 type: string type: array memo: description: Credit note memo. maxLength: 5000 type: string metadata: additionalProperties: type: string description: >- Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. type: object type: object required: false responses: '200': content: application/json: schema: $ref: '#/components/schemas/credit_note' description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. '/v1/credit_notes/{id}/void': post: description: >-

Marks a credit note as void. Learn more about voiding credit notes.

operationId: PostCreditNotesIdVoid parameters: - in: path name: id required: true schema: maxLength: 5000 type: string style: simple requestBody: content: application/x-www-form-urlencoded: encoding: expand: explode: true style: deepObject schema: additionalProperties: false properties: expand: description: Specifies which fields in the response should be expanded. items: maxLength: 5000 type: string type: array type: object required: false responses: '200': content: application/json: schema: $ref: '#/components/schemas/credit_note' description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. /v1/customer_sessions: post: description: >-

Creates a customer session object that includes a single-use client secret that you can use on your front-end to grant client-side API access for certain customer resources.

operationId: PostCustomerSessions requestBody: content: application/x-www-form-urlencoded: encoding: components: explode: true style: deepObject expand: explode: true style: deepObject schema: additionalProperties: false properties: components: description: >- Configuration for each component. Exactly 1 component must be enabled. properties: buy_button: properties: enabled: type: boolean required: - enabled title: buy_button_param type: object pricing_table: properties: enabled: type: boolean required: - enabled title: pricing_table_param type: object title: components type: object customer: description: >- The ID of an existing customer for which to create the customer session. maxLength: 5000 type: string expand: description: Specifies which fields in the response should be expanded. items: maxLength: 5000 type: string type: array required: - components - customer type: object required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/customer_session' description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. /v1/customers: get: description: >-

Returns a list of your customers. The customers are returned sorted by creation date, with the most recent customers appearing first.

operationId: GetCustomers parameters: - description: >- Only return customers that were created during the given date interval. explode: true in: query name: created required: false schema: anyOf: - properties: gt: type: integer gte: type: integer lt: type: integer lte: type: integer title: range_query_specs type: object - type: integer style: deepObject - description: >- A case-sensitive filter on the list based on the customer's `email` field. The value must be a string. in: query name: email required: false schema: maxLength: 512 type: string style: form - description: >- A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. in: query name: ending_before required: false schema: maxLength: 5000 type: string style: form - description: Specifies which fields in the response should be expanded. explode: true in: query name: expand required: false schema: items: maxLength: 5000 type: string type: array style: deepObject - description: >- A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. in: query name: limit required: false schema: type: integer style: form - description: >- A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. in: query name: starting_after required: false schema: maxLength: 5000 type: string style: form - description: >- Provides a list of customers that are associated with the specified test clock. The response will not include customers with test clocks if this parameter is not set. in: query name: test_clock required: false schema: maxLength: 5000 type: string style: form requestBody: content: application/x-www-form-urlencoded: encoding: {} schema: additionalProperties: false properties: {} type: object required: false responses: '200': content: application/json: schema: description: '' properties: data: items: $ref: '#/components/schemas/customer' type: array has_more: description: >- True if this list has another page of items after this one that can be fetched. type: boolean object: description: >- String representing the object's type. Objects of the same type share the same value. Always has the value `list`. enum: - list type: string url: description: The URL where this list can be accessed. maxLength: 5000 pattern: ^/v1/customers type: string required: - data - has_more - object - url title: CustomerResourceCustomerList type: object x-expandableFields: - data description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. post: description:

Creates a new customer object.

operationId: PostCustomers requestBody: content: application/x-www-form-urlencoded: encoding: address: explode: true style: deepObject cash_balance: explode: true style: deepObject expand: explode: true style: deepObject invoice_settings: explode: true style: deepObject metadata: explode: true style: deepObject preferred_locales: explode: true style: deepObject shipping: explode: true style: deepObject tax: explode: true style: deepObject tax_id_data: explode: true style: deepObject schema: additionalProperties: false properties: address: anyOf: - properties: city: maxLength: 5000 type: string country: maxLength: 5000 type: string line1: maxLength: 5000 type: string line2: maxLength: 5000 type: string postal_code: maxLength: 5000 type: string state: maxLength: 5000 type: string title: optional_fields_address type: object - enum: - '' type: string description: The customer's address. balance: description: >- An integer amount in cents (or local equivalent) that represents the customer's current balance, which affect the customer's future invoices. A negative amount represents a credit that decreases the amount due on an invoice; a positive amount increases the amount due on an invoice. type: integer cash_balance: description: >- Balance information and default balance settings for this customer. properties: settings: properties: reconciliation_mode: enum: - automatic - manual - merchant_default type: string title: balance_settings_param type: object title: cash_balance_param type: object coupon: maxLength: 5000 type: string description: description: >- An arbitrary string that you can attach to a customer object. It is displayed alongside the customer in the dashboard. maxLength: 5000 type: string email: description: >- Customer's email address. It's displayed alongside the customer in your dashboard and can be useful for searching and tracking. This may be up to *512 characters*. maxLength: 512 type: string expand: description: Specifies which fields in the response should be expanded. items: maxLength: 5000 type: string type: array invoice_prefix: description: >- The prefix for the customer used to generate unique invoice numbers. Must be 3–12 uppercase letters or numbers. maxLength: 5000 type: string invoice_settings: description: Default invoice settings for this customer. properties: custom_fields: anyOf: - items: properties: name: maxLength: 40 type: string value: maxLength: 140 type: string required: - name - value title: custom_field_params type: object type: array - enum: - '' type: string default_payment_method: maxLength: 5000 type: string footer: maxLength: 5000 type: string rendering_options: anyOf: - properties: amount_tax_display: enum: - '' - exclude_tax - include_inclusive_tax type: string title: customer_rendering_options_param type: object - enum: - '' type: string title: customer_param type: object metadata: anyOf: - additionalProperties: type: string type: object - enum: - '' type: string description: >- Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. name: description: The customer's full name or business name. maxLength: 256 type: string next_invoice_sequence: description: >- The sequence to be used on the customer's next invoice. Defaults to 1. type: integer payment_method: maxLength: 5000 type: string phone: description: The customer's phone number. maxLength: 20 type: string preferred_locales: description: 'Customer''s preferred languages, ordered by preference.' items: maxLength: 5000 type: string type: array promotion_code: description: >- The ID of a promotion code to apply to the customer. The customer will have a discount applied on all recurring payments. Charges you create through the API will not have the discount. maxLength: 5000 type: string shipping: anyOf: - properties: address: properties: city: maxLength: 5000 type: string country: maxLength: 5000 type: string line1: maxLength: 5000 type: string line2: maxLength: 5000 type: string postal_code: maxLength: 5000 type: string state: maxLength: 5000 type: string title: optional_fields_address type: object name: maxLength: 5000 type: string phone: maxLength: 5000 type: string required: - address - name title: customer_shipping type: object - enum: - '' type: string description: >- The customer's shipping information. Appears on invoices emailed to this customer. source: maxLength: 5000 type: string x-stripeBypassValidation: true tax: description: Tax details about the customer. properties: ip_address: anyOf: - type: string - enum: - '' type: string validate_location: enum: - deferred - immediately type: string title: tax_param type: object tax_exempt: description: >- The customer's tax exemption. One of `none`, `exempt`, or `reverse`. enum: - '' - exempt - none - reverse type: string tax_id_data: description: The customer's tax IDs. items: properties: type: enum: - ad_nrt - ae_trn - ar_cuit - au_abn - au_arn - bg_uic - bh_vat - bo_tin - br_cnpj - br_cpf - ca_bn - ca_gst_hst - ca_pst_bc - ca_pst_mb - ca_pst_sk - ca_qst - ch_vat - cl_tin - cn_tin - co_nit - cr_tin - do_rcn - ec_ruc - eg_tin - es_cif - eu_oss_vat - eu_vat - gb_vat - ge_vat - hk_br - hu_tin - id_npwp - il_vat - in_gst - is_vat - jp_cn - jp_rn - jp_trn - ke_pin - kr_brn - kz_bin - li_uid - mx_rfc - my_frp - my_itn - my_sst - ng_tin - no_vat - no_voec - nz_gst - om_vat - pe_ruc - ph_tin - ro_tin - rs_pib - ru_inn - ru_kpp - sa_vat - sg_gst - sg_uen - si_tin - sv_nit - th_vat - tr_tin - tw_vat - ua_vat - us_ein - uy_ruc - ve_rif - vn_tin - za_vat maxLength: 5000 type: string x-stripeBypassValidation: true value: type: string required: - type - value title: data_params type: object type: array test_clock: description: ID of the test clock to attach to the customer. maxLength: 5000 type: string type: object required: false responses: '200': content: application/json: schema: $ref: '#/components/schemas/customer' description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. /v1/customers/search: get: description: >-

Search for customers you’ve previously created using Stripe’s Search Query Language. Don’t use search in read-after-write flows where strict consistency is necessary. Under normal operating conditions, data is searchable in less than a minute. Occasionally, propagation of new or updated data can be up to an hour behind during outages. Search functionality is not available to merchants in India.

operationId: GetCustomersSearch parameters: - description: Specifies which fields in the response should be expanded. explode: true in: query name: expand required: false schema: items: maxLength: 5000 type: string type: array style: deepObject - description: >- A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. in: query name: limit required: false schema: type: integer style: form - description: >- A cursor for pagination across multiple pages of results. Don't include this parameter on the first call. Use the next_page value returned in a previous response to request subsequent results. in: query name: page required: false schema: maxLength: 5000 type: string style: form - description: >- The search query string. See [search query language](https://stripe.com/docs/search#search-query-language) and the list of supported [query fields for customers](https://stripe.com/docs/search#query-fields-for-customers). in: query name: query required: true schema: maxLength: 5000 type: string style: form requestBody: content: application/x-www-form-urlencoded: encoding: {} schema: additionalProperties: false properties: {} type: object required: false responses: '200': content: application/json: schema: description: '' properties: data: items: $ref: '#/components/schemas/customer' type: array has_more: type: boolean next_page: maxLength: 5000 nullable: true type: string object: description: >- String representing the object's type. Objects of the same type share the same value. enum: - search_result type: string total_count: description: >- The total number of objects that match the query, only accurate up to 10,000. type: integer url: maxLength: 5000 type: string required: - data - has_more - object - url title: SearchResult type: object x-expandableFields: - data description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. '/v1/customers/{customer}': delete: description: >-

Permanently deletes a customer. It cannot be undone. Also immediately cancels any active subscriptions on the customer.

operationId: DeleteCustomersCustomer parameters: - in: path name: customer required: true schema: maxLength: 5000 type: string style: simple requestBody: content: application/x-www-form-urlencoded: encoding: {} schema: additionalProperties: false properties: {} type: object required: false responses: '200': content: application/json: schema: $ref: '#/components/schemas/deleted_customer' description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. get: description:

Retrieves a Customer object.

operationId: GetCustomersCustomer parameters: - in: path name: customer required: true schema: maxLength: 5000 type: string style: simple - description: Specifies which fields in the response should be expanded. explode: true in: query name: expand required: false schema: items: maxLength: 5000 type: string type: array style: deepObject requestBody: content: application/x-www-form-urlencoded: encoding: {} schema: additionalProperties: false properties: {} type: object required: false responses: '200': content: application/json: schema: anyOf: - $ref: '#/components/schemas/customer' - $ref: '#/components/schemas/deleted_customer' description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. post: description: >-

Updates the specified customer by setting the values of the parameters passed. Any parameters not provided will be left unchanged. For example, if you pass the source parameter, that becomes the customer’s active source (e.g., a card) to be used for all charges in the future. When you update a customer to a new valid card source by passing the source parameter: for each of the customer’s current subscriptions, if the subscription bills automatically and is in the past_due state, then the latest open invoice for the subscription with automatic collection enabled will be retried. This retry will not count as an automatic retry, and will not affect the next regularly scheduled payment for the invoice. Changing the default_source for a customer will not trigger this behavior.

This request accepts mostly the same arguments as the customer creation call.

operationId: PostCustomersCustomer parameters: - in: path name: customer required: true schema: maxLength: 5000 type: string style: simple requestBody: content: application/x-www-form-urlencoded: encoding: address: explode: true style: deepObject bank_account: explode: true style: deepObject card: explode: true style: deepObject cash_balance: explode: true style: deepObject expand: explode: true style: deepObject invoice_settings: explode: true style: deepObject metadata: explode: true style: deepObject preferred_locales: explode: true style: deepObject shipping: explode: true style: deepObject tax: explode: true style: deepObject schema: additionalProperties: false properties: address: anyOf: - properties: city: maxLength: 5000 type: string country: maxLength: 5000 type: string line1: maxLength: 5000 type: string line2: maxLength: 5000 type: string postal_code: maxLength: 5000 type: string state: maxLength: 5000 type: string title: optional_fields_address type: object - enum: - '' type: string description: The customer's address. balance: description: >- An integer amount in cents (or local equivalent) that represents the customer's current balance, which affect the customer's future invoices. A negative amount represents a credit that decreases the amount due on an invoice; a positive amount increases the amount due on an invoice. type: integer bank_account: anyOf: - properties: account_holder_name: maxLength: 5000 type: string account_holder_type: enum: - company - individual maxLength: 5000 type: string account_number: maxLength: 5000 type: string country: maxLength: 5000 type: string currency: type: string object: enum: - bank_account maxLength: 5000 type: string routing_number: maxLength: 5000 type: string required: - account_number - country title: customer_payment_source_bank_account type: object - maxLength: 5000 type: string description: >- Either a token, like the ones returned by [Stripe.js](https://stripe.com/docs/js), or a dictionary containing a user's bank account details. card: anyOf: - properties: address_city: maxLength: 5000 type: string address_country: maxLength: 5000 type: string address_line1: maxLength: 5000 type: string address_line2: maxLength: 5000 type: string address_state: maxLength: 5000 type: string address_zip: maxLength: 5000 type: string cvc: maxLength: 5000 type: string exp_month: type: integer exp_year: type: integer metadata: additionalProperties: type: string type: object name: maxLength: 5000 type: string number: maxLength: 5000 type: string object: enum: - card maxLength: 5000 type: string required: - exp_month - exp_year - number title: customer_payment_source_card type: object - maxLength: 5000 type: string description: >- A token, like the ones returned by [Stripe.js](https://stripe.com/docs/js). x-stripeBypassValidation: true cash_balance: description: >- Balance information and default balance settings for this customer. properties: settings: properties: reconciliation_mode: enum: - automatic - manual - merchant_default type: string title: balance_settings_param type: object title: cash_balance_param type: object coupon: maxLength: 5000 type: string default_alipay_account: description: >- ID of Alipay account to make the customer's new default for invoice payments. maxLength: 500 type: string default_bank_account: description: >- ID of bank account to make the customer's new default for invoice payments. maxLength: 500 type: string default_card: description: >- ID of card to make the customer's new default for invoice payments. maxLength: 500 type: string default_source: description: >- If you are using payment methods created via the PaymentMethods API, see the [invoice_settings.default_payment_method](https://stripe.com/docs/api/customers/update#update_customer-invoice_settings-default_payment_method) parameter. Provide the ID of a payment source already attached to this customer to make it this customer's default payment source. If you want to add a new payment source and make it the default, see the [source](https://stripe.com/docs/api/customers/update#update_customer-source) property. maxLength: 500 type: string description: description: >- An arbitrary string that you can attach to a customer object. It is displayed alongside the customer in the dashboard. maxLength: 5000 type: string email: description: >- Customer's email address. It's displayed alongside the customer in your dashboard and can be useful for searching and tracking. This may be up to *512 characters*. maxLength: 512 type: string expand: description: Specifies which fields in the response should be expanded. items: maxLength: 5000 type: string type: array invoice_prefix: description: >- The prefix for the customer used to generate unique invoice numbers. Must be 3–12 uppercase letters or numbers. maxLength: 5000 type: string invoice_settings: description: Default invoice settings for this customer. properties: custom_fields: anyOf: - items: properties: name: maxLength: 40 type: string value: maxLength: 140 type: string required: - name - value title: custom_field_params type: object type: array - enum: - '' type: string default_payment_method: maxLength: 5000 type: string footer: maxLength: 5000 type: string rendering_options: anyOf: - properties: amount_tax_display: enum: - '' - exclude_tax - include_inclusive_tax type: string title: customer_rendering_options_param type: object - enum: - '' type: string title: customer_param type: object metadata: anyOf: - additionalProperties: type: string type: object - enum: - '' type: string description: >- Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. name: description: The customer's full name or business name. maxLength: 256 type: string next_invoice_sequence: description: >- The sequence to be used on the customer's next invoice. Defaults to 1. type: integer phone: description: The customer's phone number. maxLength: 20 type: string preferred_locales: description: 'Customer''s preferred languages, ordered by preference.' items: maxLength: 5000 type: string type: array promotion_code: description: >- The ID of a promotion code to apply to the customer. The customer will have a discount applied on all recurring payments. Charges you create through the API will not have the discount. maxLength: 5000 type: string shipping: anyOf: - properties: address: properties: city: maxLength: 5000 type: string country: maxLength: 5000 type: string line1: maxLength: 5000 type: string line2: maxLength: 5000 type: string postal_code: maxLength: 5000 type: string state: maxLength: 5000 type: string title: optional_fields_address type: object name: maxLength: 5000 type: string phone: maxLength: 5000 type: string required: - address - name title: customer_shipping type: object - enum: - '' type: string description: >- The customer's shipping information. Appears on invoices emailed to this customer. source: maxLength: 5000 type: string x-stripeBypassValidation: true tax: description: Tax details about the customer. properties: ip_address: anyOf: - type: string - enum: - '' type: string validate_location: enum: - deferred - immediately type: string title: tax_param type: object tax_exempt: description: >- The customer's tax exemption. One of `none`, `exempt`, or `reverse`. enum: - '' - exempt - none - reverse type: string type: object required: false responses: '200': content: application/json: schema: $ref: '#/components/schemas/customer' description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. '/v1/customers/{customer}/balance_transactions': get: description: >-

Returns a list of transactions that updated the customer’s balances.

operationId: GetCustomersCustomerBalanceTransactions parameters: - in: path name: customer required: true schema: maxLength: 5000 type: string style: simple - description: >- A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. in: query name: ending_before required: false schema: maxLength: 5000 type: string style: form - description: Specifies which fields in the response should be expanded. explode: true in: query name: expand required: false schema: items: maxLength: 5000 type: string type: array style: deepObject - description: >- A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. in: query name: limit required: false schema: type: integer style: form - description: >- A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. in: query name: starting_after required: false schema: maxLength: 5000 type: string style: form requestBody: content: application/x-www-form-urlencoded: encoding: {} schema: additionalProperties: false properties: {} type: object required: false responses: '200': content: application/json: schema: description: '' properties: data: description: Details about each object. items: $ref: '#/components/schemas/customer_balance_transaction' type: array has_more: description: >- True if this list has another page of items after this one that can be fetched. type: boolean object: description: >- String representing the object's type. Objects of the same type share the same value. Always has the value `list`. enum: - list type: string url: description: The URL where this list can be accessed. maxLength: 5000 type: string required: - data - has_more - object - url title: CustomerBalanceTransactionList type: object x-expandableFields: - data description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. post: description: >-

Creates an immutable transaction that updates the customer’s credit balance.

operationId: PostCustomersCustomerBalanceTransactions parameters: - in: path name: customer required: true schema: maxLength: 5000 type: string style: simple requestBody: content: application/x-www-form-urlencoded: encoding: expand: explode: true style: deepObject metadata: explode: true style: deepObject schema: additionalProperties: false properties: amount: description: >- The integer amount in **cents (or local equivalent)** to apply to the customer's credit balance. type: integer currency: description: >- 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). Specifies the [`invoice_credit_balance`](https://stripe.com/docs/api/customers/object#customer_object-invoice_credit_balance) that this transaction will apply to. If the customer's `currency` is not set, it will be updated to this value. type: string description: description: >- An arbitrary string attached to the object. Often useful for displaying to users. maxLength: 350 type: string expand: description: Specifies which fields in the response should be expanded. items: maxLength: 5000 type: string type: array metadata: anyOf: - additionalProperties: type: string type: object - enum: - '' type: string description: >- Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. required: - amount - currency type: object required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/customer_balance_transaction' description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. '/v1/customers/{customer}/balance_transactions/{transaction}': get: description: >-

Retrieves a specific customer balance transaction that updated the customer’s balances.

operationId: GetCustomersCustomerBalanceTransactionsTransaction parameters: - in: path name: customer required: true schema: maxLength: 5000 type: string style: simple - description: Specifies which fields in the response should be expanded. explode: true in: query name: expand required: false schema: items: maxLength: 5000 type: string type: array style: deepObject - in: path name: transaction required: true schema: type: string style: simple requestBody: content: application/x-www-form-urlencoded: encoding: {} schema: additionalProperties: false properties: {} type: object required: false responses: '200': content: application/json: schema: $ref: '#/components/schemas/customer_balance_transaction' description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. post: description: >-

Most credit balance transaction fields are immutable, but you may update its description and metadata.

operationId: PostCustomersCustomerBalanceTransactionsTransaction parameters: - in: path name: customer required: true schema: maxLength: 5000 type: string style: simple - in: path name: transaction required: true schema: maxLength: 5000 type: string style: simple requestBody: content: application/x-www-form-urlencoded: encoding: expand: explode: true style: deepObject metadata: explode: true style: deepObject schema: additionalProperties: false properties: description: description: >- An arbitrary string attached to the object. Often useful for displaying to users. maxLength: 350 type: string expand: description: Specifies which fields in the response should be expanded. items: maxLength: 5000 type: string type: array metadata: anyOf: - additionalProperties: type: string type: object - enum: - '' type: string description: >- Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. type: object required: false responses: '200': content: application/json: schema: $ref: '#/components/schemas/customer_balance_transaction' description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. '/v1/customers/{customer}/bank_accounts': get: deprecated: true description: >-

You can see a list of the bank accounts belonging to a Customer. Note that the 10 most recent sources are always available by default on the Customer. If you need more than those 10, you can use this API method and the limit and starting_after parameters to page through additional bank accounts.

operationId: GetCustomersCustomerBankAccounts parameters: - in: path name: customer required: true schema: maxLength: 5000 type: string style: simple - description: >- A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. in: query name: ending_before required: false schema: type: string style: form - description: Specifies which fields in the response should be expanded. explode: true in: query name: expand required: false schema: items: maxLength: 5000 type: string type: array style: deepObject - description: >- A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. in: query name: limit required: false schema: type: integer style: form - description: >- A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. in: query name: starting_after required: false schema: type: string style: form requestBody: content: application/x-www-form-urlencoded: encoding: {} schema: additionalProperties: false properties: {} type: object required: false responses: '200': content: application/json: schema: description: '' properties: data: description: Details about each object. items: $ref: '#/components/schemas/bank_account' type: array has_more: description: >- True if this list has another page of items after this one that can be fetched. type: boolean object: description: >- String representing the object's type. Objects of the same type share the same value. Always has the value `list`. enum: - list type: string url: description: The URL where this list can be accessed. maxLength: 5000 type: string required: - data - has_more - object - url title: BankAccountList type: object x-expandableFields: - data description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. post: description: >-

When you create a new credit card, you must specify a customer or recipient on which to create it.

If the card’s owner has no default card, then the new card will become the default. However, if the owner already has a default, then it will not change. To change the default, you should update the customer to have a new default_source.

operationId: PostCustomersCustomerBankAccounts parameters: - in: path name: customer required: true schema: maxLength: 5000 type: string style: simple requestBody: content: application/x-www-form-urlencoded: encoding: bank_account: explode: true style: deepObject card: explode: true style: deepObject expand: explode: true style: deepObject metadata: explode: true style: deepObject schema: additionalProperties: false properties: alipay_account: description: >- A token returned by [Stripe.js](https://stripe.com/docs/js) representing the user’s Alipay account details. maxLength: 5000 type: string bank_account: anyOf: - properties: account_holder_name: maxLength: 5000 type: string account_holder_type: enum: - company - individual maxLength: 5000 type: string account_number: maxLength: 5000 type: string country: maxLength: 5000 type: string currency: type: string object: enum: - bank_account maxLength: 5000 type: string routing_number: maxLength: 5000 type: string required: - account_number - country title: customer_payment_source_bank_account type: object - maxLength: 5000 type: string description: >- Either a token, like the ones returned by [Stripe.js](https://stripe.com/docs/js), or a dictionary containing a user's bank account details. card: anyOf: - properties: address_city: maxLength: 5000 type: string address_country: maxLength: 5000 type: string address_line1: maxLength: 5000 type: string address_line2: maxLength: 5000 type: string address_state: maxLength: 5000 type: string address_zip: maxLength: 5000 type: string cvc: maxLength: 5000 type: string exp_month: type: integer exp_year: type: integer metadata: additionalProperties: type: string type: object name: maxLength: 5000 type: string number: maxLength: 5000 type: string object: enum: - card maxLength: 5000 type: string required: - exp_month - exp_year - number title: customer_payment_source_card type: object - maxLength: 5000 type: string description: >- A token, like the ones returned by [Stripe.js](https://stripe.com/docs/js). x-stripeBypassValidation: true expand: description: Specifies which fields in the response should be expanded. items: maxLength: 5000 type: string type: array metadata: additionalProperties: type: string description: >- Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. type: object source: description: >- Please refer to full [documentation](https://stripe.com/docs/api) instead. maxLength: 5000 type: string x-stripeBypassValidation: true type: object required: false responses: '200': content: application/json: schema: $ref: '#/components/schemas/payment_source' description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. '/v1/customers/{customer}/bank_accounts/{id}': delete: description:

Delete a specified source for a given customer.

operationId: DeleteCustomersCustomerBankAccountsId parameters: - in: path name: customer required: true schema: maxLength: 5000 type: string style: simple - in: path name: id required: true schema: type: string style: simple requestBody: content: application/x-www-form-urlencoded: encoding: expand: explode: true style: deepObject schema: additionalProperties: false properties: expand: description: Specifies which fields in the response should be expanded. items: maxLength: 5000 type: string type: array type: object required: false responses: '200': content: application/json: schema: anyOf: - $ref: '#/components/schemas/payment_source' - $ref: '#/components/schemas/deleted_payment_source' description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. get: deprecated: true description: >-

By default, you can see the 10 most recent sources stored on a Customer directly on the object, but you can also retrieve details about a specific bank account stored on the Stripe account.

operationId: GetCustomersCustomerBankAccountsId parameters: - in: path name: customer required: true schema: maxLength: 5000 type: string style: simple - description: Specifies which fields in the response should be expanded. explode: true in: query name: expand required: false schema: items: maxLength: 5000 type: string type: array style: deepObject - in: path name: id required: true schema: maxLength: 5000 type: string style: simple requestBody: content: application/x-www-form-urlencoded: encoding: {} schema: additionalProperties: false properties: {} type: object required: false responses: '200': content: application/json: schema: $ref: '#/components/schemas/bank_account' description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. post: description:

Update a specified source for a given customer.

operationId: PostCustomersCustomerBankAccountsId parameters: - in: path name: customer required: true schema: maxLength: 5000 type: string style: simple - in: path name: id required: true schema: maxLength: 5000 type: string style: simple requestBody: content: application/x-www-form-urlencoded: encoding: expand: explode: true style: deepObject metadata: explode: true style: deepObject owner: explode: true style: deepObject schema: additionalProperties: false properties: account_holder_name: description: >- The name of the person or business that owns the bank account. maxLength: 5000 type: string account_holder_type: description: >- The type of entity that holds the account. This can be either `individual` or `company`. enum: - company - individual maxLength: 5000 type: string address_city: description: City/District/Suburb/Town/Village. maxLength: 5000 type: string address_country: description: 'Billing address country, if provided when creating card.' maxLength: 5000 type: string address_line1: description: Address line 1 (Street address/PO Box/Company name). maxLength: 5000 type: string address_line2: description: Address line 2 (Apartment/Suite/Unit/Building). maxLength: 5000 type: string address_state: description: State/County/Province/Region. maxLength: 5000 type: string address_zip: description: ZIP or postal code. maxLength: 5000 type: string exp_month: description: Two digit number representing the card’s expiration month. maxLength: 5000 type: string exp_year: description: Four digit number representing the card’s expiration year. maxLength: 5000 type: string expand: description: Specifies which fields in the response should be expanded. items: maxLength: 5000 type: string type: array metadata: anyOf: - additionalProperties: type: string type: object - enum: - '' type: string description: >- Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. name: description: Cardholder name. maxLength: 5000 type: string owner: properties: address: properties: city: maxLength: 5000 type: string country: maxLength: 5000 type: string line1: maxLength: 5000 type: string line2: maxLength: 5000 type: string postal_code: maxLength: 5000 type: string state: maxLength: 5000 type: string title: source_address type: object email: type: string name: maxLength: 5000 type: string phone: maxLength: 5000 type: string title: owner type: object type: object required: false responses: '200': content: application/json: schema: anyOf: - $ref: '#/components/schemas/card' - $ref: '#/components/schemas/bank_account' - $ref: '#/components/schemas/source' description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. '/v1/customers/{customer}/bank_accounts/{id}/verify': post: description:

Verify a specified bank account for a given customer.

operationId: PostCustomersCustomerBankAccountsIdVerify parameters: - in: path name: customer required: true schema: maxLength: 5000 type: string style: simple - in: path name: id required: true schema: maxLength: 5000 type: string style: simple requestBody: content: application/x-www-form-urlencoded: encoding: amounts: explode: true style: deepObject expand: explode: true style: deepObject schema: additionalProperties: false properties: amounts: description: >- Two positive integers, in *cents*, equal to the values of the microdeposits sent to the bank account. items: type: integer type: array expand: description: Specifies which fields in the response should be expanded. items: maxLength: 5000 type: string type: array type: object required: false responses: '200': content: application/json: schema: $ref: '#/components/schemas/bank_account' description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. '/v1/customers/{customer}/cards': get: deprecated: true description: >-

You can see a list of the cards belonging to a customer. Note that the 10 most recent sources are always available on the Customer object. If you need more than those 10, you can use this API method and the limit and starting_after parameters to page through additional cards.

operationId: GetCustomersCustomerCards parameters: - in: path name: customer required: true schema: maxLength: 5000 type: string style: simple - description: >- A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. in: query name: ending_before required: false schema: type: string style: form - description: Specifies which fields in the response should be expanded. explode: true in: query name: expand required: false schema: items: maxLength: 5000 type: string type: array style: deepObject - description: >- A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. in: query name: limit required: false schema: type: integer style: form - description: >- A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. in: query name: starting_after required: false schema: type: string style: form requestBody: content: application/x-www-form-urlencoded: encoding: {} schema: additionalProperties: false properties: {} type: object required: false responses: '200': content: application/json: schema: description: '' properties: data: items: $ref: '#/components/schemas/card' type: array has_more: description: >- True if this list has another page of items after this one that can be fetched. type: boolean object: description: >- String representing the object's type. Objects of the same type share the same value. Always has the value `list`. enum: - list type: string url: description: The URL where this list can be accessed. maxLength: 5000 type: string required: - data - has_more - object - url title: CardList type: object x-expandableFields: - data description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. post: description: >-

When you create a new credit card, you must specify a customer or recipient on which to create it.

If the card’s owner has no default card, then the new card will become the default. However, if the owner already has a default, then it will not change. To change the default, you should update the customer to have a new default_source.

operationId: PostCustomersCustomerCards parameters: - in: path name: customer required: true schema: maxLength: 5000 type: string style: simple requestBody: content: application/x-www-form-urlencoded: encoding: bank_account: explode: true style: deepObject card: explode: true style: deepObject expand: explode: true style: deepObject metadata: explode: true style: deepObject schema: additionalProperties: false properties: alipay_account: description: >- A token returned by [Stripe.js](https://stripe.com/docs/js) representing the user’s Alipay account details. maxLength: 5000 type: string bank_account: anyOf: - properties: account_holder_name: maxLength: 5000 type: string account_holder_type: enum: - company - individual maxLength: 5000 type: string account_number: maxLength: 5000 type: string country: maxLength: 5000 type: string currency: type: string object: enum: - bank_account maxLength: 5000 type: string routing_number: maxLength: 5000 type: string required: - account_number - country title: customer_payment_source_bank_account type: object - maxLength: 5000 type: string description: >- Either a token, like the ones returned by [Stripe.js](https://stripe.com/docs/js), or a dictionary containing a user's bank account details. card: anyOf: - properties: address_city: maxLength: 5000 type: string address_country: maxLength: 5000 type: string address_line1: maxLength: 5000 type: string address_line2: maxLength: 5000 type: string address_state: maxLength: 5000 type: string address_zip: maxLength: 5000 type: string cvc: maxLength: 5000 type: string exp_month: type: integer exp_year: type: integer metadata: additionalProperties: type: string type: object name: maxLength: 5000 type: string number: maxLength: 5000 type: string object: enum: - card maxLength: 5000 type: string required: - exp_month - exp_year - number title: customer_payment_source_card type: object - maxLength: 5000 type: string description: >- A token, like the ones returned by [Stripe.js](https://stripe.com/docs/js). x-stripeBypassValidation: true expand: description: Specifies which fields in the response should be expanded. items: maxLength: 5000 type: string type: array metadata: additionalProperties: type: string description: >- Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. type: object source: description: >- Please refer to full [documentation](https://stripe.com/docs/api) instead. maxLength: 5000 type: string x-stripeBypassValidation: true type: object required: false responses: '200': content: application/json: schema: $ref: '#/components/schemas/payment_source' description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. '/v1/customers/{customer}/cards/{id}': delete: description:

Delete a specified source for a given customer.

operationId: DeleteCustomersCustomerCardsId parameters: - in: path name: customer required: true schema: maxLength: 5000 type: string style: simple - in: path name: id required: true schema: type: string style: simple requestBody: content: application/x-www-form-urlencoded: encoding: expand: explode: true style: deepObject schema: additionalProperties: false properties: expand: description: Specifies which fields in the response should be expanded. items: maxLength: 5000 type: string type: array type: object required: false responses: '200': content: application/json: schema: anyOf: - $ref: '#/components/schemas/payment_source' - $ref: '#/components/schemas/deleted_payment_source' description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. get: deprecated: true description: >-

You can always see the 10 most recent cards directly on a customer; this method lets you retrieve details about a specific card stored on the customer.

operationId: GetCustomersCustomerCardsId parameters: - in: path name: customer required: true schema: maxLength: 5000 type: string style: simple - description: Specifies which fields in the response should be expanded. explode: true in: query name: expand required: false schema: items: maxLength: 5000 type: string type: array style: deepObject - in: path name: id required: true schema: maxLength: 5000 type: string style: simple requestBody: content: application/x-www-form-urlencoded: encoding: {} schema: additionalProperties: false properties: {} type: object required: false responses: '200': content: application/json: schema: $ref: '#/components/schemas/card' description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. post: description:

Update a specified source for a given customer.

operationId: PostCustomersCustomerCardsId parameters: - in: path name: customer required: true schema: maxLength: 5000 type: string style: simple - in: path name: id required: true schema: maxLength: 5000 type: string style: simple requestBody: content: application/x-www-form-urlencoded: encoding: expand: explode: true style: deepObject metadata: explode: true style: deepObject owner: explode: true style: deepObject schema: additionalProperties: false properties: account_holder_name: description: >- The name of the person or business that owns the bank account. maxLength: 5000 type: string account_holder_type: description: >- The type of entity that holds the account. This can be either `individual` or `company`. enum: - company - individual maxLength: 5000 type: string address_city: description: City/District/Suburb/Town/Village. maxLength: 5000 type: string address_country: description: 'Billing address country, if provided when creating card.' maxLength: 5000 type: string address_line1: description: Address line 1 (Street address/PO Box/Company name). maxLength: 5000 type: string address_line2: description: Address line 2 (Apartment/Suite/Unit/Building). maxLength: 5000 type: string address_state: description: State/County/Province/Region. maxLength: 5000 type: string address_zip: description: ZIP or postal code. maxLength: 5000 type: string exp_month: description: Two digit number representing the card’s expiration month. maxLength: 5000 type: string exp_year: description: Four digit number representing the card’s expiration year. maxLength: 5000 type: string expand: description: Specifies which fields in the response should be expanded. items: maxLength: 5000 type: string type: array metadata: anyOf: - additionalProperties: type: string type: object - enum: - '' type: string description: >- Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. name: description: Cardholder name. maxLength: 5000 type: string owner: properties: address: properties: city: maxLength: 5000 type: string country: maxLength: 5000 type: string line1: maxLength: 5000 type: string line2: maxLength: 5000 type: string postal_code: maxLength: 5000 type: string state: maxLength: 5000 type: string title: source_address type: object email: type: string name: maxLength: 5000 type: string phone: maxLength: 5000 type: string title: owner type: object type: object required: false responses: '200': content: application/json: schema: anyOf: - $ref: '#/components/schemas/card' - $ref: '#/components/schemas/bank_account' - $ref: '#/components/schemas/source' description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. '/v1/customers/{customer}/cash_balance': get: description:

Retrieves a customer’s cash balance.

operationId: GetCustomersCustomerCashBalance parameters: - in: path name: customer required: true schema: maxLength: 5000 type: string style: simple - description: Specifies which fields in the response should be expanded. explode: true in: query name: expand required: false schema: items: maxLength: 5000 type: string type: array style: deepObject requestBody: content: application/x-www-form-urlencoded: encoding: {} schema: additionalProperties: false properties: {} type: object required: false responses: '200': content: application/json: schema: $ref: '#/components/schemas/cash_balance' description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. post: description:

Changes the settings on a customer’s cash balance.

operationId: PostCustomersCustomerCashBalance parameters: - in: path name: customer required: true schema: maxLength: 5000 type: string style: simple requestBody: content: application/x-www-form-urlencoded: encoding: expand: explode: true style: deepObject settings: explode: true style: deepObject schema: additionalProperties: false properties: expand: description: Specifies which fields in the response should be expanded. items: maxLength: 5000 type: string type: array settings: description: A hash of settings for this cash balance. properties: reconciliation_mode: enum: - automatic - manual - merchant_default type: string title: balance_settings_param type: object type: object required: false responses: '200': content: application/json: schema: $ref: '#/components/schemas/cash_balance' description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. '/v1/customers/{customer}/cash_balance_transactions': get: description: >-

Returns a list of transactions that modified the customer’s cash balance.

operationId: GetCustomersCustomerCashBalanceTransactions parameters: - in: path name: customer required: true schema: maxLength: 5000 type: string style: simple - description: >- A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. in: query name: ending_before required: false schema: maxLength: 5000 type: string style: form - description: Specifies which fields in the response should be expanded. explode: true in: query name: expand required: false schema: items: maxLength: 5000 type: string type: array style: deepObject - description: >- A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. in: query name: limit required: false schema: type: integer style: form - description: >- A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. in: query name: starting_after required: false schema: maxLength: 5000 type: string style: form requestBody: content: application/x-www-form-urlencoded: encoding: {} schema: additionalProperties: false properties: {} type: object required: false responses: '200': content: application/json: schema: description: >- Customers with certain payments enabled have a cash balance, representing funds that were paid by the customer to a merchant, but have not yet been allocated to a payment. Cash Balance Transactions represent when funds are moved into or out of this balance. This includes funding by the customer, allocation to payments, and refunds to the customer. properties: data: description: Details about each object. items: $ref: '#/components/schemas/customer_cash_balance_transaction' type: array has_more: description: >- True if this list has another page of items after this one that can be fetched. type: boolean object: description: >- String representing the object's type. Objects of the same type share the same value. Always has the value `list`. enum: - list type: string url: description: The URL where this list can be accessed. maxLength: 5000 type: string required: - data - has_more - object - url title: CustomerCashBalanceTransactionList type: object x-expandableFields: - data description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. '/v1/customers/{customer}/cash_balance_transactions/{transaction}': get: description: >-

Retrieves a specific cash balance transaction, which updated the customer’s cash balance.

operationId: GetCustomersCustomerCashBalanceTransactionsTransaction parameters: - in: path name: customer required: true schema: maxLength: 5000 type: string style: simple - description: Specifies which fields in the response should be expanded. explode: true in: query name: expand required: false schema: items: maxLength: 5000 type: string type: array style: deepObject - in: path name: transaction required: true schema: type: string style: simple requestBody: content: application/x-www-form-urlencoded: encoding: {} schema: additionalProperties: false properties: {} type: object required: false responses: '200': content: application/json: schema: $ref: '#/components/schemas/customer_cash_balance_transaction' description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. '/v1/customers/{customer}/discount': delete: description:

Removes the currently applied discount on a customer.

operationId: DeleteCustomersCustomerDiscount parameters: - in: path name: customer required: true schema: maxLength: 5000 type: string style: simple requestBody: content: application/x-www-form-urlencoded: encoding: {} schema: additionalProperties: false properties: {} type: object required: false responses: '200': content: application/json: schema: $ref: '#/components/schemas/deleted_discount' description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. get: description: '' operationId: GetCustomersCustomerDiscount parameters: - in: path name: customer required: true schema: maxLength: 5000 type: string style: simple - description: Specifies which fields in the response should be expanded. explode: true in: query name: expand required: false schema: items: maxLength: 5000 type: string type: array style: deepObject requestBody: content: application/x-www-form-urlencoded: encoding: {} schema: additionalProperties: false properties: {} type: object required: false responses: '200': content: application/json: schema: $ref: '#/components/schemas/discount' description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. '/v1/customers/{customer}/funding_instructions': post: description: >-

Retrieve funding instructions for a customer cash balance. If funding instructions do not yet exist for the customer, new funding instructions will be created. If funding instructions have already been created for a given customer, the same funding instructions will be retrieved. In other words, we will return the same funding instructions each time.

operationId: PostCustomersCustomerFundingInstructions parameters: - in: path name: customer required: true schema: maxLength: 5000 type: string style: simple requestBody: content: application/x-www-form-urlencoded: encoding: bank_transfer: explode: true style: deepObject expand: explode: true style: deepObject schema: additionalProperties: false properties: bank_transfer: description: Additional parameters for `bank_transfer` funding types properties: eu_bank_transfer: properties: country: maxLength: 5000 type: string required: - country title: eu_bank_account_params type: object requested_address_types: items: enum: - iban - sort_code - spei - zengin type: string x-stripeBypassValidation: true type: array type: enum: - eu_bank_transfer - gb_bank_transfer - jp_bank_transfer - mx_bank_transfer - us_bank_transfer type: string x-stripeBypassValidation: true required: - type title: bank_transfer_params type: object currency: description: >- 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). type: string expand: description: Specifies which fields in the response should be expanded. items: maxLength: 5000 type: string type: array funding_type: description: The `funding_type` to get the instructions for. enum: - bank_transfer type: string required: - bank_transfer - currency - funding_type type: object required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/funding_instructions' description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. '/v1/customers/{customer}/payment_methods': get: description:

Returns a list of PaymentMethods for a given Customer

operationId: GetCustomersCustomerPaymentMethods parameters: - description: >- 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`. in: query name: allow_redisplay required: false schema: enum: - always - limited - unspecified type: string style: form - in: path name: customer required: true schema: maxLength: 5000 type: string style: simple - description: >- A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. in: query name: ending_before required: false schema: type: string style: form - description: Specifies which fields in the response should be expanded. explode: true in: query name: expand required: false schema: items: maxLength: 5000 type: string type: array style: deepObject - description: >- A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. in: query name: limit required: false schema: type: integer style: form - description: >- A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. in: query name: starting_after required: false schema: type: string style: form - description: >- An optional filter on the list, based on the object `type` field. Without the filter, the list includes all current and future payment method types. If your integration expects only one type of payment method in the response, make sure to provide a type value in the request. in: query name: type required: false schema: enum: - acss_debit - affirm - afterpay_clearpay - alipay - amazon_pay - au_becs_debit - bacs_debit - bancontact - blik - boleto - card - cashapp - customer_balance - eps - fpx - giropay - grabpay - ideal - klarna - konbini - link - mobilepay - oxxo - p24 - paynow - paypal - pix - promptpay - revolut_pay - sepa_debit - sofort - swish - us_bank_account - wechat_pay - zip type: string x-stripeBypassValidation: true style: form requestBody: content: application/x-www-form-urlencoded: encoding: {} schema: additionalProperties: false properties: {} type: object required: false responses: '200': content: application/json: schema: description: '' properties: data: items: $ref: '#/components/schemas/payment_method' type: array has_more: description: >- True if this list has another page of items after this one that can be fetched. type: boolean object: description: >- String representing the object's type. Objects of the same type share the same value. Always has the value `list`. enum: - list type: string url: description: The URL where this list can be accessed. maxLength: 5000 type: string required: - data - has_more - object - url title: CustomerPaymentMethodResourceList type: object x-expandableFields: - data description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. '/v1/customers/{customer}/payment_methods/{payment_method}': get: description:

Retrieves a PaymentMethod object for a given Customer.

operationId: GetCustomersCustomerPaymentMethodsPaymentMethod parameters: - in: path name: customer required: true schema: maxLength: 5000 type: string style: simple - description: Specifies which fields in the response should be expanded. explode: true in: query name: expand required: false schema: items: maxLength: 5000 type: string type: array style: deepObject - in: path name: payment_method required: true schema: maxLength: 5000 type: string style: simple requestBody: content: application/x-www-form-urlencoded: encoding: {} schema: additionalProperties: false properties: {} type: object required: false responses: '200': content: application/json: schema: $ref: '#/components/schemas/payment_method' description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. '/v1/customers/{customer}/sources': get: description:

List sources for a specified customer.

operationId: GetCustomersCustomerSources parameters: - in: path name: customer required: true schema: maxLength: 5000 type: string style: simple - description: >- A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. in: query name: ending_before required: false schema: type: string style: form - description: Specifies which fields in the response should be expanded. explode: true in: query name: expand required: false schema: items: maxLength: 5000 type: string type: array style: deepObject - description: >- A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. in: query name: limit required: false schema: type: integer style: form - description: Filter sources according to a particular object type. in: query name: object required: false schema: maxLength: 5000 type: string style: form - description: >- A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. in: query name: starting_after required: false schema: type: string style: form requestBody: content: application/x-www-form-urlencoded: encoding: {} schema: additionalProperties: false properties: {} type: object required: false responses: '200': content: application/json: schema: description: '' properties: data: description: Details about each object. items: anyOf: - $ref: '#/components/schemas/bank_account' - $ref: '#/components/schemas/card' - $ref: '#/components/schemas/source' title: Polymorphic x-stripeBypassValidation: true type: array has_more: description: >- True if this list has another page of items after this one that can be fetched. type: boolean object: description: >- String representing the object's type. Objects of the same type share the same value. Always has the value `list`. enum: - list type: string url: description: The URL where this list can be accessed. maxLength: 5000 type: string required: - data - has_more - object - url title: ApmsSourcesSourceList type: object x-expandableFields: - data description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. post: description: >-

When you create a new credit card, you must specify a customer or recipient on which to create it.

If the card’s owner has no default card, then the new card will become the default. However, if the owner already has a default, then it will not change. To change the default, you should update the customer to have a new default_source.

operationId: PostCustomersCustomerSources parameters: - in: path name: customer required: true schema: maxLength: 5000 type: string style: simple requestBody: content: application/x-www-form-urlencoded: encoding: bank_account: explode: true style: deepObject card: explode: true style: deepObject expand: explode: true style: deepObject metadata: explode: true style: deepObject schema: additionalProperties: false properties: alipay_account: description: >- A token returned by [Stripe.js](https://stripe.com/docs/js) representing the user’s Alipay account details. maxLength: 5000 type: string bank_account: anyOf: - properties: account_holder_name: maxLength: 5000 type: string account_holder_type: enum: - company - individual maxLength: 5000 type: string account_number: maxLength: 5000 type: string country: maxLength: 5000 type: string currency: type: string object: enum: - bank_account maxLength: 5000 type: string routing_number: maxLength: 5000 type: string required: - account_number - country title: customer_payment_source_bank_account type: object - maxLength: 5000 type: string description: >- Either a token, like the ones returned by [Stripe.js](https://stripe.com/docs/js), or a dictionary containing a user's bank account details. card: anyOf: - properties: address_city: maxLength: 5000 type: string address_country: maxLength: 5000 type: string address_line1: maxLength: 5000 type: string address_line2: maxLength: 5000 type: string address_state: maxLength: 5000 type: string address_zip: maxLength: 5000 type: string cvc: maxLength: 5000 type: string exp_month: type: integer exp_year: type: integer metadata: additionalProperties: type: string type: object name: maxLength: 5000 type: string number: maxLength: 5000 type: string object: enum: - card maxLength: 5000 type: string required: - exp_month - exp_year - number title: customer_payment_source_card type: object - maxLength: 5000 type: string description: >- A token, like the ones returned by [Stripe.js](https://stripe.com/docs/js). x-stripeBypassValidation: true expand: description: Specifies which fields in the response should be expanded. items: maxLength: 5000 type: string type: array metadata: additionalProperties: type: string description: >- Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. type: object source: description: >- Please refer to full [documentation](https://stripe.com/docs/api) instead. maxLength: 5000 type: string x-stripeBypassValidation: true type: object required: false responses: '200': content: application/json: schema: $ref: '#/components/schemas/payment_source' description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. '/v1/customers/{customer}/sources/{id}': delete: description:

Delete a specified source for a given customer.

operationId: DeleteCustomersCustomerSourcesId parameters: - in: path name: customer required: true schema: maxLength: 5000 type: string style: simple - in: path name: id required: true schema: type: string style: simple requestBody: content: application/x-www-form-urlencoded: encoding: expand: explode: true style: deepObject schema: additionalProperties: false properties: expand: description: Specifies which fields in the response should be expanded. items: maxLength: 5000 type: string type: array type: object required: false responses: '200': content: application/json: schema: anyOf: - $ref: '#/components/schemas/payment_source' - $ref: '#/components/schemas/deleted_payment_source' description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. get: description:

Retrieve a specified source for a given customer.

operationId: GetCustomersCustomerSourcesId parameters: - in: path name: customer required: true schema: maxLength: 5000 type: string style: simple - description: Specifies which fields in the response should be expanded. explode: true in: query name: expand required: false schema: items: maxLength: 5000 type: string type: array style: deepObject - in: path name: id required: true schema: maxLength: 500 type: string style: simple requestBody: content: application/x-www-form-urlencoded: encoding: {} schema: additionalProperties: false properties: {} type: object required: false responses: '200': content: application/json: schema: $ref: '#/components/schemas/payment_source' description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. post: description:

Update a specified source for a given customer.

operationId: PostCustomersCustomerSourcesId parameters: - in: path name: customer required: true schema: maxLength: 5000 type: string style: simple - in: path name: id required: true schema: maxLength: 5000 type: string style: simple requestBody: content: application/x-www-form-urlencoded: encoding: expand: explode: true style: deepObject metadata: explode: true style: deepObject owner: explode: true style: deepObject schema: additionalProperties: false properties: account_holder_name: description: >- The name of the person or business that owns the bank account. maxLength: 5000 type: string account_holder_type: description: >- The type of entity that holds the account. This can be either `individual` or `company`. enum: - company - individual maxLength: 5000 type: string address_city: description: City/District/Suburb/Town/Village. maxLength: 5000 type: string address_country: description: 'Billing address country, if provided when creating card.' maxLength: 5000 type: string address_line1: description: Address line 1 (Street address/PO Box/Company name). maxLength: 5000 type: string address_line2: description: Address line 2 (Apartment/Suite/Unit/Building). maxLength: 5000 type: string address_state: description: State/County/Province/Region. maxLength: 5000 type: string address_zip: description: ZIP or postal code. maxLength: 5000 type: string exp_month: description: Two digit number representing the card’s expiration month. maxLength: 5000 type: string exp_year: description: Four digit number representing the card’s expiration year. maxLength: 5000 type: string expand: description: Specifies which fields in the response should be expanded. items: maxLength: 5000 type: string type: array metadata: anyOf: - additionalProperties: type: string type: object - enum: - '' type: string description: >- Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. name: description: Cardholder name. maxLength: 5000 type: string owner: properties: address: properties: city: maxLength: 5000 type: string country: maxLength: 5000 type: string line1: maxLength: 5000 type: string line2: maxLength: 5000 type: string postal_code: maxLength: 5000 type: string state: maxLength: 5000 type: string title: source_address type: object email: type: string name: maxLength: 5000 type: string phone: maxLength: 5000 type: string title: owner type: object type: object required: false responses: '200': content: application/json: schema: anyOf: - $ref: '#/components/schemas/card' - $ref: '#/components/schemas/bank_account' - $ref: '#/components/schemas/source' description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. '/v1/customers/{customer}/sources/{id}/verify': post: description:

Verify a specified bank account for a given customer.

operationId: PostCustomersCustomerSourcesIdVerify parameters: - in: path name: customer required: true schema: maxLength: 5000 type: string style: simple - in: path name: id required: true schema: maxLength: 5000 type: string style: simple requestBody: content: application/x-www-form-urlencoded: encoding: amounts: explode: true style: deepObject expand: explode: true style: deepObject schema: additionalProperties: false properties: amounts: description: >- Two positive integers, in *cents*, equal to the values of the microdeposits sent to the bank account. items: type: integer type: array expand: description: Specifies which fields in the response should be expanded. items: maxLength: 5000 type: string type: array type: object required: false responses: '200': content: application/json: schema: $ref: '#/components/schemas/bank_account' description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. '/v1/customers/{customer}/subscriptions': get: description: >-

You can see a list of the customer’s active subscriptions. Note that the 10 most recent active subscriptions are always available by default on the customer object. If you need more than those 10, you can use the limit and starting_after parameters to page through additional subscriptions.

operationId: GetCustomersCustomerSubscriptions parameters: - in: path name: customer required: true schema: maxLength: 5000 type: string style: simple - description: >- A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. in: query name: ending_before required: false schema: maxLength: 5000 type: string style: form - description: Specifies which fields in the response should be expanded. explode: true in: query name: expand required: false schema: items: maxLength: 5000 type: string type: array style: deepObject - description: >- A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. in: query name: limit required: false schema: type: integer style: form - description: >- A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. in: query name: starting_after required: false schema: maxLength: 5000 type: string style: form requestBody: content: application/x-www-form-urlencoded: encoding: {} schema: additionalProperties: false properties: {} type: object required: false responses: '200': content: application/json: schema: description: '' properties: data: description: Details about each object. items: $ref: '#/components/schemas/subscription' type: array has_more: description: >- True if this list has another page of items after this one that can be fetched. type: boolean object: description: >- String representing the object's type. Objects of the same type share the same value. Always has the value `list`. enum: - list type: string url: description: The URL where this list can be accessed. maxLength: 5000 type: string required: - data - has_more - object - url title: SubscriptionList type: object x-expandableFields: - data description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. post: description:

Creates a new subscription on an existing customer.

operationId: PostCustomersCustomerSubscriptions parameters: - in: path name: customer required: true schema: maxLength: 5000 type: string style: simple requestBody: content: application/x-www-form-urlencoded: encoding: add_invoice_items: explode: true style: deepObject application_fee_percent: explode: true style: deepObject automatic_tax: explode: true style: deepObject billing_thresholds: explode: true style: deepObject default_tax_rates: explode: true style: deepObject discounts: explode: true style: deepObject expand: explode: true style: deepObject invoice_settings: explode: true style: deepObject items: explode: true style: deepObject metadata: explode: true style: deepObject payment_settings: explode: true style: deepObject pending_invoice_item_interval: explode: true style: deepObject transfer_data: explode: true style: deepObject trial_end: explode: true style: deepObject trial_settings: explode: true style: deepObject schema: additionalProperties: false properties: add_invoice_items: description: >- A list of prices and quantities that will generate invoice items appended to the next invoice for this subscription. You may pass up to 20 items. items: properties: discounts: items: properties: coupon: maxLength: 5000 type: string discount: maxLength: 5000 type: string promotion_code: maxLength: 5000 type: string title: discounts_data_param type: object type: array price: maxLength: 5000 type: string price_data: properties: currency: type: string product: maxLength: 5000 type: string tax_behavior: enum: - exclusive - inclusive - unspecified type: string unit_amount: type: integer unit_amount_decimal: format: decimal type: string required: - currency - product title: one_time_price_data_with_negative_amounts type: object quantity: type: integer tax_rates: anyOf: - items: maxLength: 5000 type: string type: array - enum: - '' type: string title: add_invoice_item_entry type: object type: array application_fee_percent: anyOf: - type: number - enum: - '' type: string description: >- 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. The request must be made by a platform account on a connected account in order to set an application fee percentage. For more information, see the application fees [documentation](https://stripe.com/docs/connect/subscriptions#collecting-fees-on-subscriptions). automatic_tax: description: >- Automatic tax settings for this subscription. We recommend you only include this parameter when the existing value is being changed. properties: enabled: type: boolean liability: properties: account: type: string type: enum: - account - self type: string required: - type title: param type: object required: - enabled title: automatic_tax_config type: object backdate_start_date: description: >- For new subscriptions, a past timestamp to backdate the subscription's start date to. If set, the first invoice will contain a proration for the timespan between the start date and the current time. Can be combined with trials and the billing cycle anchor. format: unix-time type: integer billing_cycle_anchor: description: >- A future timestamp in UTC format to anchor the subscription's [billing cycle](https://stripe.com/docs/subscriptions/billing-cycle). The anchor is the reference point that aligns future 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. format: unix-time type: integer x-stripeBypassValidation: true billing_thresholds: anyOf: - properties: amount_gte: type: integer reset_billing_cycle_anchor: type: boolean title: billing_thresholds_param type: object - enum: - '' type: string description: >- Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period. Pass an empty string to remove previously-defined thresholds. cancel_at: description: >- A timestamp at which the subscription should cancel. If set to a date before the current period ends, this will cause a proration if prorations have been enabled using `proration_behavior`. If set during a future period, this will always cause a proration for that period. format: unix-time type: integer cancel_at_period_end: description: >- Boolean indicating whether this subscription should cancel at the end of the current period. type: boolean collection_method: description: >- 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`. Defaults to `charge_automatically`. enum: - charge_automatically - send_invoice type: string coupon: description: >- The ID of the coupon to apply to this subscription. A coupon applied to a subscription will only affect invoices created for that particular subscription. This field has been deprecated and will be removed in a future API version. Use `discounts` instead. maxLength: 5000 type: string currency: description: >- 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). type: string days_until_due: description: >- Number of days a customer has to pay invoices generated by this subscription. Valid only for subscriptions where `collection_method` is set to `send_invoice`. type: integer default_payment_method: description: >- 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). maxLength: 5000 type: string default_source: description: >- 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). maxLength: 5000 type: string default_tax_rates: anyOf: - items: maxLength: 5000 type: string type: array - enum: - '' type: string description: >- 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. discounts: anyOf: - items: properties: coupon: maxLength: 5000 type: string discount: maxLength: 5000 type: string promotion_code: maxLength: 5000 type: string title: discounts_data_param type: object type: array - enum: - '' type: string description: >- The coupons to redeem into discounts for the subscription. If not specified or empty, inherits the discount from the subscription's customer. expand: description: Specifies which fields in the response should be expanded. items: maxLength: 5000 type: string type: array invoice_settings: description: All invoices will be billed using the specified settings. properties: account_tax_ids: anyOf: - items: maxLength: 5000 type: string type: array - enum: - '' type: string issuer: properties: account: type: string type: enum: - account - self type: string required: - type title: param type: object title: invoice_settings_param type: object items: description: >- A list of up to 20 subscription items, each with an attached price. items: properties: billing_thresholds: anyOf: - properties: usage_gte: type: integer required: - usage_gte title: item_billing_thresholds_param type: object - enum: - '' type: string discounts: anyOf: - items: properties: coupon: maxLength: 5000 type: string discount: maxLength: 5000 type: string promotion_code: maxLength: 5000 type: string title: discounts_data_param type: object type: array - enum: - '' type: string metadata: additionalProperties: type: string type: object price: maxLength: 5000 type: string price_data: properties: currency: type: string product: maxLength: 5000 type: string recurring: properties: interval: enum: - day - month - week - year type: string interval_count: type: integer required: - interval title: recurring_adhoc type: object tax_behavior: enum: - exclusive - inclusive - unspecified type: string unit_amount: type: integer unit_amount_decimal: format: decimal type: string required: - currency - product - recurring title: recurring_price_data type: object quantity: type: integer tax_rates: anyOf: - items: maxLength: 5000 type: string type: array - enum: - '' type: string title: subscription_item_create_params type: object type: array metadata: anyOf: - additionalProperties: type: string type: object - enum: - '' type: string description: >- Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. off_session: description: >- Indicates if a customer is on or off-session while an invoice payment is attempted. type: boolean payment_behavior: description: >- Only applies to subscriptions with `collection_method=charge_automatically`. Use `allow_incomplete` to create Subscriptions with `status=incomplete` if the first invoice can't be paid. Creating Subscriptions with this status allows you to manage scenarios where additional customer actions are needed to pay a subscription's invoice. For example, SCA regulation may require 3DS authentication to complete payment. See the [SCA Migration Guide](https://stripe.com/docs/billing/migration/strong-customer-authentication) for Billing to learn more. This is the default behavior. Use `default_incomplete` to create Subscriptions with `status=incomplete` when the first invoice requires payment, otherwise start as active. Subscriptions transition to `status=active` when successfully confirming the PaymentIntent on the first invoice. This allows simpler management of scenarios where additional customer actions are needed to pay a subscription’s invoice, such as failed payments, [SCA regulation](https://stripe.com/docs/billing/migration/strong-customer-authentication), or collecting a mandate for a bank debit payment method. If the PaymentIntent is not confirmed within 23 hours Subscriptions transition to `status=incomplete_expired`, which is a terminal state. Use `error_if_incomplete` if you want Stripe to return an HTTP 402 status code if a subscription's first invoice can't be paid. For example, if a payment method requires 3DS authentication due to SCA regulation and further customer action is needed, this parameter doesn't create a Subscription and returns an error instead. This was the default behavior for API versions prior to 2019-03-14. See the [changelog](https://stripe.com/docs/upgrades#2019-03-14) to learn more. `pending_if_incomplete` is only used with updates and cannot be passed when creating a Subscription. Subscriptions with `collection_method=send_invoice` are automatically activated regardless of the first Invoice status. enum: - allow_incomplete - default_incomplete - error_if_incomplete - pending_if_incomplete type: string payment_settings: description: >- Payment settings to pass to invoices created by the subscription. properties: payment_method_options: properties: acss_debit: anyOf: - properties: mandate_options: properties: transaction_type: enum: - business - personal type: string title: mandate_options_param type: object verification_method: enum: - automatic - instant - microdeposits type: string x-stripeBypassValidation: true title: invoice_payment_method_options_param type: object - enum: - '' type: string bancontact: anyOf: - properties: preferred_language: enum: - de - en - fr - nl type: string title: invoice_payment_method_options_param type: object - enum: - '' type: string card: anyOf: - properties: mandate_options: properties: amount: type: integer amount_type: enum: - fixed - maximum type: string description: maxLength: 200 type: string title: mandate_options_param type: object network: enum: - amex - cartes_bancaires - diners - discover - eftpos_au - interac - jcb - mastercard - unionpay - unknown - visa maxLength: 5000 type: string x-stripeBypassValidation: true request_three_d_secure: enum: - any - automatic - challenge type: string title: subscription_payment_method_options_param type: object - enum: - '' type: string customer_balance: anyOf: - properties: bank_transfer: properties: eu_bank_transfer: properties: country: maxLength: 5000 type: string required: - country title: eu_bank_transfer_param type: object type: type: string title: bank_transfer_param type: object funding_type: type: string title: invoice_payment_method_options_param type: object - enum: - '' type: string konbini: anyOf: - properties: {} title: invoice_payment_method_options_param type: object - enum: - '' type: string sepa_debit: anyOf: - properties: {} title: invoice_payment_method_options_param type: object - enum: - '' type: string us_bank_account: anyOf: - properties: financial_connections: properties: permissions: items: enum: - balances - ownership - payment_method - transactions maxLength: 5000 type: string x-stripeBypassValidation: true type: array prefetch: items: enum: - balances - ownership - transactions type: string x-stripeBypassValidation: true type: array title: invoice_linked_account_options_param type: object verification_method: enum: - automatic - instant - microdeposits type: string x-stripeBypassValidation: true title: invoice_payment_method_options_param type: object - enum: - '' type: string title: payment_method_options type: object payment_method_types: anyOf: - items: enum: - ach_credit_transfer - ach_debit - acss_debit - au_becs_debit - bacs_debit - bancontact - boleto - card - cashapp - customer_balance - eps - fpx - giropay - grabpay - ideal - konbini - link - p24 - paynow - paypal - promptpay - sepa_debit - sofort - us_bank_account - wechat_pay type: string x-stripeBypassValidation: true type: array - enum: - '' type: string save_default_payment_method: enum: - 'off' - on_subscription type: string title: payment_settings type: object pending_invoice_item_interval: anyOf: - properties: interval: enum: - day - month - week - year type: string interval_count: type: integer required: - interval title: pending_invoice_item_interval_params type: object - enum: - '' type: string description: >- Specifies an interval for how often to bill for any pending invoice items. It is analogous to calling [Create an invoice](https://stripe.com/docs/api#create_invoice) for the given subscription at the specified interval. promotion_code: description: >- The ID of a promotion code to apply to this subscription. A promotion code applied to a subscription will only affect invoices created for that particular subscription. This field has been deprecated and will be removed in a future API version. Use `discounts` instead. maxLength: 5000 type: string proration_behavior: description: >- Determines how to handle [prorations](https://stripe.com/docs/billing/subscriptions/prorations) resulting from the `billing_cycle_anchor`. If no value is passed, the default is `create_prorations`. enum: - always_invoice - create_prorations - none type: string transfer_data: description: >- If specified, the funds from the subscription's invoices will be transferred to the destination and the ID of the resulting transfers will be found on the resulting charges. properties: amount_percent: type: number destination: type: string required: - destination title: transfer_data_specs type: object trial_end: anyOf: - enum: - now maxLength: 5000 type: string - format: unix-time type: integer description: >- Unix timestamp representing the end of the trial period the customer will get before being charged for the first time. If set, trial_end will override the default trial period of the plan the customer is being subscribed to. The special value `now` can be provided to end the customer's trial immediately. Can be at most two years from `billing_cycle_anchor`. See [Using trial periods on subscriptions](https://stripe.com/docs/billing/subscriptions/trials) to learn more. trial_from_plan: description: >- Indicates if a plan's `trial_period_days` should be applied to the subscription. Setting `trial_end` per subscription is preferred, and this defaults to `false`. Setting this flag to `true` together with `trial_end` is not allowed. See [Using trial periods on subscriptions](https://stripe.com/docs/billing/subscriptions/trials) to learn more. type: boolean trial_period_days: description: >- Integer representing the number of trial period days before the customer is charged for the first time. This will always overwrite any trials that might apply via a subscribed plan. See [Using trial periods on subscriptions](https://stripe.com/docs/billing/subscriptions/trials) to learn more. type: integer trial_settings: description: Settings related to subscription trials. properties: end_behavior: properties: missing_payment_method: enum: - cancel - create_invoice - pause type: string required: - missing_payment_method title: end_behavior type: object required: - end_behavior title: trial_settings_config type: object type: object required: false responses: '200': content: application/json: schema: $ref: '#/components/schemas/subscription' description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. '/v1/customers/{customer}/subscriptions/{subscription_exposed_id}': delete: description: >-

Cancels a customer’s subscription. If you set the at_period_end parameter to true, the subscription will remain active until the end of the period, at which point it will be canceled and not renewed. Otherwise, with the default false value, the subscription is terminated immediately. In either case, the customer will not be charged again for the subscription.

Note, however, that any pending invoice items that you’ve created will still be charged for at the end of the period, unless manually deleted. If you’ve set the subscription to cancel at the end of the period, any pending prorations will also be left in place and collected at the end of the period. But if the subscription is set to cancel immediately, pending prorations will be removed.

By default, upon subscription cancellation, Stripe will stop automatic collection of all finalized invoices for the customer. This is intended to prevent unexpected payment attempts after the customer has canceled a subscription. However, you can resume automatic collection of the invoices manually after subscription cancellation to have us proceed. Or, you could check for unpaid invoices before allowing the customer to cancel the subscription at all.

operationId: DeleteCustomersCustomerSubscriptionsSubscriptionExposedId parameters: - in: path name: customer required: true schema: maxLength: 5000 type: string style: simple - in: path name: subscription_exposed_id required: true schema: maxLength: 5000 type: string style: simple requestBody: content: application/x-www-form-urlencoded: encoding: expand: explode: true style: deepObject schema: additionalProperties: false properties: expand: description: Specifies which fields in the response should be expanded. items: maxLength: 5000 type: string type: array invoice_now: description: >- Can be set to `true` if `at_period_end` is not set to `true`. Will generate a final invoice that invoices for any un-invoiced metered usage and new/pending proration invoice items. type: boolean prorate: description: >- Can be set to `true` if `at_period_end` is not set to `true`. Will generate a proration invoice item that credits remaining unused time until the subscription period end. type: boolean type: object required: false responses: '200': content: application/json: schema: $ref: '#/components/schemas/subscription' description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. get: description:

Retrieves the subscription with the given ID.

operationId: GetCustomersCustomerSubscriptionsSubscriptionExposedId parameters: - in: path name: customer required: true schema: maxLength: 5000 type: string style: simple - description: Specifies which fields in the response should be expanded. explode: true in: query name: expand required: false schema: items: maxLength: 5000 type: string type: array style: deepObject - in: path name: subscription_exposed_id required: true schema: maxLength: 5000 type: string style: simple requestBody: content: application/x-www-form-urlencoded: encoding: {} schema: additionalProperties: false properties: {} type: object required: false responses: '200': content: application/json: schema: $ref: '#/components/schemas/subscription' description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. post: description: >-

Updates an existing subscription on a customer to match the specified parameters. When changing plans or quantities, we will optionally prorate the price we charge next month to make up for any price changes. To preview how the proration will be calculated, use the upcoming invoice endpoint.

operationId: PostCustomersCustomerSubscriptionsSubscriptionExposedId parameters: - in: path name: customer required: true schema: maxLength: 5000 type: string style: simple - in: path name: subscription_exposed_id required: true schema: maxLength: 5000 type: string style: simple requestBody: content: application/x-www-form-urlencoded: encoding: add_invoice_items: explode: true style: deepObject application_fee_percent: explode: true style: deepObject automatic_tax: explode: true style: deepObject billing_thresholds: explode: true style: deepObject cancel_at: explode: true style: deepObject cancellation_details: explode: true style: deepObject default_source: explode: true style: deepObject default_tax_rates: explode: true style: deepObject discounts: explode: true style: deepObject expand: explode: true style: deepObject invoice_settings: explode: true style: deepObject items: explode: true style: deepObject metadata: explode: true style: deepObject pause_collection: explode: true style: deepObject payment_settings: explode: true style: deepObject pending_invoice_item_interval: explode: true style: deepObject transfer_data: explode: true style: deepObject trial_end: explode: true style: deepObject trial_settings: explode: true style: deepObject schema: additionalProperties: false properties: add_invoice_items: description: >- A list of prices and quantities that will generate invoice items appended to the next invoice for this subscription. You may pass up to 20 items. items: properties: discounts: items: properties: coupon: maxLength: 5000 type: string discount: maxLength: 5000 type: string promotion_code: maxLength: 5000 type: string title: discounts_data_param type: object type: array price: maxLength: 5000 type: string price_data: properties: currency: type: string product: maxLength: 5000 type: string tax_behavior: enum: - exclusive - inclusive - unspecified type: string unit_amount: type: integer unit_amount_decimal: format: decimal type: string required: - currency - product title: one_time_price_data_with_negative_amounts type: object quantity: type: integer tax_rates: anyOf: - items: maxLength: 5000 type: string type: array - enum: - '' type: string title: add_invoice_item_entry type: object type: array application_fee_percent: anyOf: - type: number - enum: - '' type: string description: >- 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. The request must be made by a platform account on a connected account in order to set an application fee percentage. For more information, see the application fees [documentation](https://stripe.com/docs/connect/subscriptions#collecting-fees-on-subscriptions). automatic_tax: description: >- Automatic tax settings for this subscription. We recommend you only include this parameter when the existing value is being changed. properties: enabled: type: boolean liability: properties: account: type: string type: enum: - account - self type: string required: - type title: param type: object required: - enabled title: automatic_tax_config type: object billing_cycle_anchor: description: >- Either `now` or `unchanged`. Setting the value to `now` resets the subscription's billing cycle anchor to the current time. For more information, see the billing cycle [documentation](https://stripe.com/docs/billing/subscriptions/billing-cycle). enum: - now - unchanged maxLength: 5000 type: string x-stripeBypassValidation: true billing_thresholds: anyOf: - properties: amount_gte: type: integer reset_billing_cycle_anchor: type: boolean title: billing_thresholds_param type: object - enum: - '' type: string description: >- Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period. Pass an empty string to remove previously-defined thresholds. cancel_at: anyOf: - format: unix-time type: integer - enum: - '' type: string description: >- A timestamp at which the subscription should cancel. If set to a date before the current period ends, this will cause a proration if prorations have been enabled using `proration_behavior`. If set during a future period, this will always cause a proration for that period. cancel_at_period_end: description: >- Boolean indicating whether this subscription should cancel at the end of the current period. type: boolean cancellation_details: description: Details about why this subscription was cancelled properties: comment: anyOf: - maxLength: 5000 type: string - enum: - '' type: string feedback: enum: - '' - customer_service - low_quality - missing_features - other - switched_service - too_complex - too_expensive - unused type: string title: cancellation_details_param type: object collection_method: description: >- 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`. Defaults to `charge_automatically`. enum: - charge_automatically - send_invoice type: string coupon: description: >- The ID of the coupon to apply to this subscription. A coupon applied to a subscription will only affect invoices created for that particular subscription. This field has been deprecated and will be removed in a future API version. Use `discounts` instead. maxLength: 5000 type: string days_until_due: description: >- Number of days a customer has to pay invoices generated by this subscription. Valid only for subscriptions where `collection_method` is set to `send_invoice`. type: integer default_payment_method: description: >- 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). maxLength: 5000 type: string default_source: anyOf: - maxLength: 5000 type: string - enum: - '' type: string description: >- 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: anyOf: - items: maxLength: 5000 type: string type: array - enum: - '' type: string description: >- 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. Pass an empty string to remove previously-defined tax rates. discounts: anyOf: - items: properties: coupon: maxLength: 5000 type: string discount: maxLength: 5000 type: string promotion_code: maxLength: 5000 type: string title: discounts_data_param type: object type: array - enum: - '' type: string description: >- The coupons to redeem into discounts for the subscription. If not specified or empty, inherits the discount from the subscription's customer. expand: description: Specifies which fields in the response should be expanded. items: maxLength: 5000 type: string type: array invoice_settings: description: All invoices will be billed using the specified settings. properties: account_tax_ids: anyOf: - items: maxLength: 5000 type: string type: array - enum: - '' type: string issuer: properties: account: type: string type: enum: - account - self type: string required: - type title: param type: object title: invoice_settings_param type: object items: description: >- A list of up to 20 subscription items, each with an attached price. items: properties: billing_thresholds: anyOf: - properties: usage_gte: type: integer required: - usage_gte title: item_billing_thresholds_param type: object - enum: - '' type: string clear_usage: type: boolean deleted: type: boolean discounts: anyOf: - items: properties: coupon: maxLength: 5000 type: string discount: maxLength: 5000 type: string promotion_code: maxLength: 5000 type: string title: discounts_data_param type: object type: array - enum: - '' type: string id: maxLength: 5000 type: string metadata: anyOf: - additionalProperties: type: string type: object - enum: - '' type: string price: maxLength: 5000 type: string price_data: properties: currency: type: string product: maxLength: 5000 type: string recurring: properties: interval: enum: - day - month - week - year type: string interval_count: type: integer required: - interval title: recurring_adhoc type: object tax_behavior: enum: - exclusive - inclusive - unspecified type: string unit_amount: type: integer unit_amount_decimal: format: decimal type: string required: - currency - product - recurring title: recurring_price_data type: object quantity: type: integer tax_rates: anyOf: - items: maxLength: 5000 type: string type: array - enum: - '' type: string title: subscription_item_update_params type: object type: array metadata: anyOf: - additionalProperties: type: string type: object - enum: - '' type: string description: >- Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. off_session: description: >- Indicates if a customer is on or off-session while an invoice payment is attempted. type: boolean pause_collection: anyOf: - properties: behavior: enum: - keep_as_draft - mark_uncollectible - void type: string resumes_at: format: unix-time type: integer required: - behavior title: pause_collection_param type: object - enum: - '' type: string description: >- If specified, payment collection for this subscription will be paused. Note that the subscription status will be unchanged and will not be updated to `paused`. Learn more about [pausing collection](/billing/subscriptions/pause-payment). payment_behavior: description: >- Use `allow_incomplete` to transition the subscription to `status=past_due` if a payment is required but cannot be paid. This allows you to manage scenarios where additional user actions are needed to pay a subscription's invoice. For example, SCA regulation may require 3DS authentication to complete payment. See the [SCA Migration Guide](https://stripe.com/docs/billing/migration/strong-customer-authentication) for Billing to learn more. This is the default behavior. Use `default_incomplete` to transition the subscription to `status=past_due` when payment is required and await explicit confirmation of the invoice's payment intent. This allows simpler management of scenarios where additional user actions are needed to pay a subscription’s invoice. Such as failed payments, [SCA regulation](https://stripe.com/docs/billing/migration/strong-customer-authentication), or collecting a mandate for a bank debit payment method. Use `pending_if_incomplete` to update the subscription using [pending updates](https://stripe.com/docs/billing/subscriptions/pending-updates). When you use `pending_if_incomplete` you can only pass the parameters [supported by pending updates](https://stripe.com/docs/billing/pending-updates-reference#supported-attributes). Use `error_if_incomplete` if you want Stripe to return an HTTP 402 status code if a subscription's invoice cannot be paid. For example, if a payment method requires 3DS authentication due to SCA regulation and further user action is needed, this parameter does not update the subscription and returns an error instead. This was the default behavior for API versions prior to 2019-03-14. See the [changelog](https://stripe.com/docs/upgrades#2019-03-14) to learn more. enum: - allow_incomplete - default_incomplete - error_if_incomplete - pending_if_incomplete type: string payment_settings: description: >- Payment settings to pass to invoices created by the subscription. properties: payment_method_options: properties: acss_debit: anyOf: - properties: mandate_options: properties: transaction_type: enum: - business - personal type: string title: mandate_options_param type: object verification_method: enum: - automatic - instant - microdeposits type: string x-stripeBypassValidation: true title: invoice_payment_method_options_param type: object - enum: - '' type: string bancontact: anyOf: - properties: preferred_language: enum: - de - en - fr - nl type: string title: invoice_payment_method_options_param type: object - enum: - '' type: string card: anyOf: - properties: mandate_options: properties: amount: type: integer amount_type: enum: - fixed - maximum type: string description: maxLength: 200 type: string title: mandate_options_param type: object network: enum: - amex - cartes_bancaires - diners - discover - eftpos_au - interac - jcb - mastercard - unionpay - unknown - visa maxLength: 5000 type: string x-stripeBypassValidation: true request_three_d_secure: enum: - any - automatic - challenge type: string title: subscription_payment_method_options_param type: object - enum: - '' type: string customer_balance: anyOf: - properties: bank_transfer: properties: eu_bank_transfer: properties: country: maxLength: 5000 type: string required: - country title: eu_bank_transfer_param type: object type: type: string title: bank_transfer_param type: object funding_type: type: string title: invoice_payment_method_options_param type: object - enum: - '' type: string konbini: anyOf: - properties: {} title: invoice_payment_method_options_param type: object - enum: - '' type: string sepa_debit: anyOf: - properties: {} title: invoice_payment_method_options_param type: object - enum: - '' type: string us_bank_account: anyOf: - properties: financial_connections: properties: permissions: items: enum: - balances - ownership - payment_method - transactions maxLength: 5000 type: string x-stripeBypassValidation: true type: array prefetch: items: enum: - balances - ownership - transactions type: string x-stripeBypassValidation: true type: array title: invoice_linked_account_options_param type: object verification_method: enum: - automatic - instant - microdeposits type: string x-stripeBypassValidation: true title: invoice_payment_method_options_param type: object - enum: - '' type: string title: payment_method_options type: object payment_method_types: anyOf: - items: enum: - ach_credit_transfer - ach_debit - acss_debit - au_becs_debit - bacs_debit - bancontact - boleto - card - cashapp - customer_balance - eps - fpx - giropay - grabpay - ideal - konbini - link - p24 - paynow - paypal - promptpay - sepa_debit - sofort - us_bank_account - wechat_pay type: string x-stripeBypassValidation: true type: array - enum: - '' type: string save_default_payment_method: enum: - 'off' - on_subscription type: string title: payment_settings type: object pending_invoice_item_interval: anyOf: - properties: interval: enum: - day - month - week - year type: string interval_count: type: integer required: - interval title: pending_invoice_item_interval_params type: object - enum: - '' type: string description: >- Specifies an interval for how often to bill for any pending invoice items. It is analogous to calling [Create an invoice](https://stripe.com/docs/api#create_invoice) for the given subscription at the specified interval. promotion_code: description: >- The promotion code to apply to this subscription. A promotion code applied to a subscription will only affect invoices created for that particular subscription. maxLength: 5000 type: string proration_behavior: description: >- Determines how to handle [prorations](https://stripe.com/docs/billing/subscriptions/prorations) when the billing cycle changes (e.g., when switching plans, resetting `billing_cycle_anchor=now`, or starting a trial), or if an item's `quantity` changes. The default value is `create_prorations`. enum: - always_invoice - create_prorations - none type: string proration_date: description: >- If set, the proration will be calculated as though the subscription was updated at the given time. This can be used to apply exactly the same proration that was previewed with [upcoming invoice](https://stripe.com/docs/api#upcoming_invoice) endpoint. It can also be used to implement custom proration logic, such as prorating by day instead of by second, by providing the time that you wish to use for proration calculations. format: unix-time type: integer transfer_data: anyOf: - properties: amount_percent: type: number destination: type: string required: - destination title: transfer_data_specs type: object - enum: - '' type: string description: >- If specified, the funds from the subscription's invoices will be transferred to the destination and the ID of the resulting transfers will be found on the resulting charges. This will be unset if you POST an empty value. trial_end: anyOf: - enum: - now maxLength: 5000 type: string - format: unix-time type: integer description: >- Unix timestamp representing the end of the trial period the customer will get before being charged for the first time. This will always overwrite any trials that might apply via a subscribed plan. If set, trial_end will override the default trial period of the plan the customer is being subscribed to. The special value `now` can be provided to end the customer's trial immediately. Can be at most two years from `billing_cycle_anchor`. trial_from_plan: description: >- Indicates if a plan's `trial_period_days` should be applied to the subscription. Setting `trial_end` per subscription is preferred, and this defaults to `false`. Setting this flag to `true` together with `trial_end` is not allowed. See [Using trial periods on subscriptions](https://stripe.com/docs/billing/subscriptions/trials) to learn more. type: boolean trial_settings: description: Settings related to subscription trials. properties: end_behavior: properties: missing_payment_method: enum: - cancel - create_invoice - pause type: string required: - missing_payment_method title: end_behavior type: object required: - end_behavior title: trial_settings_config type: object type: object required: false responses: '200': content: application/json: schema: $ref: '#/components/schemas/subscription' description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. '/v1/customers/{customer}/subscriptions/{subscription_exposed_id}/discount': delete: description:

Removes the currently applied discount on a customer.

operationId: DeleteCustomersCustomerSubscriptionsSubscriptionExposedIdDiscount parameters: - in: path name: customer required: true schema: maxLength: 5000 type: string style: simple - in: path name: subscription_exposed_id required: true schema: maxLength: 5000 type: string style: simple requestBody: content: application/x-www-form-urlencoded: encoding: {} schema: additionalProperties: false properties: {} type: object required: false responses: '200': content: application/json: schema: $ref: '#/components/schemas/deleted_discount' description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. get: description: '' operationId: GetCustomersCustomerSubscriptionsSubscriptionExposedIdDiscount parameters: - in: path name: customer required: true schema: maxLength: 5000 type: string style: simple - description: Specifies which fields in the response should be expanded. explode: true in: query name: expand required: false schema: items: maxLength: 5000 type: string type: array style: deepObject - in: path name: subscription_exposed_id required: true schema: maxLength: 5000 type: string style: simple requestBody: content: application/x-www-form-urlencoded: encoding: {} schema: additionalProperties: false properties: {} type: object required: false responses: '200': content: application/json: schema: $ref: '#/components/schemas/discount' description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. '/v1/customers/{customer}/tax_ids': get: description:

Returns a list of tax IDs for a customer.

operationId: GetCustomersCustomerTaxIds parameters: - in: path name: customer required: true schema: maxLength: 5000 type: string style: simple - description: >- A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. in: query name: ending_before required: false schema: maxLength: 5000 type: string style: form - description: Specifies which fields in the response should be expanded. explode: true in: query name: expand required: false schema: items: maxLength: 5000 type: string type: array style: deepObject - description: >- A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. in: query name: limit required: false schema: type: integer style: form - description: >- A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. in: query name: starting_after required: false schema: maxLength: 5000 type: string style: form requestBody: content: application/x-www-form-urlencoded: encoding: {} schema: additionalProperties: false properties: {} type: object required: false responses: '200': content: application/json: schema: description: '' properties: data: description: Details about each object. items: $ref: '#/components/schemas/tax_id' type: array has_more: description: >- True if this list has another page of items after this one that can be fetched. type: boolean object: description: >- String representing the object's type. Objects of the same type share the same value. Always has the value `list`. enum: - list type: string url: description: The URL where this list can be accessed. maxLength: 5000 type: string required: - data - has_more - object - url title: TaxIDsList type: object x-expandableFields: - data description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. post: description:

Creates a new tax_id object for a customer.

operationId: PostCustomersCustomerTaxIds parameters: - in: path name: customer required: true schema: maxLength: 5000 type: string style: simple requestBody: content: application/x-www-form-urlencoded: encoding: expand: explode: true style: deepObject schema: additionalProperties: false properties: expand: description: Specifies which fields in the response should be expanded. items: maxLength: 5000 type: string type: array type: description: >- Type of the tax ID, one of `ad_nrt`, `ae_trn`, `ar_cuit`, `au_abn`, `au_arn`, `bg_uic`, `bh_vat`, `bo_tin`, `br_cnpj`, `br_cpf`, `ca_bn`, `ca_gst_hst`, `ca_pst_bc`, `ca_pst_mb`, `ca_pst_sk`, `ca_qst`, `ch_vat`, `cl_tin`, `cn_tin`, `co_nit`, `cr_tin`, `do_rcn`, `ec_ruc`, `eg_tin`, `es_cif`, `eu_oss_vat`, `eu_vat`, `gb_vat`, `ge_vat`, `hk_br`, `hu_tin`, `id_npwp`, `il_vat`, `in_gst`, `is_vat`, `jp_cn`, `jp_rn`, `jp_trn`, `ke_pin`, `kr_brn`, `kz_bin`, `li_uid`, `mx_rfc`, `my_frp`, `my_itn`, `my_sst`, `ng_tin`, `no_vat`, `no_voec`, `nz_gst`, `om_vat`, `pe_ruc`, `ph_tin`, `ro_tin`, `rs_pib`, `ru_inn`, `ru_kpp`, `sa_vat`, `sg_gst`, `sg_uen`, `si_tin`, `sv_nit`, `th_vat`, `tr_tin`, `tw_vat`, `ua_vat`, `us_ein`, `uy_ruc`, `ve_rif`, `vn_tin`, or `za_vat` enum: - ad_nrt - ae_trn - ar_cuit - au_abn - au_arn - bg_uic - bh_vat - bo_tin - br_cnpj - br_cpf - ca_bn - ca_gst_hst - ca_pst_bc - ca_pst_mb - ca_pst_sk - ca_qst - ch_vat - cl_tin - cn_tin - co_nit - cr_tin - do_rcn - ec_ruc - eg_tin - es_cif - eu_oss_vat - eu_vat - gb_vat - ge_vat - hk_br - hu_tin - id_npwp - il_vat - in_gst - is_vat - jp_cn - jp_rn - jp_trn - ke_pin - kr_brn - kz_bin - li_uid - mx_rfc - my_frp - my_itn - my_sst - ng_tin - no_vat - no_voec - nz_gst - om_vat - pe_ruc - ph_tin - ro_tin - rs_pib - ru_inn - ru_kpp - sa_vat - sg_gst - sg_uen - si_tin - sv_nit - th_vat - tr_tin - tw_vat - ua_vat - us_ein - uy_ruc - ve_rif - vn_tin - za_vat maxLength: 5000 type: string x-stripeBypassValidation: true value: description: Value of the tax ID. type: string required: - type - value type: object required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/tax_id' description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. '/v1/customers/{customer}/tax_ids/{id}': delete: description:

Deletes an existing tax_id object.

operationId: DeleteCustomersCustomerTaxIdsId parameters: - in: path name: customer required: true schema: maxLength: 5000 type: string style: simple - in: path name: id required: true schema: type: string style: simple requestBody: content: application/x-www-form-urlencoded: encoding: {} schema: additionalProperties: false properties: {} type: object required: false responses: '200': content: application/json: schema: $ref: '#/components/schemas/deleted_tax_id' description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. get: description: >-

Retrieves the tax_id object with the given identifier.

operationId: GetCustomersCustomerTaxIdsId parameters: - in: path name: customer required: true schema: maxLength: 5000 type: string style: simple - description: Specifies which fields in the response should be expanded. explode: true in: query name: expand required: false schema: items: maxLength: 5000 type: string type: array style: deepObject - in: path name: id required: true schema: type: string style: simple requestBody: content: application/x-www-form-urlencoded: encoding: {} schema: additionalProperties: false properties: {} type: object required: false responses: '200': content: application/json: schema: $ref: '#/components/schemas/tax_id' description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. /v1/disputes: get: description:

Returns a list of your disputes.

operationId: GetDisputes parameters: - description: >- Only return disputes associated to the charge specified by this charge ID. in: query name: charge required: false schema: maxLength: 5000 type: string style: form - explode: true in: query name: created required: false schema: anyOf: - properties: gt: type: integer gte: type: integer lt: type: integer lte: type: integer title: range_query_specs type: object - type: integer style: deepObject - description: >- A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. in: query name: ending_before required: false schema: maxLength: 5000 type: string style: form - description: Specifies which fields in the response should be expanded. explode: true in: query name: expand required: false schema: items: maxLength: 5000 type: string type: array style: deepObject - description: >- A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. in: query name: limit required: false schema: type: integer style: form - description: >- Only return disputes associated to the PaymentIntent specified by this PaymentIntent ID. in: query name: payment_intent required: false schema: maxLength: 5000 type: string style: form - description: >- A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. in: query name: starting_after required: false schema: maxLength: 5000 type: string style: form requestBody: content: application/x-www-form-urlencoded: encoding: {} schema: additionalProperties: false properties: {} type: object required: false responses: '200': content: application/json: schema: description: '' properties: data: items: $ref: '#/components/schemas/dispute' type: array has_more: description: >- True if this list has another page of items after this one that can be fetched. type: boolean object: description: >- String representing the object's type. Objects of the same type share the same value. Always has the value `list`. enum: - list type: string url: description: The URL where this list can be accessed. maxLength: 5000 pattern: ^/v1/disputes type: string required: - data - has_more - object - url title: DisputeList type: object x-expandableFields: - data description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. '/v1/disputes/{dispute}': get: description:

Retrieves the dispute with the given ID.

operationId: GetDisputesDispute parameters: - in: path name: dispute required: true schema: maxLength: 5000 type: string style: simple - description: Specifies which fields in the response should be expanded. explode: true in: query name: expand required: false schema: items: maxLength: 5000 type: string type: array style: deepObject requestBody: content: application/x-www-form-urlencoded: encoding: {} schema: additionalProperties: false properties: {} type: object required: false responses: '200': content: application/json: schema: $ref: '#/components/schemas/dispute' description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. post: description: >-

When you get a dispute, contacting your customer is always the best first step. If that doesn’t work, you can submit evidence to help us resolve the dispute in your favor. You can do this in your dashboard, but if you prefer, you can use the API to submit evidence programmatically.

Depending on your dispute type, different evidence fields will give you a better chance of winning your dispute. To figure out which evidence fields to provide, see our guide to dispute types.

operationId: PostDisputesDispute parameters: - in: path name: dispute required: true schema: maxLength: 5000 type: string style: simple requestBody: content: application/x-www-form-urlencoded: encoding: evidence: explode: true style: deepObject expand: explode: true style: deepObject metadata: explode: true style: deepObject schema: additionalProperties: false properties: evidence: description: >- Evidence to upload, to respond to a dispute. Updating any field in the hash will submit all fields in the hash for review. The combined character count of all fields is limited to 150,000. properties: access_activity_log: maxLength: 20000 type: string billing_address: maxLength: 5000 type: string cancellation_policy: type: string cancellation_policy_disclosure: maxLength: 20000 type: string cancellation_rebuttal: maxLength: 20000 type: string customer_communication: type: string customer_email_address: maxLength: 5000 type: string customer_name: maxLength: 5000 type: string customer_purchase_ip: maxLength: 5000 type: string customer_signature: type: string duplicate_charge_documentation: type: string duplicate_charge_explanation: maxLength: 20000 type: string duplicate_charge_id: maxLength: 5000 type: string product_description: maxLength: 20000 type: string receipt: type: string refund_policy: type: string refund_policy_disclosure: maxLength: 20000 type: string refund_refusal_explanation: maxLength: 20000 type: string service_date: maxLength: 5000 type: string service_documentation: type: string shipping_address: maxLength: 5000 type: string shipping_carrier: maxLength: 5000 type: string shipping_date: maxLength: 5000 type: string shipping_documentation: type: string shipping_tracking_number: maxLength: 5000 type: string uncategorized_file: type: string uncategorized_text: maxLength: 20000 type: string title: dispute_evidence_params type: object expand: description: Specifies which fields in the response should be expanded. items: maxLength: 5000 type: string type: array metadata: anyOf: - additionalProperties: type: string type: object - enum: - '' type: string description: >- Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. submit: description: >- Whether to immediately submit evidence to the bank. If `false`, evidence is staged on the dispute. Staged evidence is visible in the API and Dashboard, and can be submitted to the bank by making another request with this attribute set to `true` (the default). type: boolean type: object required: false responses: '200': content: application/json: schema: $ref: '#/components/schemas/dispute' description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. '/v1/disputes/{dispute}/close': post: description: >-

Closing the dispute for a charge indicates that you do not have any evidence to submit and are essentially dismissing the dispute, acknowledging it as lost.

The status of the dispute will change from needs_response to lost. Closing a dispute is irreversible.

operationId: PostDisputesDisputeClose parameters: - in: path name: dispute required: true schema: maxLength: 5000 type: string style: simple requestBody: content: application/x-www-form-urlencoded: encoding: expand: explode: true style: deepObject schema: additionalProperties: false properties: expand: description: Specifies which fields in the response should be expanded. items: maxLength: 5000 type: string type: array type: object required: false responses: '200': content: application/json: schema: $ref: '#/components/schemas/dispute' description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. /v1/entitlements/active_entitlements: get: description:

Retrieve a list of active entitlements for a customer

operationId: GetEntitlementsActiveEntitlements parameters: - description: The ID of the customer. in: query name: customer required: true schema: maxLength: 5000 type: string style: form - description: >- A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. in: query name: ending_before required: false schema: maxLength: 5000 type: string style: form - description: Specifies which fields in the response should be expanded. explode: true in: query name: expand required: false schema: items: maxLength: 5000 type: string type: array style: deepObject - description: >- A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. in: query name: limit required: false schema: type: integer style: form - description: >- A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. in: query name: starting_after required: false schema: maxLength: 5000 type: string style: form requestBody: content: application/x-www-form-urlencoded: encoding: {} schema: additionalProperties: false properties: {} type: object required: false responses: '200': content: application/json: schema: description: '' properties: data: items: $ref: '#/components/schemas/entitlements.active_entitlement' type: array has_more: description: >- True if this list has another page of items after this one that can be fetched. type: boolean object: description: >- String representing the object's type. Objects of the same type share the same value. Always has the value `list`. enum: - list type: string url: description: The URL where this list can be accessed. maxLength: 5000 type: string required: - data - has_more - object - url title: EntitlementsResourceCustomerEntitlementList type: object x-expandableFields: - data description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. '/v1/entitlements/active_entitlements/{id}': get: description:

Retrieve an active entitlement

operationId: GetEntitlementsActiveEntitlementsId parameters: - description: Specifies which fields in the response should be expanded. explode: true in: query name: expand required: false schema: items: maxLength: 5000 type: string type: array style: deepObject - description: The ID of the entitlement. in: path name: id required: true schema: maxLength: 5000 type: string style: simple requestBody: content: application/x-www-form-urlencoded: encoding: {} schema: additionalProperties: false properties: {} type: object required: false responses: '200': content: application/json: schema: $ref: '#/components/schemas/entitlements.active_entitlement' description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. /v1/entitlements/features: get: description:

Retrieve a list of features

operationId: GetEntitlementsFeatures parameters: - description: >- A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. in: query name: ending_before required: false schema: maxLength: 5000 type: string style: form - description: Specifies which fields in the response should be expanded. explode: true in: query name: expand required: false schema: items: maxLength: 5000 type: string type: array style: deepObject - description: >- A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. in: query name: limit required: false schema: type: integer style: form - description: >- A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. in: query name: starting_after required: false schema: maxLength: 5000 type: string style: form requestBody: content: application/x-www-form-urlencoded: encoding: {} schema: additionalProperties: false properties: {} type: object required: false responses: '200': content: application/json: schema: description: '' properties: data: items: $ref: '#/components/schemas/entitlements.feature' type: array has_more: description: >- True if this list has another page of items after this one that can be fetched. type: boolean object: description: >- String representing the object's type. Objects of the same type share the same value. Always has the value `list`. enum: - list type: string url: description: The URL where this list can be accessed. maxLength: 5000 pattern: ^/v1/entitlements/features type: string required: - data - has_more - object - url title: EntitlementsResourceFeatureList type: object x-expandableFields: - data description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. post: description:

Creates a feature

operationId: PostEntitlementsFeatures requestBody: content: application/x-www-form-urlencoded: encoding: expand: explode: true style: deepObject metadata: explode: true style: deepObject schema: additionalProperties: false properties: expand: description: Specifies which fields in the response should be expanded. items: maxLength: 5000 type: string type: array lookup_key: description: >- A unique key you provide as your own system identifier. This may be up to 80 characters. maxLength: 80 type: string metadata: additionalProperties: type: string description: >- Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format. type: object name: description: >- The feature's name, for your own purpose, not meant to be displayable to the customer. maxLength: 80 type: string required: - lookup_key - name type: object required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/entitlements.feature' description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. '/v1/entitlements/features/{id}': get: description:

Retrieves a feature

operationId: GetEntitlementsFeaturesId parameters: - description: Specifies which fields in the response should be expanded. explode: true in: query name: expand required: false schema: items: maxLength: 5000 type: string type: array style: deepObject - description: The ID of the feature. in: path name: id required: true schema: maxLength: 5000 type: string style: simple requestBody: content: application/x-www-form-urlencoded: encoding: {} schema: additionalProperties: false properties: {} type: object required: false responses: '200': content: application/json: schema: $ref: '#/components/schemas/entitlements.feature' description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. post: description:

Update a feature’s metadata or permanently deactivate it.

operationId: PostEntitlementsFeaturesId parameters: - in: path name: id required: true schema: maxLength: 5000 type: string style: simple requestBody: content: application/x-www-form-urlencoded: encoding: expand: explode: true style: deepObject metadata: explode: true style: deepObject schema: additionalProperties: false properties: active: description: >- Inactive features cannot be attached to new products and will not be returned from the features list endpoint. type: boolean expand: description: Specifies which fields in the response should be expanded. items: maxLength: 5000 type: string type: array metadata: additionalProperties: type: string description: >- Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format. type: object name: description: >- The feature's name, for your own purpose, not meant to be displayable to the customer. maxLength: 80 type: string type: object required: false responses: '200': content: application/json: schema: $ref: '#/components/schemas/entitlements.feature' description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. /v1/ephemeral_keys: post: description:

Creates a short-lived API key for a given resource.

operationId: PostEphemeralKeys requestBody: content: application/x-www-form-urlencoded: encoding: expand: explode: true style: deepObject schema: additionalProperties: false properties: customer: description: >- The ID of the Customer you'd like to modify using the resulting ephemeral key. maxLength: 5000 type: string expand: description: Specifies which fields in the response should be expanded. items: maxLength: 5000 type: string type: array issuing_card: description: >- The ID of the Issuing Card you'd like to access using the resulting ephemeral key. maxLength: 5000 type: string nonce: description: >- A single-use token, created by Stripe.js, used for creating ephemeral keys for Issuing Cards without exchanging sensitive information. maxLength: 5000 type: string verification_session: description: >- The ID of the Identity VerificationSession you'd like to access using the resulting ephemeral key maxLength: 5000 type: string type: object required: false responses: '200': content: application/json: schema: $ref: '#/components/schemas/ephemeral_key' description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. '/v1/ephemeral_keys/{key}': delete: description:

Invalidates a short-lived API key for a given resource.

operationId: DeleteEphemeralKeysKey parameters: - in: path name: key required: true schema: maxLength: 5000 type: string style: simple requestBody: content: application/x-www-form-urlencoded: encoding: expand: explode: true style: deepObject schema: additionalProperties: false properties: expand: description: Specifies which fields in the response should be expanded. items: maxLength: 5000 type: string type: array type: object required: false responses: '200': content: application/json: schema: $ref: '#/components/schemas/ephemeral_key' description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. /v1/events: get: description: >-

List events, going back up to 30 days. Each event data is rendered according to Stripe API version at its creation time, specified in event object api_version attribute (not according to your current Stripe API version or Stripe-Version header).

operationId: GetEvents parameters: - description: Only return events that were created during the given date interval. explode: true in: query name: created required: false schema: anyOf: - properties: gt: type: integer gte: type: integer lt: type: integer lte: type: integer title: range_query_specs type: object - type: integer style: deepObject - description: >- Filter events by whether all webhooks were successfully delivered. If false, events which are still pending or have failed all delivery attempts to a webhook endpoint will be returned. in: query name: delivery_success required: false schema: type: boolean style: form - description: >- A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. in: query name: ending_before required: false schema: maxLength: 5000 type: string style: form - description: Specifies which fields in the response should be expanded. explode: true in: query name: expand required: false schema: items: maxLength: 5000 type: string type: array style: deepObject - description: >- A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. in: query name: limit required: false schema: type: integer style: form - description: >- A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. in: query name: starting_after required: false schema: maxLength: 5000 type: string style: form - description: >- A string containing a specific event name, or group of events using * as a wildcard. The list will be filtered to include only events with a matching event property. in: query name: type required: false schema: maxLength: 5000 type: string style: form - description: >- An array of up to 20 strings containing specific event names. The list will be filtered to include only events with a matching event property. You may pass either `type` or `types`, but not both. explode: true in: query name: types required: false schema: items: maxLength: 5000 type: string type: array style: deepObject requestBody: content: application/x-www-form-urlencoded: encoding: {} schema: additionalProperties: false properties: {} type: object required: false responses: '200': content: application/json: schema: description: '' properties: data: items: $ref: '#/components/schemas/event' type: array has_more: description: >- True if this list has another page of items after this one that can be fetched. type: boolean object: description: >- String representing the object's type. Objects of the same type share the same value. Always has the value `list`. enum: - list type: string url: description: The URL where this list can be accessed. maxLength: 5000 pattern: ^/v1/events type: string required: - data - has_more - object - url title: NotificationEventList type: object x-expandableFields: - data description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. '/v1/events/{id}': get: description: >-

Retrieves the details of an event. Supply the unique identifier of the event, which you might have received in a webhook.

operationId: GetEventsId parameters: - description: Specifies which fields in the response should be expanded. explode: true in: query name: expand required: false schema: items: maxLength: 5000 type: string type: array style: deepObject - in: path name: id required: true schema: maxLength: 5000 type: string style: simple requestBody: content: application/x-www-form-urlencoded: encoding: {} schema: additionalProperties: false properties: {} type: object required: false responses: '200': content: application/json: schema: $ref: '#/components/schemas/event' description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. /v1/exchange_rates: get: description: >-

Returns a list of objects that contain the rates at which foreign currencies are converted to one another. Only shows the currencies for which Stripe supports.

operationId: GetExchangeRates parameters: - description: >- A cursor for use in pagination. `ending_before` is the currency that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with the exchange rate for currency X your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. in: query name: ending_before required: false schema: maxLength: 5000 type: string style: form - description: Specifies which fields in the response should be expanded. explode: true in: query name: expand required: false schema: items: maxLength: 5000 type: string type: array style: deepObject - description: >- A limit on the number of objects to be returned. Limit can range between 1 and total number of supported payout currencies, and the default is the max. in: query name: limit required: false schema: type: integer style: form - description: >- A cursor for use in pagination. `starting_after` is the currency that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with the exchange rate for currency X, your subsequent call can include `starting_after=X` in order to fetch the next page of the list. in: query name: starting_after required: false schema: maxLength: 5000 type: string style: form requestBody: content: application/x-www-form-urlencoded: encoding: {} schema: additionalProperties: false properties: {} type: object required: false responses: '200': content: application/json: schema: description: '' properties: data: items: $ref: '#/components/schemas/exchange_rate' type: array has_more: description: >- True if this list has another page of items after this one that can be fetched. type: boolean object: description: >- String representing the object's type. Objects of the same type share the same value. Always has the value `list`. enum: - list type: string url: description: The URL where this list can be accessed. maxLength: 5000 pattern: ^/v1/exchange_rates type: string required: - data - has_more - object - url title: ExchangeRateList type: object x-expandableFields: - data description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. '/v1/exchange_rates/{rate_id}': get: description: >-

Retrieves the exchange rates from the given currency to every supported currency.

operationId: GetExchangeRatesRateId parameters: - description: Specifies which fields in the response should be expanded. explode: true in: query name: expand required: false schema: items: maxLength: 5000 type: string type: array style: deepObject - in: path name: rate_id required: true schema: maxLength: 5000 type: string style: simple requestBody: content: application/x-www-form-urlencoded: encoding: {} schema: additionalProperties: false properties: {} type: object required: false responses: '200': content: application/json: schema: $ref: '#/components/schemas/exchange_rate' description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. /v1/file_links: get: description:

Returns a list of file links.

operationId: GetFileLinks parameters: - description: Only return links that were created during the given date interval. explode: true in: query name: created required: false schema: anyOf: - properties: gt: type: integer gte: type: integer lt: type: integer lte: type: integer title: range_query_specs type: object - type: integer style: deepObject - description: >- A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. in: query name: ending_before required: false schema: type: string style: form - description: Specifies which fields in the response should be expanded. explode: true in: query name: expand required: false schema: items: maxLength: 5000 type: string type: array style: deepObject - description: >- Filter links by their expiration status. By default, Stripe returns all links. in: query name: expired required: false schema: type: boolean style: form - description: Only return links for the given file. in: query name: file required: false schema: maxLength: 5000 type: string style: form - description: >- A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. in: query name: limit required: false schema: type: integer style: form - description: >- A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. in: query name: starting_after required: false schema: type: string style: form requestBody: content: application/x-www-form-urlencoded: encoding: {} schema: additionalProperties: false properties: {} type: object required: false responses: '200': content: application/json: schema: description: '' properties: data: description: Details about each object. items: $ref: '#/components/schemas/file_link' type: array has_more: description: >- True if this list has another page of items after this one that can be fetched. type: boolean object: description: >- String representing the object's type. Objects of the same type share the same value. Always has the value `list`. enum: - list type: string url: description: The URL where this list can be accessed. maxLength: 5000 pattern: ^/v1/file_links type: string required: - data - has_more - object - url title: FileResourceFileLinkList type: object x-expandableFields: - data description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. post: description:

Creates a new file link object.

operationId: PostFileLinks requestBody: content: application/x-www-form-urlencoded: encoding: expand: explode: true style: deepObject metadata: explode: true style: deepObject schema: additionalProperties: false properties: expand: description: Specifies which fields in the response should be expanded. items: maxLength: 5000 type: string type: array expires_at: description: The link isn't usable after this future timestamp. format: unix-time type: integer file: description: >- The ID of the file. The file's `purpose` must be one of the following: `business_icon`, `business_logo`, `customer_signature`, `dispute_evidence`, `finance_report_run`, `identity_document_downloadable`, `pci_document`, `selfie`, `sigma_scheduled_query`, `tax_document_user_upload`, or `terminal_reader_splashscreen`. maxLength: 5000 type: string metadata: anyOf: - additionalProperties: type: string type: object - enum: - '' type: string description: >- Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. required: - file type: object required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/file_link' description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. '/v1/file_links/{link}': get: description:

Retrieves the file link with the given ID.

operationId: GetFileLinksLink parameters: - description: Specifies which fields in the response should be expanded. explode: true in: query name: expand required: false schema: items: maxLength: 5000 type: string type: array style: deepObject - in: path name: link required: true schema: type: string style: simple requestBody: content: application/x-www-form-urlencoded: encoding: {} schema: additionalProperties: false properties: {} type: object required: false responses: '200': content: application/json: schema: $ref: '#/components/schemas/file_link' description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. post: description: >-

Updates an existing file link object. Expired links can no longer be updated.

operationId: PostFileLinksLink parameters: - in: path name: link required: true schema: type: string style: simple requestBody: content: application/x-www-form-urlencoded: encoding: expand: explode: true style: deepObject expires_at: explode: true style: deepObject metadata: explode: true style: deepObject schema: additionalProperties: false properties: expand: description: Specifies which fields in the response should be expanded. items: maxLength: 5000 type: string type: array expires_at: anyOf: - enum: - now maxLength: 5000 type: string - format: unix-time type: integer - enum: - '' type: string description: >- A future timestamp after which the link will no longer be usable, or `now` to expire the link immediately. metadata: anyOf: - additionalProperties: type: string type: object - enum: - '' type: string description: >- Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. type: object required: false responses: '200': content: application/json: schema: $ref: '#/components/schemas/file_link' description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. /v1/files: get: description: >-

Returns a list of the files that your account has access to. Stripe sorts and returns the files by their creation dates, placing the most recently created files at the top.

operationId: GetFiles parameters: - description: Only return files that were created during the given date interval. explode: true in: query name: created required: false schema: anyOf: - properties: gt: type: integer gte: type: integer lt: type: integer lte: type: integer title: range_query_specs type: object - type: integer style: deepObject - description: >- A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. in: query name: ending_before required: false schema: maxLength: 5000 type: string style: form - description: Specifies which fields in the response should be expanded. explode: true in: query name: expand required: false schema: items: maxLength: 5000 type: string type: array style: deepObject - description: >- A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. in: query name: limit required: false schema: type: integer style: form - description: >- Filter queries by the file purpose. If you don't provide a purpose, the queries return unfiltered files. in: query name: purpose required: false schema: enum: - account_requirement - additional_verification - business_icon - business_logo - customer_signature - dispute_evidence - document_provider_identity_document - finance_report_run - identity_document - identity_document_downloadable - pci_document - selfie - sigma_scheduled_query - tax_document_user_upload - terminal_reader_splashscreen maxLength: 5000 type: string x-stripeBypassValidation: true style: form - description: >- A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. in: query name: starting_after required: false schema: maxLength: 5000 type: string style: form requestBody: content: application/x-www-form-urlencoded: encoding: {} schema: additionalProperties: false properties: {} type: object required: false responses: '200': content: application/json: schema: description: '' properties: data: items: $ref: '#/components/schemas/file' type: array has_more: description: >- True if this list has another page of items after this one that can be fetched. type: boolean object: description: >- String representing the object's type. Objects of the same type share the same value. Always has the value `list`. enum: - list type: string url: description: The URL where this list can be accessed. maxLength: 5000 pattern: ^/v1/files type: string required: - data - has_more - object - url title: FileResourceFileList type: object x-expandableFields: - data description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. post: description: >-

To upload a file to Stripe, you need to send a request of type multipart/form-data. Include the file you want to upload in the request, and the parameters for creating a file.

All of Stripe’s officially supported Client libraries support sending multipart/form-data.

operationId: PostFiles requestBody: content: multipart/form-data: encoding: expand: explode: true style: deepObject file_link_data: explode: true style: deepObject schema: additionalProperties: false properties: expand: description: Specifies which fields in the response should be expanded. items: maxLength: 5000 type: string type: array file: description: >- A file to upload. Make sure that the specifications follow RFC 2388, which defines file transfers for the `multipart/form-data` protocol. format: binary type: string file_link_data: description: >- Optional parameters that automatically create a [file link](https://stripe.com/docs/api#file_links) for the newly created file. properties: create: type: boolean expires_at: format: unix-time type: integer metadata: anyOf: - additionalProperties: type: string type: object - enum: - '' type: string required: - create title: file_link_creation_params type: object purpose: description: >- The [purpose](https://stripe.com/docs/file-upload#uploading-a-file) of the uploaded file. enum: - account_requirement - additional_verification - business_icon - business_logo - customer_signature - dispute_evidence - identity_document - pci_document - tax_document_user_upload - terminal_reader_splashscreen type: string x-stripeBypassValidation: true required: - file - purpose type: object required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/file' description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. servers: - url: 'https://files.stripe.com/' '/v1/files/{file}': get: description: >-

Retrieves the details of an existing file object. After you supply a unique file ID, Stripe returns the corresponding file object. Learn how to access file contents.

operationId: GetFilesFile parameters: - description: Specifies which fields in the response should be expanded. explode: true in: query name: expand required: false schema: items: maxLength: 5000 type: string type: array style: deepObject - in: path name: file required: true schema: maxLength: 5000 type: string style: simple requestBody: content: application/x-www-form-urlencoded: encoding: {} schema: additionalProperties: false properties: {} type: object required: false responses: '200': content: application/json: schema: $ref: '#/components/schemas/file' description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. /v1/financial_connections/accounts: get: description: >-

Returns a list of Financial Connections Account objects.

operationId: GetFinancialConnectionsAccounts parameters: - description: >- If present, only return accounts that belong to the specified account holder. `account_holder[customer]` and `account_holder[account]` are mutually exclusive. explode: true in: query name: account_holder required: false schema: properties: account: maxLength: 5000 type: string customer: maxLength: 5000 type: string title: accountholder_params type: object style: deepObject - description: >- A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. in: query name: ending_before required: false schema: maxLength: 5000 type: string style: form - description: Specifies which fields in the response should be expanded. explode: true in: query name: expand required: false schema: items: maxLength: 5000 type: string type: array style: deepObject - description: >- A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. in: query name: limit required: false schema: type: integer style: form - description: >- If present, only return accounts that were collected as part of the given session. in: query name: session required: false schema: maxLength: 5000 type: string style: form - description: >- A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. in: query name: starting_after required: false schema: maxLength: 5000 type: string style: form requestBody: content: application/x-www-form-urlencoded: encoding: {} schema: additionalProperties: false properties: {} type: object required: false responses: '200': content: application/json: schema: description: '' properties: data: description: Details about each object. items: $ref: '#/components/schemas/financial_connections.account' type: array has_more: description: >- True if this list has another page of items after this one that can be fetched. type: boolean object: description: >- String representing the object's type. Objects of the same type share the same value. Always has the value `list`. enum: - list type: string url: description: The URL where this list can be accessed. maxLength: 5000 pattern: ^/v1/financial_connections/accounts type: string required: - data - has_more - object - url title: BankConnectionsResourceLinkedAccountList type: object x-expandableFields: - data description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. '/v1/financial_connections/accounts/{account}': get: description: >-

Retrieves the details of an Financial Connections Account.

operationId: GetFinancialConnectionsAccountsAccount parameters: - in: path name: account required: true schema: maxLength: 5000 type: string style: simple - description: Specifies which fields in the response should be expanded. explode: true in: query name: expand required: false schema: items: maxLength: 5000 type: string type: array style: deepObject requestBody: content: application/x-www-form-urlencoded: encoding: {} schema: additionalProperties: false properties: {} type: object required: false responses: '200': content: application/json: schema: $ref: '#/components/schemas/financial_connections.account' description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. '/v1/financial_connections/accounts/{account}/disconnect': post: description: >-

Disables your access to a Financial Connections Account. You will no longer be able to access data associated with the account (e.g. balances, transactions).

operationId: PostFinancialConnectionsAccountsAccountDisconnect parameters: - in: path name: account required: true schema: maxLength: 5000 type: string style: simple requestBody: content: application/x-www-form-urlencoded: encoding: expand: explode: true style: deepObject schema: additionalProperties: false properties: expand: description: Specifies which fields in the response should be expanded. items: maxLength: 5000 type: string type: array type: object required: false responses: '200': content: application/json: schema: $ref: '#/components/schemas/financial_connections.account' description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. '/v1/financial_connections/accounts/{account}/owners': get: description:

Lists all owners for a given Account

operationId: GetFinancialConnectionsAccountsAccountOwners parameters: - in: path name: account required: true schema: maxLength: 5000 type: string style: simple - description: >- A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. in: query name: ending_before required: false schema: maxLength: 5000 type: string style: form - description: Specifies which fields in the response should be expanded. explode: true in: query name: expand required: false schema: items: maxLength: 5000 type: string type: array style: deepObject - description: >- A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. in: query name: limit required: false schema: type: integer style: form - description: The ID of the ownership object to fetch owners from. in: query name: ownership required: true schema: maxLength: 5000 type: string style: form - description: >- A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. in: query name: starting_after required: false schema: maxLength: 5000 type: string style: form requestBody: content: application/x-www-form-urlencoded: encoding: {} schema: additionalProperties: false properties: {} type: object required: false responses: '200': content: application/json: schema: description: '' properties: data: description: Details about each object. items: $ref: '#/components/schemas/financial_connections.account_owner' type: array has_more: description: >- True if this list has another page of items after this one that can be fetched. type: boolean object: description: >- String representing the object's type. Objects of the same type share the same value. Always has the value `list`. enum: - list type: string url: description: The URL where this list can be accessed. maxLength: 5000 type: string required: - data - has_more - object - url title: BankConnectionsResourceOwnerList type: object x-expandableFields: - data description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. '/v1/financial_connections/accounts/{account}/refresh': post: description: >-

Refreshes the data associated with a Financial Connections Account.

operationId: PostFinancialConnectionsAccountsAccountRefresh parameters: - in: path name: account required: true schema: maxLength: 5000 type: string style: simple requestBody: content: application/x-www-form-urlencoded: encoding: expand: explode: true style: deepObject features: explode: true style: deepObject schema: additionalProperties: false properties: expand: description: Specifies which fields in the response should be expanded. items: maxLength: 5000 type: string type: array features: description: The list of account features that you would like to refresh. items: enum: - balance - ownership - transactions type: string x-stripeBypassValidation: true type: array required: - features type: object required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/financial_connections.account' description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. '/v1/financial_connections/accounts/{account}/subscribe': post: description: >-

Subscribes to periodic refreshes of data associated with a Financial Connections Account.

operationId: PostFinancialConnectionsAccountsAccountSubscribe parameters: - in: path name: account required: true schema: maxLength: 5000 type: string style: simple requestBody: content: application/x-www-form-urlencoded: encoding: expand: explode: true style: deepObject features: explode: true style: deepObject schema: additionalProperties: false properties: expand: description: Specifies which fields in the response should be expanded. items: maxLength: 5000 type: string type: array features: description: >- The list of account features to which you would like to subscribe. items: enum: - transactions type: string x-stripeBypassValidation: true type: array required: - features type: object required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/financial_connections.account' description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. '/v1/financial_connections/accounts/{account}/unsubscribe': post: description: >-

Unsubscribes from periodic refreshes of data associated with a Financial Connections Account.

operationId: PostFinancialConnectionsAccountsAccountUnsubscribe parameters: - in: path name: account required: true schema: maxLength: 5000 type: string style: simple requestBody: content: application/x-www-form-urlencoded: encoding: expand: explode: true style: deepObject features: explode: true style: deepObject schema: additionalProperties: false properties: expand: description: Specifies which fields in the response should be expanded. items: maxLength: 5000 type: string type: array features: description: >- The list of account features from which you would like to unsubscribe. items: enum: - transactions type: string x-stripeBypassValidation: true type: array required: - features type: object required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/financial_connections.account' description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. /v1/financial_connections/sessions: post: description: >-

To launch the Financial Connections authorization flow, create a Session. The session’s client_secret can be used to launch the flow using Stripe.js.

operationId: PostFinancialConnectionsSessions requestBody: content: application/x-www-form-urlencoded: encoding: account_holder: explode: true style: deepObject expand: explode: true style: deepObject filters: explode: true style: deepObject permissions: explode: true style: deepObject prefetch: explode: true style: deepObject schema: additionalProperties: false properties: account_holder: description: The account holder to link accounts for. properties: account: maxLength: 5000 type: string customer: maxLength: 5000 type: string type: enum: - account - customer type: string required: - type title: accountholder_params type: object expand: description: Specifies which fields in the response should be expanded. items: maxLength: 5000 type: string type: array filters: description: Filters to restrict the kinds of accounts to collect. properties: countries: items: maxLength: 5000 type: string type: array required: - countries title: filters_params type: object permissions: description: >- List of data features that you would like to request access to. Possible values are `balances`, `transactions`, `ownership`, and `payment_method`. items: enum: - balances - ownership - payment_method - transactions maxLength: 5000 type: string x-stripeBypassValidation: true type: array prefetch: description: >- List of data features that you would like to retrieve upon account creation. items: enum: - balances - ownership - transactions type: string x-stripeBypassValidation: true type: array return_url: description: >- For webview integrations only. Upon completing OAuth login in the native browser, the user will be redirected to this URL to return to your app. maxLength: 5000 type: string required: - account_holder - permissions type: object required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/financial_connections.session' description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. '/v1/financial_connections/sessions/{session}': get: description: >-

Retrieves the details of a Financial Connections Session

operationId: GetFinancialConnectionsSessionsSession parameters: - description: Specifies which fields in the response should be expanded. explode: true in: query name: expand required: false schema: items: maxLength: 5000 type: string type: array style: deepObject - in: path name: session required: true schema: maxLength: 5000 type: string style: simple requestBody: content: application/x-www-form-urlencoded: encoding: {} schema: additionalProperties: false properties: {} type: object required: false responses: '200': content: application/json: schema: $ref: '#/components/schemas/financial_connections.session' description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. /v1/financial_connections/transactions: get: description: >-

Returns a list of Financial Connections Transaction objects.

operationId: GetFinancialConnectionsTransactions parameters: - description: The ID of the Stripe account whose transactions will be retrieved. in: query name: account required: true schema: maxLength: 5000 type: string style: form - description: >- A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. in: query name: ending_before required: false schema: maxLength: 5000 type: string style: form - description: Specifies which fields in the response should be expanded. explode: true in: query name: expand required: false schema: items: maxLength: 5000 type: string type: array style: deepObject - description: >- A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. in: query name: limit required: false schema: type: integer style: form - description: >- A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. in: query name: starting_after required: false schema: maxLength: 5000 type: string style: form - description: >- A filter on the list based on the object `transacted_at` field. The value can be a string with an integer Unix timestamp, or it can be a dictionary with the following options: explode: true in: query name: transacted_at required: false schema: anyOf: - properties: gt: type: integer gte: type: integer lt: type: integer lte: type: integer title: range_query_specs type: object - type: integer style: deepObject - description: >- A filter on the list based on the object `transaction_refresh` field. The value can be a dictionary with the following options: explode: true in: query name: transaction_refresh required: false schema: properties: after: maxLength: 5000 type: string required: - after title: transaction_refresh_params type: object style: deepObject requestBody: content: application/x-www-form-urlencoded: encoding: {} schema: additionalProperties: false properties: {} type: object required: false responses: '200': content: application/json: schema: description: '' properties: data: description: Details about each object. items: $ref: '#/components/schemas/financial_connections.transaction' type: array has_more: description: >- True if this list has another page of items after this one that can be fetched. type: boolean object: description: >- String representing the object's type. Objects of the same type share the same value. Always has the value `list`. enum: - list type: string url: description: The URL where this list can be accessed. maxLength: 5000 pattern: ^/v1/financial_connections/transactions type: string required: - data - has_more - object - url title: BankConnectionsResourceTransactionList type: object x-expandableFields: - data description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. '/v1/financial_connections/transactions/{transaction}': get: description: >-

Retrieves the details of a Financial Connections Transaction

operationId: GetFinancialConnectionsTransactionsTransaction parameters: - description: Specifies which fields in the response should be expanded. explode: true in: query name: expand required: false schema: items: maxLength: 5000 type: string type: array style: deepObject - in: path name: transaction required: true schema: maxLength: 5000 type: string style: simple requestBody: content: application/x-www-form-urlencoded: encoding: {} schema: additionalProperties: false properties: {} type: object required: false responses: '200': content: application/json: schema: $ref: '#/components/schemas/financial_connections.transaction' description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. /v1/forwarding/requests: get: description:

Lists all ForwardingRequest objects.

operationId: GetForwardingRequests parameters: - description: >- Similar to other List endpoints, filters results based on created timestamp. You can pass gt, gte, lt, and lte timestamp values. explode: true in: query name: created required: false schema: properties: gt: type: integer gte: type: integer lt: type: integer lte: type: integer title: created_param type: object style: deepObject - description: >- A pagination cursor to fetch the previous page of the list. The value must be a ForwardingRequest ID. in: query name: ending_before required: false schema: maxLength: 5000 type: string style: form - description: Specifies which fields in the response should be expanded. explode: true in: query name: expand required: false schema: items: maxLength: 5000 type: string type: array style: deepObject - description: >- A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. in: query name: limit required: false schema: type: integer style: form - description: >- A pagination cursor to fetch the next page of the list. The value must be a ForwardingRequest ID. in: query name: starting_after required: false schema: maxLength: 5000 type: string style: form requestBody: content: application/x-www-form-urlencoded: encoding: {} schema: additionalProperties: false properties: {} type: object required: false responses: '200': content: application/json: schema: description: List of ForwardingRequest data. properties: data: items: $ref: '#/components/schemas/forwarding.request' type: array has_more: description: >- True if this list has another page of items after this one that can be fetched. type: boolean object: description: >- String representing the object's type. Objects of the same type share the same value. Always has the value `list`. enum: - list type: string url: description: The URL where this list can be accessed. maxLength: 5000 type: string required: - data - has_more - object - url title: ForwardingRequestList type: object x-expandableFields: - data description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. post: description:

Creates a ForwardingRequest object.

operationId: PostForwardingRequests requestBody: content: application/x-www-form-urlencoded: encoding: expand: explode: true style: deepObject replacements: explode: true style: deepObject request: explode: true style: deepObject schema: additionalProperties: false properties: expand: description: Specifies which fields in the response should be expanded. items: maxLength: 5000 type: string type: array payment_method: description: >- The PaymentMethod to insert into the forwarded request. Forwarding previously consumed PaymentMethods is allowed. maxLength: 5000 type: string replacements: description: The field kinds to be replaced in the forwarded request. items: enum: - card_cvc - card_expiry - card_number - cardholder_name type: string type: array request: description: >- The request body and headers to be sent to the destination endpoint. properties: body: maxLength: 5000 type: string headers: items: properties: name: maxLength: 5000 type: string value: maxLength: 5000 type: string required: - name - value title: header_param type: object type: array title: request_param type: object url: description: >- The destination URL for the forwarded request. Must be supported by the config. maxLength: 5000 type: string required: - payment_method - replacements - url type: object required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/forwarding.request' description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. '/v1/forwarding/requests/{id}': get: description:

Retrieves a ForwardingRequest object.

operationId: GetForwardingRequestsId parameters: - description: Specifies which fields in the response should be expanded. explode: true in: query name: expand required: false schema: items: maxLength: 5000 type: string type: array style: deepObject - in: path name: id required: true schema: maxLength: 5000 type: string style: simple requestBody: content: application/x-www-form-urlencoded: encoding: {} schema: additionalProperties: false properties: {} type: object required: false responses: '200': content: application/json: schema: $ref: '#/components/schemas/forwarding.request' description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. /v1/identity/verification_reports: get: description:

List all verification reports.

operationId: GetIdentityVerificationReports parameters: - description: >- A string to reference this user. This can be a customer ID, a session ID, or similar, and can be used to reconcile this verification with your internal systems. in: query name: client_reference_id required: false schema: maxLength: 5000 type: string style: form - description: >- Only return VerificationReports that were created during the given date interval. explode: true in: query name: created required: false schema: anyOf: - properties: gt: type: integer gte: type: integer lt: type: integer lte: type: integer title: range_query_specs type: object - type: integer style: deepObject - description: >- A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. in: query name: ending_before required: false schema: maxLength: 5000 type: string style: form - description: Specifies which fields in the response should be expanded. explode: true in: query name: expand required: false schema: items: maxLength: 5000 type: string type: array style: deepObject - description: >- A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. in: query name: limit required: false schema: type: integer style: form - description: >- A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. in: query name: starting_after required: false schema: maxLength: 5000 type: string style: form - description: Only return VerificationReports of this type in: query name: type required: false schema: enum: - document - id_number type: string x-stripeBypassValidation: true style: form - description: >- Only return VerificationReports created by this VerificationSession ID. It is allowed to provide a VerificationIntent ID. in: query name: verification_session required: false schema: maxLength: 5000 type: string style: form requestBody: content: application/x-www-form-urlencoded: encoding: {} schema: additionalProperties: false properties: {} type: object required: false responses: '200': content: application/json: schema: description: '' properties: data: items: $ref: '#/components/schemas/identity.verification_report' type: array has_more: description: >- True if this list has another page of items after this one that can be fetched. type: boolean object: description: >- String representing the object's type. Objects of the same type share the same value. Always has the value `list`. enum: - list type: string url: description: The URL where this list can be accessed. maxLength: 5000 pattern: ^/v1/identity/verification_reports type: string required: - data - has_more - object - url title: GelatoVerificationReportList type: object x-expandableFields: - data description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. '/v1/identity/verification_reports/{report}': get: description:

Retrieves an existing VerificationReport

operationId: GetIdentityVerificationReportsReport parameters: - description: Specifies which fields in the response should be expanded. explode: true in: query name: expand required: false schema: items: maxLength: 5000 type: string type: array style: deepObject - in: path name: report required: true schema: maxLength: 5000 type: string style: simple requestBody: content: application/x-www-form-urlencoded: encoding: {} schema: additionalProperties: false properties: {} type: object required: false responses: '200': content: application/json: schema: $ref: '#/components/schemas/identity.verification_report' description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. /v1/identity/verification_sessions: get: description:

Returns a list of VerificationSessions

operationId: GetIdentityVerificationSessions parameters: - description: >- A string to reference this user. This can be a customer ID, a session ID, or similar, and can be used to reconcile this verification with your internal systems. in: query name: client_reference_id required: false schema: maxLength: 5000 type: string style: form - description: >- Only return VerificationSessions that were created during the given date interval. explode: true in: query name: created required: false schema: anyOf: - properties: gt: type: integer gte: type: integer lt: type: integer lte: type: integer title: range_query_specs type: object - type: integer style: deepObject - description: >- A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. in: query name: ending_before required: false schema: maxLength: 5000 type: string style: form - description: Specifies which fields in the response should be expanded. explode: true in: query name: expand required: false schema: items: maxLength: 5000 type: string type: array style: deepObject - description: >- A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. in: query name: limit required: false schema: type: integer style: form - description: >- A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. in: query name: starting_after required: false schema: maxLength: 5000 type: string style: form - description: >- Only return VerificationSessions with this status. [Learn more about the lifecycle of sessions](https://stripe.com/docs/identity/how-sessions-work). in: query name: status required: false schema: enum: - canceled - processing - requires_input - verified type: string style: form requestBody: content: application/x-www-form-urlencoded: encoding: {} schema: additionalProperties: false properties: {} type: object required: false responses: '200': content: application/json: schema: description: '' properties: data: items: $ref: '#/components/schemas/identity.verification_session' type: array has_more: description: >- True if this list has another page of items after this one that can be fetched. type: boolean object: description: >- String representing the object's type. Objects of the same type share the same value. Always has the value `list`. enum: - list type: string url: description: The URL where this list can be accessed. maxLength: 5000 pattern: ^/v1/identity/verification_sessions type: string required: - data - has_more - object - url title: GelatoVerificationSessionList type: object x-expandableFields: - data description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. post: description: >-

Creates a VerificationSession object.

After the VerificationSession is created, display a verification modal using the session client_secret or send your users to the session’s url.

If your API key is in test mode, verification checks won’t actually process, though everything else will occur as if in live mode.

Related guide: Verify your users’ identity documents

operationId: PostIdentityVerificationSessions requestBody: content: application/x-www-form-urlencoded: encoding: expand: explode: true style: deepObject metadata: explode: true style: deepObject options: explode: true style: deepObject provided_details: explode: true style: deepObject schema: additionalProperties: false properties: client_reference_id: description: >- A string to reference this user. This can be a customer ID, a session ID, or similar, and can be used to reconcile this verification with your internal systems. maxLength: 5000 type: string expand: description: Specifies which fields in the response should be expanded. items: maxLength: 5000 type: string type: array metadata: additionalProperties: type: string description: >- Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. type: object options: description: A set of options for the session’s verification checks. properties: document: anyOf: - properties: allowed_types: items: enum: - driving_license - id_card - passport type: string type: array require_id_number: type: boolean require_live_capture: type: boolean require_matching_selfie: type: boolean title: document_options type: object - enum: - '' type: string email: anyOf: - properties: require_verification: type: boolean title: email_options type: object - enum: - '' type: string phone: anyOf: - properties: require_verification: type: boolean title: phone_options type: object - enum: - '' type: string title: session_options_param type: object provided_details: description: >- Details provided about the user being verified. These details may be shown to the user. properties: email: type: string phone: type: string title: provided_details_param type: object return_url: description: >- The URL that the user will be redirected to upon completing the verification flow. type: string type: description: >- The type of [verification check](https://stripe.com/docs/identity/verification-checks) to be performed. enum: - document - id_number type: string x-stripeBypassValidation: true verification_flow: description: The ID of a Verification Flow from the Dashboard. maxLength: 5000 type: string type: object required: false responses: '200': content: application/json: schema: $ref: '#/components/schemas/identity.verification_session' description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. '/v1/identity/verification_sessions/{session}': get: description: >-

Retrieves the details of a VerificationSession that was previously created.

When the session status is requires_input, you can use this method to retrieve a valid client_secret or url to allow re-submission.

operationId: GetIdentityVerificationSessionsSession parameters: - description: Specifies which fields in the response should be expanded. explode: true in: query name: expand required: false schema: items: maxLength: 5000 type: string type: array style: deepObject - in: path name: session required: true schema: maxLength: 5000 type: string style: simple requestBody: content: application/x-www-form-urlencoded: encoding: {} schema: additionalProperties: false properties: {} type: object required: false responses: '200': content: application/json: schema: $ref: '#/components/schemas/identity.verification_session' description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. post: description: >-

Updates a VerificationSession object.

When the session status is requires_input, you can use this method to update the verification check and options.

operationId: PostIdentityVerificationSessionsSession parameters: - in: path name: session required: true schema: maxLength: 5000 type: string style: simple requestBody: content: application/x-www-form-urlencoded: encoding: expand: explode: true style: deepObject metadata: explode: true style: deepObject options: explode: true style: deepObject provided_details: explode: true style: deepObject schema: additionalProperties: false properties: expand: description: Specifies which fields in the response should be expanded. items: maxLength: 5000 type: string type: array metadata: additionalProperties: type: string description: >- Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. type: object options: description: A set of options for the session’s verification checks. properties: document: anyOf: - properties: allowed_types: items: enum: - driving_license - id_card - passport type: string type: array require_id_number: type: boolean require_live_capture: type: boolean require_matching_selfie: type: boolean title: document_options type: object - enum: - '' type: string email: anyOf: - properties: require_verification: type: boolean title: email_options type: object - enum: - '' type: string phone: anyOf: - properties: require_verification: type: boolean title: phone_options type: object - enum: - '' type: string title: session_options_param type: object provided_details: description: >- Details provided about the user being verified. These details may be shown to the user. properties: email: type: string phone: type: string title: provided_details_param type: object type: description: >- The type of [verification check](https://stripe.com/docs/identity/verification-checks) to be performed. enum: - document - id_number type: string x-stripeBypassValidation: true type: object required: false responses: '200': content: application/json: schema: $ref: '#/components/schemas/identity.verification_session' description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. '/v1/identity/verification_sessions/{session}/cancel': post: description: >-

A VerificationSession object can be canceled when it is in requires_input status.

Once canceled, future submission attempts are disabled. This cannot be undone. Learn more.

operationId: PostIdentityVerificationSessionsSessionCancel parameters: - in: path name: session required: true schema: maxLength: 5000 type: string style: simple requestBody: content: application/x-www-form-urlencoded: encoding: expand: explode: true style: deepObject schema: additionalProperties: false properties: expand: description: Specifies which fields in the response should be expanded. items: maxLength: 5000 type: string type: array type: object required: false responses: '200': content: application/json: schema: $ref: '#/components/schemas/identity.verification_session' description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. '/v1/identity/verification_sessions/{session}/redact': post: description: >-

Redact a VerificationSession to remove all collected information from Stripe. This will redact the VerificationSession and all objects related to it, including VerificationReports, Events, request logs, etc.

A VerificationSession object can be redacted when it is in requires_input or verified status. Redacting a VerificationSession in requires_action state will automatically cancel it.

The redaction process may take up to four days. When the redaction process is in progress, the VerificationSession’s redaction.status field will be set to processing; when the process is finished, it will change to redacted and an identity.verification_session.redacted event will be emitted.

Redaction is irreversible. Redacted objects are still accessible in the Stripe API, but all the fields that contain personal data will be replaced by the string [redacted] or a similar placeholder. The metadata field will also be erased. Redacted objects cannot be updated or used for any purpose.

Learn more.

operationId: PostIdentityVerificationSessionsSessionRedact parameters: - in: path name: session required: true schema: maxLength: 5000 type: string style: simple requestBody: content: application/x-www-form-urlencoded: encoding: expand: explode: true style: deepObject schema: additionalProperties: false properties: expand: description: Specifies which fields in the response should be expanded. items: maxLength: 5000 type: string type: array type: object required: false responses: '200': content: application/json: schema: $ref: '#/components/schemas/identity.verification_session' description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. /v1/invoiceitems: get: description: >-

Returns a list of your invoice items. Invoice items are returned sorted by creation date, with the most recently created invoice items appearing first.

operationId: GetInvoiceitems parameters: - description: >- Only return invoice items that were created during the given date interval. explode: true in: query name: created required: false schema: anyOf: - properties: gt: type: integer gte: type: integer lt: type: integer lte: type: integer title: range_query_specs type: object - type: integer style: deepObject - description: >- The identifier of the customer whose invoice items to return. If none is provided, all invoice items will be returned. in: query name: customer required: false schema: maxLength: 5000 type: string style: form - description: >- A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. in: query name: ending_before required: false schema: maxLength: 5000 type: string style: form - description: Specifies which fields in the response should be expanded. explode: true in: query name: expand required: false schema: items: maxLength: 5000 type: string type: array style: deepObject - description: >- Only return invoice items belonging to this invoice. If none is provided, all invoice items will be returned. If specifying an invoice, no customer identifier is needed. in: query name: invoice required: false schema: maxLength: 5000 type: string style: form - description: >- A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. in: query name: limit required: false schema: type: integer style: form - description: >- Set to `true` to only show pending invoice items, which are not yet attached to any invoices. Set to `false` to only show invoice items already attached to invoices. If unspecified, no filter is applied. in: query name: pending required: false schema: type: boolean style: form - description: >- A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. in: query name: starting_after required: false schema: maxLength: 5000 type: string style: form requestBody: content: application/x-www-form-urlencoded: encoding: {} schema: additionalProperties: false properties: {} type: object required: false responses: '200': content: application/json: schema: description: '' properties: data: items: $ref: '#/components/schemas/invoiceitem' type: array has_more: description: >- True if this list has another page of items after this one that can be fetched. type: boolean object: description: >- String representing the object's type. Objects of the same type share the same value. Always has the value `list`. enum: - list type: string url: description: The URL where this list can be accessed. maxLength: 5000 pattern: ^/v1/invoiceitems type: string required: - data - has_more - object - url title: InvoicesItemsList type: object x-expandableFields: - data description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. post: description: >-

Creates an item to be added to a draft invoice (up to 250 items per invoice). If no invoice is specified, the item will be on the next invoice created for the customer specified.

operationId: PostInvoiceitems requestBody: content: application/x-www-form-urlencoded: encoding: discounts: explode: true style: deepObject expand: explode: true style: deepObject metadata: explode: true style: deepObject period: explode: true style: deepObject price_data: explode: true style: deepObject tax_code: explode: true style: deepObject tax_rates: explode: true style: deepObject schema: additionalProperties: false properties: amount: description: >- The integer amount in cents (or local equivalent) of the charge to be applied to the upcoming invoice. Passing in a negative `amount` will reduce the `amount_due` on the invoice. type: integer currency: description: >- 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). type: string customer: description: >- The ID of the customer who will be billed when this invoice item is billed. maxLength: 5000 type: string description: description: >- An arbitrary string which you can attach to the invoice item. The description is displayed in the invoice for easy tracking. maxLength: 5000 type: string discountable: description: >- Controls whether discounts apply to this invoice item. Defaults to false for prorations or negative invoice items, and true for all other invoice items. type: boolean discounts: anyOf: - items: properties: coupon: maxLength: 5000 type: string discount: maxLength: 5000 type: string promotion_code: maxLength: 5000 type: string title: discounts_data_param type: object type: array - enum: - '' type: string description: >- The coupons and promotion codes to redeem into discounts for the invoice item or invoice line item. expand: description: Specifies which fields in the response should be expanded. items: maxLength: 5000 type: string type: array invoice: description: >- The ID of an existing invoice to add this invoice item to. When left blank, the invoice item will be added to the next upcoming scheduled invoice. This is useful when adding invoice items in response to an invoice.created webhook. You can only add invoice items to draft invoices and there is a maximum of 250 items per invoice. maxLength: 5000 type: string metadata: anyOf: - additionalProperties: type: string type: object - enum: - '' type: string description: >- Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. period: description: >- The period associated with this invoice item. When set to different values, the period will be rendered on the invoice. If you have [Stripe Revenue Recognition](https://stripe.com/docs/revenue-recognition) enabled, the period will be used to recognize and defer revenue. See the [Revenue Recognition documentation](https://stripe.com/docs/revenue-recognition/methodology/subscriptions-and-invoicing) for details. properties: end: format: unix-time type: integer start: format: unix-time type: integer required: - end - start title: period type: object price: description: The ID of the price object. maxLength: 5000 type: string price_data: description: >- Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline. properties: currency: type: string product: maxLength: 5000 type: string tax_behavior: enum: - exclusive - inclusive - unspecified type: string unit_amount: type: integer unit_amount_decimal: format: decimal type: string required: - currency - product title: one_time_price_data type: object quantity: description: >- Non-negative integer. The quantity of units for the invoice item. type: integer subscription: description: >- The ID of a subscription to add this invoice item to. When left blank, the invoice item will be be added to the next upcoming scheduled invoice. When set, scheduled invoices for subscriptions other than the specified subscription will ignore the invoice item. Use this when you want to express that an invoice item has been accrued within the context of a particular subscription. maxLength: 5000 type: string tax_behavior: description: >- Only required if a [default tax behavior](https://stripe.com/docs/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)) was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. Once specified as either `inclusive` or `exclusive`, it cannot be changed. enum: - exclusive - inclusive - unspecified type: string tax_code: anyOf: - type: string - enum: - '' type: string description: 'A [tax code](https://stripe.com/docs/tax/tax-categories) ID.' tax_rates: description: >- The tax rates which apply to the invoice item. When set, the `default_tax_rates` on the invoice do not apply to this invoice item. items: maxLength: 5000 type: string type: array unit_amount: description: >- The integer unit amount in cents (or local equivalent) of the charge to be applied to the upcoming invoice. This `unit_amount` will be multiplied by the quantity to get the full amount. Passing in a negative `unit_amount` will reduce the `amount_due` on the invoice. type: integer unit_amount_decimal: description: >- Same as `unit_amount`, but accepts a decimal value in cents (or local equivalent) with at most 12 decimal places. Only one of `unit_amount` and `unit_amount_decimal` can be set. format: decimal type: string required: - customer type: object required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/invoiceitem' description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. '/v1/invoiceitems/{invoiceitem}': delete: description: >-

Deletes an invoice item, removing it from an invoice. Deleting invoice items is only possible when they’re not attached to invoices, or if it’s attached to a draft invoice.

operationId: DeleteInvoiceitemsInvoiceitem parameters: - in: path name: invoiceitem required: true schema: maxLength: 5000 type: string style: simple requestBody: content: application/x-www-form-urlencoded: encoding: {} schema: additionalProperties: false properties: {} type: object required: false responses: '200': content: application/json: schema: $ref: '#/components/schemas/deleted_invoiceitem' description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. get: description:

Retrieves the invoice item with the given ID.

operationId: GetInvoiceitemsInvoiceitem parameters: - description: Specifies which fields in the response should be expanded. explode: true in: query name: expand required: false schema: items: maxLength: 5000 type: string type: array style: deepObject - in: path name: invoiceitem required: true schema: maxLength: 5000 type: string style: simple requestBody: content: application/x-www-form-urlencoded: encoding: {} schema: additionalProperties: false properties: {} type: object required: false responses: '200': content: application/json: schema: $ref: '#/components/schemas/invoiceitem' description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. post: description: >-

Updates the amount or description of an invoice item on an upcoming invoice. Updating an invoice item is only possible before the invoice it’s attached to is closed.

operationId: PostInvoiceitemsInvoiceitem parameters: - in: path name: invoiceitem required: true schema: maxLength: 5000 type: string style: simple requestBody: content: application/x-www-form-urlencoded: encoding: discounts: explode: true style: deepObject expand: explode: true style: deepObject metadata: explode: true style: deepObject period: explode: true style: deepObject price_data: explode: true style: deepObject tax_code: explode: true style: deepObject tax_rates: explode: true style: deepObject schema: additionalProperties: false properties: amount: description: >- The integer amount in cents (or local equivalent) of the charge to be applied to the upcoming invoice. If you want to apply a credit to the customer's account, pass a negative amount. type: integer description: description: >- An arbitrary string which you can attach to the invoice item. The description is displayed in the invoice for easy tracking. maxLength: 5000 type: string discountable: description: >- Controls whether discounts apply to this invoice item. Defaults to false for prorations or negative invoice items, and true for all other invoice items. Cannot be set to true for prorations. type: boolean discounts: anyOf: - items: properties: coupon: maxLength: 5000 type: string discount: maxLength: 5000 type: string promotion_code: maxLength: 5000 type: string title: discounts_data_param type: object type: array - enum: - '' type: string description: >- The coupons, promotion codes & existing discounts which apply to the invoice item or invoice line item. Item discounts are applied before invoice discounts. Pass an empty string to remove previously-defined discounts. expand: description: Specifies which fields in the response should be expanded. items: maxLength: 5000 type: string type: array metadata: anyOf: - additionalProperties: type: string type: object - enum: - '' type: string description: >- Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. period: description: >- The period associated with this invoice item. When set to different values, the period will be rendered on the invoice. If you have [Stripe Revenue Recognition](https://stripe.com/docs/revenue-recognition) enabled, the period will be used to recognize and defer revenue. See the [Revenue Recognition documentation](https://stripe.com/docs/revenue-recognition/methodology/subscriptions-and-invoicing) for details. properties: end: format: unix-time type: integer start: format: unix-time type: integer required: - end - start title: period type: object price: description: The ID of the price object. maxLength: 5000 type: string price_data: description: >- Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline. properties: currency: type: string product: maxLength: 5000 type: string tax_behavior: enum: - exclusive - inclusive - unspecified type: string unit_amount: type: integer unit_amount_decimal: format: decimal type: string required: - currency - product title: one_time_price_data type: object quantity: description: >- Non-negative integer. The quantity of units for the invoice item. type: integer tax_behavior: description: >- Only required if a [default tax behavior](https://stripe.com/docs/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)) was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. Once specified as either `inclusive` or `exclusive`, it cannot be changed. enum: - exclusive - inclusive - unspecified type: string tax_code: anyOf: - type: string - enum: - '' type: string description: 'A [tax code](https://stripe.com/docs/tax/tax-categories) ID.' tax_rates: anyOf: - items: maxLength: 5000 type: string type: array - enum: - '' type: string description: >- The tax rates which apply to the invoice item. When set, the `default_tax_rates` on the invoice do not apply to this invoice item. Pass an empty string to remove previously-defined tax rates. unit_amount: description: >- The integer unit amount in cents (or local equivalent) of the charge to be applied to the upcoming invoice. This unit_amount will be multiplied by the quantity to get the full amount. If you want to apply a credit to the customer's account, pass a negative unit_amount. type: integer unit_amount_decimal: description: >- Same as `unit_amount`, but accepts a decimal value in cents (or local equivalent) with at most 12 decimal places. Only one of `unit_amount` and `unit_amount_decimal` can be set. format: decimal type: string type: object required: false responses: '200': content: application/json: schema: $ref: '#/components/schemas/invoiceitem' description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. /v1/invoices: get: description: >-

You can list all invoices, or list the invoices for a specific customer. The invoices are returned sorted by creation date, with the most recently created invoices appearing first.

operationId: GetInvoices parameters: - description: >- The collection method of the invoice to retrieve. Either `charge_automatically` or `send_invoice`. in: query name: collection_method required: false schema: enum: - charge_automatically - send_invoice type: string style: form - description: >- Only return invoices that were created during the given date interval. explode: true in: query name: created required: false schema: anyOf: - properties: gt: type: integer gte: type: integer lt: type: integer lte: type: integer title: range_query_specs type: object - type: integer style: deepObject - description: Only return invoices for the customer specified by this customer ID. in: query name: customer required: false schema: maxLength: 5000 type: string style: form - explode: true in: query name: due_date required: false schema: anyOf: - properties: gt: type: integer gte: type: integer lt: type: integer lte: type: integer title: range_query_specs type: object - type: integer style: deepObject - description: >- A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. in: query name: ending_before required: false schema: maxLength: 5000 type: string style: form - description: Specifies which fields in the response should be expanded. explode: true in: query name: expand required: false schema: items: maxLength: 5000 type: string type: array style: deepObject - description: >- A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. in: query name: limit required: false schema: type: integer style: form - description: >- A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. in: query name: starting_after required: false schema: maxLength: 5000 type: string style: form - description: >- The status of the invoice, one of `draft`, `open`, `paid`, `uncollectible`, or `void`. [Learn more](https://stripe.com/docs/billing/invoices/workflow#workflow-overview) in: query name: status required: false schema: enum: - draft - open - paid - uncollectible - void type: string x-stripeBypassValidation: true style: form - description: >- Only return invoices for the subscription specified by this subscription ID. in: query name: subscription required: false schema: maxLength: 5000 type: string style: form requestBody: content: application/x-www-form-urlencoded: encoding: {} schema: additionalProperties: false properties: {} type: object required: false responses: '200': content: application/json: schema: description: '' properties: data: items: $ref: '#/components/schemas/invoice' type: array has_more: description: >- True if this list has another page of items after this one that can be fetched. type: boolean object: description: >- String representing the object's type. Objects of the same type share the same value. Always has the value `list`. enum: - list type: string url: description: The URL where this list can be accessed. maxLength: 5000 pattern: ^/v1/invoices type: string required: - data - has_more - object - url title: InvoicesResourceList type: object x-expandableFields: - data description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. post: description: >-

This endpoint creates a draft invoice for a given customer. The invoice remains a draft until you finalize the invoice, which allows you to pay or send the invoice to your customers.

operationId: PostInvoices requestBody: content: application/x-www-form-urlencoded: encoding: account_tax_ids: explode: true style: deepObject automatic_tax: explode: true style: deepObject custom_fields: explode: true style: deepObject default_tax_rates: explode: true style: deepObject discounts: explode: true style: deepObject expand: explode: true style: deepObject from_invoice: explode: true style: deepObject issuer: explode: true style: deepObject metadata: explode: true style: deepObject payment_settings: explode: true style: deepObject rendering: explode: true style: deepObject shipping_cost: explode: true style: deepObject shipping_details: explode: true style: deepObject transfer_data: explode: true style: deepObject schema: additionalProperties: false properties: account_tax_ids: anyOf: - items: maxLength: 5000 type: string type: array - enum: - '' type: string description: >- The account tax IDs associated with the invoice. Only editable when the invoice is a draft. application_fee_amount: description: >- A fee in cents (or local equivalent) that will be applied to the invoice and transferred to the application owner's Stripe account. The request must be made with an OAuth key or the Stripe-Account header in order to take an application fee. For more information, see the application fees [documentation](https://stripe.com/docs/billing/invoices/connect#collecting-fees). type: integer auto_advance: description: >- 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. type: boolean automatic_tax: description: Settings for automatic tax lookup for this invoice. properties: enabled: type: boolean liability: properties: account: type: string type: enum: - account - self type: string required: - type title: param type: object required: - enabled title: automatic_tax_param type: object collection_method: description: >- 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. Defaults to `charge_automatically`. enum: - charge_automatically - send_invoice type: string currency: description: >- The currency to create this invoice in. Defaults to that of `customer` if not specified. type: string custom_fields: anyOf: - items: properties: name: maxLength: 40 type: string value: maxLength: 140 type: string required: - name - value title: custom_field_params type: object type: array - enum: - '' type: string description: >- A list of up to 4 custom fields to be displayed on the invoice. customer: description: The ID of the customer who will be billed. maxLength: 5000 type: string days_until_due: description: >- The number of days from when the invoice is created until it is due. Valid only for invoices where `collection_method=send_invoice`. type: integer default_payment_method: description: >- 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. maxLength: 5000 type: string default_source: description: >- 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. maxLength: 5000 type: string default_tax_rates: description: >- The tax rates that will apply to any line item that does not have `tax_rates` set. items: maxLength: 5000 type: string type: array description: description: >- An arbitrary string attached to the object. Often useful for displaying to users. Referenced as 'memo' in the Dashboard. maxLength: 1500 type: string discounts: anyOf: - items: properties: coupon: maxLength: 5000 type: string discount: maxLength: 5000 type: string promotion_code: maxLength: 5000 type: string title: discounts_data_param type: object type: array - enum: - '' type: string description: >- The coupons and promotion codes to redeem into discounts for the invoice. If not specified, inherits the discount from the invoice's customer. Pass an empty string to avoid inheriting any discounts. due_date: description: >- The date on which payment for this invoice is due. Valid only for invoices where `collection_method=send_invoice`. format: unix-time type: integer effective_at: description: >- 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. format: unix-time type: integer expand: description: Specifies which fields in the response should be expanded. items: maxLength: 5000 type: string type: array footer: description: Footer to be displayed on the invoice. maxLength: 5000 type: string from_invoice: description: >- Revise an existing invoice. The new invoice will be created in `status=draft`. See the [revision documentation](https://stripe.com/docs/invoicing/invoice-revisions) for more details. properties: action: enum: - revision maxLength: 5000 type: string invoice: maxLength: 5000 type: string required: - action - invoice title: from_invoice type: object issuer: description: >- The connected account that issues the invoice. The invoice is presented with the branding and support information of the specified account. properties: account: type: string type: enum: - account - self type: string required: - type title: param type: object metadata: anyOf: - additionalProperties: type: string type: object - enum: - '' type: string description: >- Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. number: description: >- Set the number for this invoice. If no number is present then a number will be assigned automatically when the invoice is finalized. In many markets, regulations require invoices to be unique, sequential and / or gapless. You are responsible for ensuring this is true across all your different invoicing systems in the event that you edit the invoice number using our API. If you use only Stripe for your invoices and do not change invoice numbers, Stripe handles this aspect of compliance for you automatically. maxLength: 26 type: string on_behalf_of: description: >- 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. type: string payment_settings: description: >- Configuration settings for the PaymentIntent that is generated when the invoice is finalized. properties: default_mandate: anyOf: - maxLength: 5000 type: string - enum: - '' type: string payment_method_options: properties: acss_debit: anyOf: - properties: mandate_options: properties: transaction_type: enum: - business - personal type: string title: mandate_options_param type: object verification_method: enum: - automatic - instant - microdeposits type: string x-stripeBypassValidation: true title: invoice_payment_method_options_param type: object - enum: - '' type: string bancontact: anyOf: - properties: preferred_language: enum: - de - en - fr - nl type: string title: invoice_payment_method_options_param type: object - enum: - '' type: string card: anyOf: - properties: installments: properties: enabled: type: boolean plan: anyOf: - properties: count: type: integer interval: enum: - month type: string type: enum: - fixed_count type: string required: - count - interval - type title: installment_plan type: object - enum: - '' type: string title: installments_param type: object request_three_d_secure: enum: - any - automatic - challenge type: string title: invoice_payment_method_options_param type: object - enum: - '' type: string customer_balance: anyOf: - properties: bank_transfer: properties: eu_bank_transfer: properties: country: maxLength: 5000 type: string required: - country title: eu_bank_transfer_param type: object type: type: string title: bank_transfer_param type: object funding_type: type: string title: invoice_payment_method_options_param type: object - enum: - '' type: string konbini: anyOf: - properties: {} title: invoice_payment_method_options_param type: object - enum: - '' type: string sepa_debit: anyOf: - properties: {} title: invoice_payment_method_options_param type: object - enum: - '' type: string us_bank_account: anyOf: - properties: financial_connections: properties: permissions: items: enum: - balances - ownership - payment_method - transactions maxLength: 5000 type: string x-stripeBypassValidation: true type: array prefetch: items: enum: - balances - ownership - transactions type: string x-stripeBypassValidation: true type: array title: invoice_linked_account_options_param type: object verification_method: enum: - automatic - instant - microdeposits type: string x-stripeBypassValidation: true title: invoice_payment_method_options_param type: object - enum: - '' type: string title: payment_method_options type: object payment_method_types: anyOf: - items: enum: - ach_credit_transfer - ach_debit - acss_debit - au_becs_debit - bacs_debit - bancontact - boleto - card - cashapp - customer_balance - eps - fpx - giropay - grabpay - ideal - konbini - link - p24 - paynow - paypal - promptpay - sepa_debit - sofort - us_bank_account - wechat_pay type: string x-stripeBypassValidation: true type: array - enum: - '' type: string title: payment_settings type: object pending_invoice_items_behavior: description: >- How to handle pending invoice items on invoice creation. Defaults to `exclude` if the parameter is omitted. enum: - exclude - include type: string x-stripeBypassValidation: true rendering: description: >- The rendering-related settings that control how the invoice is displayed on customer-facing surfaces such as PDF and Hosted Invoice Page. properties: amount_tax_display: enum: - '' - exclude_tax - include_inclusive_tax type: string pdf: properties: page_size: enum: - a4 - auto - letter type: string title: rendering_pdf_param type: object title: rendering_param type: object shipping_cost: description: Settings for the cost of shipping for this invoice. properties: shipping_rate: maxLength: 5000 type: string shipping_rate_data: properties: delivery_estimate: properties: maximum: properties: unit: enum: - business_day - day - hour - month - week type: string value: type: integer required: - unit - value title: delivery_estimate_bound type: object minimum: properties: unit: enum: - business_day - day - hour - month - week type: string value: type: integer required: - unit - value title: delivery_estimate_bound type: object title: delivery_estimate type: object display_name: maxLength: 100 type: string fixed_amount: properties: amount: type: integer currency: type: string currency_options: additionalProperties: properties: amount: type: integer tax_behavior: enum: - exclusive - inclusive - unspecified type: string required: - amount title: currency_option type: object type: object required: - amount - currency title: fixed_amount type: object metadata: additionalProperties: type: string type: object tax_behavior: enum: - exclusive - inclusive - unspecified type: string tax_code: type: string type: enum: - fixed_amount type: string required: - display_name title: method_params type: object title: shipping_cost type: object shipping_details: description: >- Shipping details for the invoice. The Invoice PDF will use the `shipping_details` value if it is set, otherwise the PDF will render the shipping address from the customer. properties: address: properties: city: maxLength: 5000 type: string country: maxLength: 5000 type: string line1: maxLength: 5000 type: string line2: maxLength: 5000 type: string postal_code: maxLength: 5000 type: string state: maxLength: 5000 type: string title: optional_fields_address type: object name: maxLength: 5000 type: string phone: anyOf: - maxLength: 5000 type: string - enum: - '' type: string required: - address - name title: recipient_shipping_with_optional_fields_address type: object statement_descriptor: description: >- Extra information about a charge for the customer's credit card statement. It must contain at least one letter. If not specified and this invoice is part of a subscription, the default `statement_descriptor` will be set to the first subscription item's product's `statement_descriptor`. maxLength: 22 type: string subscription: description: >- The ID of the subscription to invoice, if any. If set, the created invoice will only include pending invoice items for that subscription. The subscription's billing cycle and regular subscription events won't be affected. maxLength: 5000 type: string transfer_data: description: >- If specified, the funds from the invoice will be transferred to the destination and the ID of the resulting transfer will be found on the invoice's charge. properties: amount: type: integer destination: type: string required: - destination title: transfer_data_specs type: object type: object required: false responses: '200': content: application/json: schema: $ref: '#/components/schemas/invoice' description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. /v1/invoices/create_preview: post: description: >-

At any time, you can preview the upcoming invoice for a customer. This will show you all the charges that are pending, including subscription renewal charges, invoice item charges, etc. It will also show you any discounts that are applicable to the invoice.

Note that when you are viewing an upcoming invoice, you are simply viewing a preview – the invoice has not yet been created. As such, the upcoming invoice will not show up in invoice listing calls, and you cannot use the API to pay or edit the invoice. If you want to change the amount that your customer will be billed, you can add, remove, or update pending invoice items, or update the customer’s discount.

You can preview the effects of updating a subscription, including a preview of what proration will take place. To ensure that the actual proration is calculated exactly the same as the previewed proration, you should pass the subscription_details.proration_date parameter when doing the actual subscription update. The recommended way to get only the prorations being previewed is to consider only proration line items where period[start] is equal to the subscription_details.proration_date value passed in the request.

operationId: PostInvoicesCreatePreview requestBody: content: application/x-www-form-urlencoded: encoding: automatic_tax: explode: true style: deepObject customer_details: explode: true style: deepObject discounts: explode: true style: deepObject expand: explode: true style: deepObject invoice_items: explode: true style: deepObject issuer: explode: true style: deepObject on_behalf_of: explode: true style: deepObject schedule_details: explode: true style: deepObject subscription_details: explode: true style: deepObject schema: additionalProperties: false properties: automatic_tax: description: Settings for automatic tax lookup for this invoice preview. properties: enabled: type: boolean liability: properties: account: type: string type: enum: - account - self type: string required: - type title: param type: object required: - enabled title: automatic_tax_param type: object coupon: description: >- The ID of the coupon to apply to this phase of the subscription schedule. This field has been deprecated and will be removed in a future API version. Use `discounts` instead. maxLength: 5000 type: string currency: description: >- The currency to preview this invoice in. Defaults to that of `customer` if not specified. type: string customer: description: >- The identifier of the customer whose upcoming invoice you'd like to retrieve. If `automatic_tax` is enabled then one of `customer`, `customer_details`, `subscription`, or `schedule` must be set. maxLength: 5000 type: string customer_details: description: >- Details about the customer you want to invoice or overrides for an existing customer. If `automatic_tax` is enabled then one of `customer`, `customer_details`, `subscription`, or `schedule` must be set. properties: address: anyOf: - properties: city: maxLength: 5000 type: string country: maxLength: 5000 type: string line1: maxLength: 5000 type: string line2: maxLength: 5000 type: string postal_code: maxLength: 5000 type: string state: maxLength: 5000 type: string title: optional_fields_address type: object - enum: - '' type: string shipping: anyOf: - properties: address: properties: city: maxLength: 5000 type: string country: maxLength: 5000 type: string line1: maxLength: 5000 type: string line2: maxLength: 5000 type: string postal_code: maxLength: 5000 type: string state: maxLength: 5000 type: string title: optional_fields_address type: object name: maxLength: 5000 type: string phone: maxLength: 5000 type: string required: - address - name title: customer_shipping type: object - enum: - '' type: string tax: properties: ip_address: anyOf: - type: string - enum: - '' type: string title: tax_param type: object tax_exempt: enum: - '' - exempt - none - reverse type: string tax_ids: items: properties: type: enum: - ad_nrt - ae_trn - ar_cuit - au_abn - au_arn - bg_uic - bh_vat - bo_tin - br_cnpj - br_cpf - ca_bn - ca_gst_hst - ca_pst_bc - ca_pst_mb - ca_pst_sk - ca_qst - ch_vat - cl_tin - cn_tin - co_nit - cr_tin - do_rcn - ec_ruc - eg_tin - es_cif - eu_oss_vat - eu_vat - gb_vat - ge_vat - hk_br - hu_tin - id_npwp - il_vat - in_gst - is_vat - jp_cn - jp_rn - jp_trn - ke_pin - kr_brn - kz_bin - li_uid - mx_rfc - my_frp - my_itn - my_sst - ng_tin - no_vat - no_voec - nz_gst - om_vat - pe_ruc - ph_tin - ro_tin - rs_pib - ru_inn - ru_kpp - sa_vat - sg_gst - sg_uen - si_tin - sv_nit - th_vat - tr_tin - tw_vat - ua_vat - us_ein - uy_ruc - ve_rif - vn_tin - za_vat maxLength: 5000 type: string x-stripeBypassValidation: true value: type: string required: - type - value title: data_params type: object type: array title: customer_details_param type: object discounts: anyOf: - items: properties: coupon: maxLength: 5000 type: string discount: maxLength: 5000 type: string promotion_code: maxLength: 5000 type: string title: discounts_data_param type: object type: array - enum: - '' type: string description: >- The coupons to redeem into discounts for the invoice preview. If not specified, inherits the discount from the subscription or customer. This works for both coupons directly applied to an invoice and coupons applied to a subscription. Pass an empty string to avoid inheriting any discounts. expand: description: Specifies which fields in the response should be expanded. items: maxLength: 5000 type: string type: array invoice_items: description: >- List of invoice items to add or update in the upcoming invoice preview. items: properties: amount: type: integer currency: type: string description: maxLength: 5000 type: string discountable: type: boolean discounts: anyOf: - items: properties: coupon: maxLength: 5000 type: string discount: maxLength: 5000 type: string promotion_code: maxLength: 5000 type: string title: discounts_data_param type: object type: array - enum: - '' type: string invoiceitem: maxLength: 5000 type: string metadata: anyOf: - additionalProperties: type: string type: object - enum: - '' type: string period: properties: end: format: unix-time type: integer start: format: unix-time type: integer required: - end - start title: period type: object price: maxLength: 5000 type: string price_data: properties: currency: type: string product: maxLength: 5000 type: string tax_behavior: enum: - exclusive - inclusive - unspecified type: string unit_amount: type: integer unit_amount_decimal: format: decimal type: string required: - currency - product title: one_time_price_data type: object quantity: type: integer tax_behavior: enum: - exclusive - inclusive - unspecified type: string tax_code: anyOf: - type: string - enum: - '' type: string tax_rates: anyOf: - items: maxLength: 5000 type: string type: array - enum: - '' type: string unit_amount: type: integer unit_amount_decimal: format: decimal type: string title: invoice_item_preview_params type: object type: array issuer: description: >- The connected account that issues the invoice. The invoice is presented with the branding and support information of the specified account. properties: account: type: string type: enum: - account - self type: string required: - type title: param type: object on_behalf_of: anyOf: - type: string - enum: - '' type: string description: >- 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. schedule: description: >- The identifier of the schedule whose upcoming invoice you'd like to retrieve. Cannot be used with subscription or subscription fields. maxLength: 5000 type: string schedule_details: description: >- The schedule creation or modification params to apply as a preview. Cannot be used with `subscription` or `subscription_` prefixed fields. properties: end_behavior: enum: - cancel - release type: string phases: items: properties: add_invoice_items: items: properties: discounts: items: properties: coupon: maxLength: 5000 type: string discount: maxLength: 5000 type: string promotion_code: maxLength: 5000 type: string title: discounts_data_param type: object type: array price: maxLength: 5000 type: string price_data: properties: currency: type: string product: maxLength: 5000 type: string tax_behavior: enum: - exclusive - inclusive - unspecified type: string unit_amount: type: integer unit_amount_decimal: format: decimal type: string required: - currency - product title: one_time_price_data_with_negative_amounts type: object quantity: type: integer tax_rates: anyOf: - items: maxLength: 5000 type: string type: array - enum: - '' type: string title: add_invoice_item_entry type: object type: array application_fee_percent: type: number automatic_tax: properties: enabled: type: boolean liability: properties: account: type: string type: enum: - account - self type: string required: - type title: param type: object required: - enabled title: automatic_tax_config type: object billing_cycle_anchor: enum: - automatic - phase_start type: string billing_thresholds: anyOf: - properties: amount_gte: type: integer reset_billing_cycle_anchor: type: boolean title: billing_thresholds_param type: object - enum: - '' type: string collection_method: enum: - charge_automatically - send_invoice type: string coupon: maxLength: 5000 type: string default_payment_method: maxLength: 5000 type: string default_tax_rates: anyOf: - items: maxLength: 5000 type: string type: array - enum: - '' type: string description: anyOf: - maxLength: 500 type: string - enum: - '' type: string discounts: anyOf: - items: properties: coupon: maxLength: 5000 type: string discount: maxLength: 5000 type: string promotion_code: maxLength: 5000 type: string title: discounts_data_param type: object type: array - enum: - '' type: string end_date: anyOf: - format: unix-time type: integer - enum: - now maxLength: 5000 type: string invoice_settings: properties: account_tax_ids: anyOf: - items: maxLength: 5000 type: string type: array - enum: - '' type: string days_until_due: type: integer issuer: properties: account: type: string type: enum: - account - self type: string required: - type title: param type: object title: invoice_settings type: object items: items: properties: billing_thresholds: anyOf: - properties: usage_gte: type: integer required: - usage_gte title: item_billing_thresholds_param type: object - enum: - '' type: string discounts: anyOf: - items: properties: coupon: maxLength: 5000 type: string discount: maxLength: 5000 type: string promotion_code: maxLength: 5000 type: string title: discounts_data_param type: object type: array - enum: - '' type: string metadata: additionalProperties: type: string type: object price: maxLength: 5000 type: string price_data: properties: currency: type: string product: maxLength: 5000 type: string recurring: properties: interval: enum: - day - month - week - year type: string interval_count: type: integer required: - interval title: recurring_adhoc type: object tax_behavior: enum: - exclusive - inclusive - unspecified type: string unit_amount: type: integer unit_amount_decimal: format: decimal type: string required: - currency - product - recurring title: recurring_price_data type: object quantity: type: integer tax_rates: anyOf: - items: maxLength: 5000 type: string type: array - enum: - '' type: string title: configuration_item_params type: object type: array iterations: type: integer metadata: additionalProperties: type: string type: object on_behalf_of: type: string proration_behavior: enum: - always_invoice - create_prorations - none type: string start_date: anyOf: - format: unix-time type: integer - enum: - now maxLength: 5000 type: string transfer_data: properties: amount_percent: type: number destination: type: string required: - destination title: transfer_data_specs type: object trial: type: boolean trial_end: anyOf: - format: unix-time type: integer - enum: - now maxLength: 5000 type: string required: - items title: phase_configuration_params type: object type: array proration_behavior: enum: - always_invoice - create_prorations - none type: string title: schedule_details_params type: object subscription: description: >- The identifier of the subscription for which you'd like to retrieve the upcoming invoice. If not provided, but a `subscription_items` is provided, you will preview creating a subscription with those items. If neither `subscription` nor `subscription_items` is provided, you will retrieve the next upcoming invoice from among the customer's subscriptions. maxLength: 5000 type: string subscription_details: description: >- The subscription creation or modification params to apply as a preview. Cannot be used with `schedule` or `schedule_details` fields. properties: billing_cycle_anchor: anyOf: - enum: - now - unchanged maxLength: 5000 type: string - format: unix-time type: integer cancel_at: anyOf: - format: unix-time type: integer - enum: - '' type: string cancel_at_period_end: type: boolean cancel_now: type: boolean default_tax_rates: anyOf: - items: maxLength: 5000 type: string type: array - enum: - '' type: string items: items: properties: billing_thresholds: anyOf: - properties: usage_gte: type: integer required: - usage_gte title: item_billing_thresholds_param type: object - enum: - '' type: string clear_usage: type: boolean deleted: type: boolean discounts: anyOf: - items: properties: coupon: maxLength: 5000 type: string discount: maxLength: 5000 type: string promotion_code: maxLength: 5000 type: string title: discounts_data_param type: object type: array - enum: - '' type: string id: maxLength: 5000 type: string metadata: anyOf: - additionalProperties: type: string type: object - enum: - '' type: string price: maxLength: 5000 type: string price_data: properties: currency: type: string product: maxLength: 5000 type: string recurring: properties: interval: enum: - day - month - week - year type: string interval_count: type: integer required: - interval title: recurring_adhoc type: object tax_behavior: enum: - exclusive - inclusive - unspecified type: string unit_amount: type: integer unit_amount_decimal: format: decimal type: string required: - currency - product - recurring title: recurring_price_data type: object quantity: type: integer tax_rates: anyOf: - items: maxLength: 5000 type: string type: array - enum: - '' type: string title: subscription_item_update_params type: object type: array proration_behavior: enum: - always_invoice - create_prorations - none type: string proration_date: format: unix-time type: integer resume_at: enum: - now maxLength: 5000 type: string start_date: format: unix-time type: integer trial_end: anyOf: - enum: - now maxLength: 5000 type: string - format: unix-time type: integer title: subscription_details_params type: object type: object required: false responses: '200': content: application/json: schema: $ref: '#/components/schemas/invoice' description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. /v1/invoices/search: get: description: >-

Search for invoices you’ve previously created using Stripe’s Search Query Language. Don’t use search in read-after-write flows where strict consistency is necessary. Under normal operating conditions, data is searchable in less than a minute. Occasionally, propagation of new or updated data can be up to an hour behind during outages. Search functionality is not available to merchants in India.

operationId: GetInvoicesSearch parameters: - description: Specifies which fields in the response should be expanded. explode: true in: query name: expand required: false schema: items: maxLength: 5000 type: string type: array style: deepObject - description: >- A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. in: query name: limit required: false schema: type: integer style: form - description: >- A cursor for pagination across multiple pages of results. Don't include this parameter on the first call. Use the next_page value returned in a previous response to request subsequent results. in: query name: page required: false schema: maxLength: 5000 type: string style: form - description: >- The search query string. See [search query language](https://stripe.com/docs/search#search-query-language) and the list of supported [query fields for invoices](https://stripe.com/docs/search#query-fields-for-invoices). in: query name: query required: true schema: maxLength: 5000 type: string style: form requestBody: content: application/x-www-form-urlencoded: encoding: {} schema: additionalProperties: false properties: {} type: object required: false responses: '200': content: application/json: schema: description: '' properties: data: items: $ref: '#/components/schemas/invoice' type: array has_more: type: boolean next_page: maxLength: 5000 nullable: true type: string object: description: >- String representing the object's type. Objects of the same type share the same value. enum: - search_result type: string total_count: description: >- The total number of objects that match the query, only accurate up to 10,000. type: integer url: maxLength: 5000 type: string required: - data - has_more - object - url title: SearchResult type: object x-expandableFields: - data description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. /v1/invoices/upcoming: get: description: >-

At any time, you can preview the upcoming invoice for a customer. This will show you all the charges that are pending, including subscription renewal charges, invoice item charges, etc. It will also show you any discounts that are applicable to the invoice.

Note that when you are viewing an upcoming invoice, you are simply viewing a preview – the invoice has not yet been created. As such, the upcoming invoice will not show up in invoice listing calls, and you cannot use the API to pay or edit the invoice. If you want to change the amount that your customer will be billed, you can add, remove, or update pending invoice items, or update the customer’s discount.

You can preview the effects of updating a subscription, including a preview of what proration will take place. To ensure that the actual proration is calculated exactly the same as the previewed proration, you should pass the subscription_proration_date parameter when doing the actual subscription update. The recommended way to get only the prorations being previewed is to consider only proration line items where period[start] is equal to the subscription_proration_date value passed in the request.

operationId: GetInvoicesUpcoming parameters: - description: Settings for automatic tax lookup for this invoice preview. explode: true in: query name: automatic_tax required: false schema: properties: enabled: type: boolean liability: properties: account: type: string type: enum: - account - self type: string required: - type title: param type: object required: - enabled title: automatic_tax_param type: object style: deepObject - description: >- The ID of the coupon to apply to this phase of the subscription schedule. This field has been deprecated and will be removed in a future API version. Use `discounts` instead. in: query name: coupon required: false schema: maxLength: 5000 type: string style: form - description: >- The currency to preview this invoice in. Defaults to that of `customer` if not specified. in: query name: currency required: false schema: type: string style: form - description: >- The identifier of the customer whose upcoming invoice you'd like to retrieve. If `automatic_tax` is enabled then one of `customer`, `customer_details`, `subscription`, or `schedule` must be set. in: query name: customer required: false schema: maxLength: 5000 type: string style: form - description: >- Details about the customer you want to invoice or overrides for an existing customer. If `automatic_tax` is enabled then one of `customer`, `customer_details`, `subscription`, or `schedule` must be set. explode: true in: query name: customer_details required: false schema: properties: address: anyOf: - properties: city: maxLength: 5000 type: string country: maxLength: 5000 type: string line1: maxLength: 5000 type: string line2: maxLength: 5000 type: string postal_code: maxLength: 5000 type: string state: maxLength: 5000 type: string title: optional_fields_address type: object - enum: - '' type: string shipping: anyOf: - properties: address: properties: city: maxLength: 5000 type: string country: maxLength: 5000 type: string line1: maxLength: 5000 type: string line2: maxLength: 5000 type: string postal_code: maxLength: 5000 type: string state: maxLength: 5000 type: string title: optional_fields_address type: object name: maxLength: 5000 type: string phone: maxLength: 5000 type: string required: - address - name title: customer_shipping type: object - enum: - '' type: string tax: properties: ip_address: anyOf: - type: string - enum: - '' type: string title: tax_param type: object tax_exempt: enum: - '' - exempt - none - reverse type: string tax_ids: items: properties: type: enum: - ad_nrt - ae_trn - ar_cuit - au_abn - au_arn - bg_uic - bh_vat - bo_tin - br_cnpj - br_cpf - ca_bn - ca_gst_hst - ca_pst_bc - ca_pst_mb - ca_pst_sk - ca_qst - ch_vat - cl_tin - cn_tin - co_nit - cr_tin - do_rcn - ec_ruc - eg_tin - es_cif - eu_oss_vat - eu_vat - gb_vat - ge_vat - hk_br - hu_tin - id_npwp - il_vat - in_gst - is_vat - jp_cn - jp_rn - jp_trn - ke_pin - kr_brn - kz_bin - li_uid - mx_rfc - my_frp - my_itn - my_sst - ng_tin - no_vat - no_voec - nz_gst - om_vat - pe_ruc - ph_tin - ro_tin - rs_pib - ru_inn - ru_kpp - sa_vat - sg_gst - sg_uen - si_tin - sv_nit - th_vat - tr_tin - tw_vat - ua_vat - us_ein - uy_ruc - ve_rif - vn_tin - za_vat maxLength: 5000 type: string x-stripeBypassValidation: true value: type: string required: - type - value title: data_params type: object type: array title: customer_details_param type: object style: deepObject - description: >- The coupons to redeem into discounts for the invoice preview. If not specified, inherits the discount from the subscription or customer. This works for both coupons directly applied to an invoice and coupons applied to a subscription. Pass an empty string to avoid inheriting any discounts. explode: true in: query name: discounts required: false schema: anyOf: - items: properties: coupon: maxLength: 5000 type: string discount: maxLength: 5000 type: string promotion_code: maxLength: 5000 type: string title: discounts_data_param type: object type: array - enum: - '' type: string style: deepObject - description: Specifies which fields in the response should be expanded. explode: true in: query name: expand required: false schema: items: maxLength: 5000 type: string type: array style: deepObject - description: >- List of invoice items to add or update in the upcoming invoice preview. explode: true in: query name: invoice_items required: false schema: items: properties: amount: type: integer currency: type: string description: maxLength: 5000 type: string discountable: type: boolean discounts: anyOf: - items: properties: coupon: maxLength: 5000 type: string discount: maxLength: 5000 type: string promotion_code: maxLength: 5000 type: string title: discounts_data_param type: object type: array - enum: - '' type: string invoiceitem: maxLength: 5000 type: string metadata: anyOf: - additionalProperties: type: string type: object - enum: - '' type: string period: properties: end: format: unix-time type: integer start: format: unix-time type: integer required: - end - start title: period type: object price: maxLength: 5000 type: string price_data: properties: currency: type: string product: maxLength: 5000 type: string tax_behavior: enum: - exclusive - inclusive - unspecified type: string unit_amount: type: integer unit_amount_decimal: format: decimal type: string required: - currency - product title: one_time_price_data type: object quantity: type: integer tax_behavior: enum: - exclusive - inclusive - unspecified type: string tax_code: anyOf: - type: string - enum: - '' type: string tax_rates: anyOf: - items: maxLength: 5000 type: string type: array - enum: - '' type: string unit_amount: type: integer unit_amount_decimal: format: decimal type: string title: invoice_item_preview_params type: object type: array style: deepObject - description: >- The connected account that issues the invoice. The invoice is presented with the branding and support information of the specified account. explode: true in: query name: issuer required: false schema: properties: account: type: string type: enum: - account - self type: string required: - type title: param type: object style: deepObject - description: >- 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. explode: true in: query name: on_behalf_of required: false schema: anyOf: - type: string - enum: - '' type: string style: deepObject - description: >- The identifier of the schedule whose upcoming invoice you'd like to retrieve. Cannot be used with subscription or subscription fields. in: query name: schedule required: false schema: maxLength: 5000 type: string style: form - description: >- The schedule creation or modification params to apply as a preview. Cannot be used with `subscription` or `subscription_` prefixed fields. explode: true in: query name: schedule_details required: false schema: properties: end_behavior: enum: - cancel - release type: string phases: items: properties: add_invoice_items: items: properties: discounts: items: properties: coupon: maxLength: 5000 type: string discount: maxLength: 5000 type: string promotion_code: maxLength: 5000 type: string title: discounts_data_param type: object type: array price: maxLength: 5000 type: string price_data: properties: currency: type: string product: maxLength: 5000 type: string tax_behavior: enum: - exclusive - inclusive - unspecified type: string unit_amount: type: integer unit_amount_decimal: format: decimal type: string required: - currency - product title: one_time_price_data_with_negative_amounts type: object quantity: type: integer tax_rates: anyOf: - items: maxLength: 5000 type: string type: array - enum: - '' type: string title: add_invoice_item_entry type: object type: array application_fee_percent: type: number automatic_tax: properties: enabled: type: boolean liability: properties: account: type: string type: enum: - account - self type: string required: - type title: param type: object required: - enabled title: automatic_tax_config type: object billing_cycle_anchor: enum: - automatic - phase_start type: string billing_thresholds: anyOf: - properties: amount_gte: type: integer reset_billing_cycle_anchor: type: boolean title: billing_thresholds_param type: object - enum: - '' type: string collection_method: enum: - charge_automatically - send_invoice type: string coupon: maxLength: 5000 type: string default_payment_method: maxLength: 5000 type: string default_tax_rates: anyOf: - items: maxLength: 5000 type: string type: array - enum: - '' type: string description: anyOf: - maxLength: 500 type: string - enum: - '' type: string discounts: anyOf: - items: properties: coupon: maxLength: 5000 type: string discount: maxLength: 5000 type: string promotion_code: maxLength: 5000 type: string title: discounts_data_param type: object type: array - enum: - '' type: string end_date: anyOf: - format: unix-time type: integer - enum: - now maxLength: 5000 type: string invoice_settings: properties: account_tax_ids: anyOf: - items: maxLength: 5000 type: string type: array - enum: - '' type: string days_until_due: type: integer issuer: properties: account: type: string type: enum: - account - self type: string required: - type title: param type: object title: invoice_settings type: object items: items: properties: billing_thresholds: anyOf: - properties: usage_gte: type: integer required: - usage_gte title: item_billing_thresholds_param type: object - enum: - '' type: string discounts: anyOf: - items: properties: coupon: maxLength: 5000 type: string discount: maxLength: 5000 type: string promotion_code: maxLength: 5000 type: string title: discounts_data_param type: object type: array - enum: - '' type: string metadata: additionalProperties: type: string type: object price: maxLength: 5000 type: string price_data: properties: currency: type: string product: maxLength: 5000 type: string recurring: properties: interval: enum: - day - month - week - year type: string interval_count: type: integer required: - interval title: recurring_adhoc type: object tax_behavior: enum: - exclusive - inclusive - unspecified type: string unit_amount: type: integer unit_amount_decimal: format: decimal type: string required: - currency - product - recurring title: recurring_price_data type: object quantity: type: integer tax_rates: anyOf: - items: maxLength: 5000 type: string type: array - enum: - '' type: string title: configuration_item_params type: object type: array iterations: type: integer metadata: additionalProperties: type: string type: object on_behalf_of: type: string proration_behavior: enum: - always_invoice - create_prorations - none type: string start_date: anyOf: - format: unix-time type: integer - enum: - now maxLength: 5000 type: string transfer_data: properties: amount_percent: type: number destination: type: string required: - destination title: transfer_data_specs type: object trial: type: boolean trial_end: anyOf: - format: unix-time type: integer - enum: - now maxLength: 5000 type: string required: - items title: phase_configuration_params type: object type: array proration_behavior: enum: - always_invoice - create_prorations - none type: string title: schedule_details_params type: object style: deepObject - description: >- The identifier of the subscription for which you'd like to retrieve the upcoming invoice. If not provided, but a `subscription_items` is provided, you will preview creating a subscription with those items. If neither `subscription` nor `subscription_items` is provided, you will retrieve the next upcoming invoice from among the customer's subscriptions. in: query name: subscription required: false schema: maxLength: 5000 type: string style: form - description: >- For new subscriptions, a future timestamp to anchor the subscription's [billing cycle](https://stripe.com/docs/subscriptions/billing-cycle). This is used to determine the date of the first full invoice, and, for plans with `month` or `year` intervals, the day of the month for subsequent invoices. For existing subscriptions, the value can only be set to `now` or `unchanged`. explode: true in: query name: subscription_billing_cycle_anchor required: false schema: anyOf: - enum: - now - unchanged maxLength: 5000 type: string - format: unix-time type: integer style: deepObject - description: >- A timestamp at which the subscription should cancel. If set to a date before the current period ends, this will cause a proration if prorations have been enabled using `proration_behavior`. If set during a future period, this will always cause a proration for that period. explode: true in: query name: subscription_cancel_at required: false schema: anyOf: - format: unix-time type: integer - enum: - '' type: string style: deepObject - description: >- Boolean indicating whether this subscription should cancel at the end of the current period. in: query name: subscription_cancel_at_period_end required: false schema: type: boolean style: form - description: >- This simulates the subscription being canceled or expired immediately. in: query name: subscription_cancel_now required: false schema: type: boolean style: form - description: >- If provided, the invoice returned will preview updating or creating a subscription with these default tax rates. The default tax rates will apply to any line item that does not have `tax_rates` set. explode: true in: query name: subscription_default_tax_rates required: false schema: anyOf: - items: maxLength: 5000 type: string type: array - enum: - '' type: string style: deepObject - description: >- The subscription creation or modification params to apply as a preview. Cannot be used with `schedule` or `schedule_details` fields. explode: true in: query name: subscription_details required: false schema: properties: billing_cycle_anchor: anyOf: - enum: - now - unchanged maxLength: 5000 type: string - format: unix-time type: integer cancel_at: anyOf: - format: unix-time type: integer - enum: - '' type: string cancel_at_period_end: type: boolean cancel_now: type: boolean default_tax_rates: anyOf: - items: maxLength: 5000 type: string type: array - enum: - '' type: string items: items: properties: billing_thresholds: anyOf: - properties: usage_gte: type: integer required: - usage_gte title: item_billing_thresholds_param type: object - enum: - '' type: string clear_usage: type: boolean deleted: type: boolean discounts: anyOf: - items: properties: coupon: maxLength: 5000 type: string discount: maxLength: 5000 type: string promotion_code: maxLength: 5000 type: string title: discounts_data_param type: object type: array - enum: - '' type: string id: maxLength: 5000 type: string metadata: anyOf: - additionalProperties: type: string type: object - enum: - '' type: string price: maxLength: 5000 type: string price_data: properties: currency: type: string product: maxLength: 5000 type: string recurring: properties: interval: enum: - day - month - week - year type: string interval_count: type: integer required: - interval title: recurring_adhoc type: object tax_behavior: enum: - exclusive - inclusive - unspecified type: string unit_amount: type: integer unit_amount_decimal: format: decimal type: string required: - currency - product - recurring title: recurring_price_data type: object quantity: type: integer tax_rates: anyOf: - items: maxLength: 5000 type: string type: array - enum: - '' type: string title: subscription_item_update_params type: object type: array proration_behavior: enum: - always_invoice - create_prorations - none type: string proration_date: format: unix-time type: integer resume_at: enum: - now maxLength: 5000 type: string start_date: format: unix-time type: integer trial_end: anyOf: - enum: - now maxLength: 5000 type: string - format: unix-time type: integer title: subscription_details_params type: object style: deepObject - description: 'A list of up to 20 subscription items, each with an attached price.' explode: true in: query name: subscription_items required: false schema: items: properties: billing_thresholds: anyOf: - properties: usage_gte: type: integer required: - usage_gte title: item_billing_thresholds_param type: object - enum: - '' type: string clear_usage: type: boolean deleted: type: boolean discounts: anyOf: - items: properties: coupon: maxLength: 5000 type: string discount: maxLength: 5000 type: string promotion_code: maxLength: 5000 type: string title: discounts_data_param type: object type: array - enum: - '' type: string id: maxLength: 5000 type: string metadata: anyOf: - additionalProperties: type: string type: object - enum: - '' type: string price: maxLength: 5000 type: string price_data: properties: currency: type: string product: maxLength: 5000 type: string recurring: properties: interval: enum: - day - month - week - year type: string interval_count: type: integer required: - interval title: recurring_adhoc type: object tax_behavior: enum: - exclusive - inclusive - unspecified type: string unit_amount: type: integer unit_amount_decimal: format: decimal type: string required: - currency - product - recurring title: recurring_price_data type: object quantity: type: integer tax_rates: anyOf: - items: maxLength: 5000 type: string type: array - enum: - '' type: string title: subscription_item_update_params type: object type: array style: deepObject - description: >- Determines how to handle [prorations](https://stripe.com/docs/billing/subscriptions/prorations) when the billing cycle changes (e.g., when switching plans, resetting `billing_cycle_anchor=now`, or starting a trial), or if an item's `quantity` changes. The default value is `create_prorations`. in: query name: subscription_proration_behavior required: false schema: enum: - always_invoice - create_prorations - none type: string style: form - description: >- If previewing an update to a subscription, and doing proration, `subscription_proration_date` forces the proration to be calculated as though the update was done at the specified time. The time given must be within the current subscription period and within the current phase of the schedule backing this subscription, if the schedule exists. If set, `subscription`, and one of `subscription_items`, or `subscription_trial_end` are required. Also, `subscription_proration_behavior` cannot be set to 'none'. in: query name: subscription_proration_date required: false schema: format: unix-time type: integer style: form - description: >- For paused subscriptions, setting `subscription_resume_at` to `now` will preview the invoice that will be generated if the subscription is resumed. in: query name: subscription_resume_at required: false schema: enum: - now maxLength: 5000 type: string style: form - description: Date a subscription is intended to start (can be future or past). in: query name: subscription_start_date required: false schema: format: unix-time type: integer style: form - description: >- If provided, the invoice returned will preview updating or creating a subscription with that trial end. If set, one of `subscription_items` or `subscription` is required. explode: true in: query name: subscription_trial_end required: false schema: anyOf: - enum: - now maxLength: 5000 type: string - format: unix-time type: integer style: deepObject - description: >- Indicates if a plan's `trial_period_days` should be applied to the subscription. Setting `subscription_trial_end` per subscription is preferred, and this defaults to `false`. Setting this flag to `true` together with `subscription_trial_end` is not allowed. See [Using trial periods on subscriptions](https://stripe.com/docs/billing/subscriptions/trials) to learn more. in: query name: subscription_trial_from_plan required: false schema: type: boolean style: form requestBody: content: application/x-www-form-urlencoded: encoding: {} schema: additionalProperties: false properties: {} type: object required: false responses: '200': content: application/json: schema: $ref: '#/components/schemas/invoice' description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. /v1/invoices/upcoming/lines: get: description: >-

When retrieving an upcoming invoice, you’ll get a lines property containing the total count of line items and the first handful of those items. There is also a URL where you can retrieve the full (paginated) list of line items.

operationId: GetInvoicesUpcomingLines parameters: - description: Settings for automatic tax lookup for this invoice preview. explode: true in: query name: automatic_tax required: false schema: properties: enabled: type: boolean liability: properties: account: type: string type: enum: - account - self type: string required: - type title: param type: object required: - enabled title: automatic_tax_param type: object style: deepObject - description: >- The ID of the coupon to apply to this phase of the subscription schedule. This field has been deprecated and will be removed in a future API version. Use `discounts` instead. in: query name: coupon required: false schema: maxLength: 5000 type: string style: form - description: >- The currency to preview this invoice in. Defaults to that of `customer` if not specified. in: query name: currency required: false schema: type: string style: form - description: >- The identifier of the customer whose upcoming invoice you'd like to retrieve. If `automatic_tax` is enabled then one of `customer`, `customer_details`, `subscription`, or `schedule` must be set. in: query name: customer required: false schema: maxLength: 5000 type: string style: form - description: >- Details about the customer you want to invoice or overrides for an existing customer. If `automatic_tax` is enabled then one of `customer`, `customer_details`, `subscription`, or `schedule` must be set. explode: true in: query name: customer_details required: false schema: properties: address: anyOf: - properties: city: maxLength: 5000 type: string country: maxLength: 5000 type: string line1: maxLength: 5000 type: string line2: maxLength: 5000 type: string postal_code: maxLength: 5000 type: string state: maxLength: 5000 type: string title: optional_fields_address type: object - enum: - '' type: string shipping: anyOf: - properties: address: properties: city: maxLength: 5000 type: string country: maxLength: 5000 type: string line1: maxLength: 5000 type: string line2: maxLength: 5000 type: string postal_code: maxLength: 5000 type: string state: maxLength: 5000 type: string title: optional_fields_address type: object name: maxLength: 5000 type: string phone: maxLength: 5000 type: string required: - address - name title: customer_shipping type: object - enum: - '' type: string tax: properties: ip_address: anyOf: - type: string - enum: - '' type: string title: tax_param type: object tax_exempt: enum: - '' - exempt - none - reverse type: string tax_ids: items: properties: type: enum: - ad_nrt - ae_trn - ar_cuit - au_abn - au_arn - bg_uic - bh_vat - bo_tin - br_cnpj - br_cpf - ca_bn - ca_gst_hst - ca_pst_bc - ca_pst_mb - ca_pst_sk - ca_qst - ch_vat - cl_tin - cn_tin - co_nit - cr_tin - do_rcn - ec_ruc - eg_tin - es_cif - eu_oss_vat - eu_vat - gb_vat - ge_vat - hk_br - hu_tin - id_npwp - il_vat - in_gst - is_vat - jp_cn - jp_rn - jp_trn - ke_pin - kr_brn - kz_bin - li_uid - mx_rfc - my_frp - my_itn - my_sst - ng_tin - no_vat - no_voec - nz_gst - om_vat - pe_ruc - ph_tin - ro_tin - rs_pib - ru_inn - ru_kpp - sa_vat - sg_gst - sg_uen - si_tin - sv_nit - th_vat - tr_tin - tw_vat - ua_vat - us_ein - uy_ruc - ve_rif - vn_tin - za_vat maxLength: 5000 type: string x-stripeBypassValidation: true value: type: string required: - type - value title: data_params type: object type: array title: customer_details_param type: object style: deepObject - description: >- The coupons to redeem into discounts for the invoice preview. If not specified, inherits the discount from the subscription or customer. This works for both coupons directly applied to an invoice and coupons applied to a subscription. Pass an empty string to avoid inheriting any discounts. explode: true in: query name: discounts required: false schema: anyOf: - items: properties: coupon: maxLength: 5000 type: string discount: maxLength: 5000 type: string promotion_code: maxLength: 5000 type: string title: discounts_data_param type: object type: array - enum: - '' type: string style: deepObject - description: >- A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. in: query name: ending_before required: false schema: maxLength: 5000 type: string style: form - description: Specifies which fields in the response should be expanded. explode: true in: query name: expand required: false schema: items: maxLength: 5000 type: string type: array style: deepObject - description: >- List of invoice items to add or update in the upcoming invoice preview. explode: true in: query name: invoice_items required: false schema: items: properties: amount: type: integer currency: type: string description: maxLength: 5000 type: string discountable: type: boolean discounts: anyOf: - items: properties: coupon: maxLength: 5000 type: string discount: maxLength: 5000 type: string promotion_code: maxLength: 5000 type: string title: discounts_data_param type: object type: array - enum: - '' type: string invoiceitem: maxLength: 5000 type: string metadata: anyOf: - additionalProperties: type: string type: object - enum: - '' type: string period: properties: end: format: unix-time type: integer start: format: unix-time type: integer required: - end - start title: period type: object price: maxLength: 5000 type: string price_data: properties: currency: type: string product: maxLength: 5000 type: string tax_behavior: enum: - exclusive - inclusive - unspecified type: string unit_amount: type: integer unit_amount_decimal: format: decimal type: string required: - currency - product title: one_time_price_data type: object quantity: type: integer tax_behavior: enum: - exclusive - inclusive - unspecified type: string tax_code: anyOf: - type: string - enum: - '' type: string tax_rates: anyOf: - items: maxLength: 5000 type: string type: array - enum: - '' type: string unit_amount: type: integer unit_amount_decimal: format: decimal type: string title: invoice_item_preview_params type: object type: array style: deepObject - description: >- The connected account that issues the invoice. The invoice is presented with the branding and support information of the specified account. explode: true in: query name: issuer required: false schema: properties: account: type: string type: enum: - account - self type: string required: - type title: param type: object style: deepObject - description: >- A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. in: query name: limit required: false schema: type: integer style: form - description: >- 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. explode: true in: query name: on_behalf_of required: false schema: anyOf: - type: string - enum: - '' type: string style: deepObject - description: >- The identifier of the schedule whose upcoming invoice you'd like to retrieve. Cannot be used with subscription or subscription fields. in: query name: schedule required: false schema: maxLength: 5000 type: string style: form - description: >- The schedule creation or modification params to apply as a preview. Cannot be used with `subscription` or `subscription_` prefixed fields. explode: true in: query name: schedule_details required: false schema: properties: end_behavior: enum: - cancel - release type: string phases: items: properties: add_invoice_items: items: properties: discounts: items: properties: coupon: maxLength: 5000 type: string discount: maxLength: 5000 type: string promotion_code: maxLength: 5000 type: string title: discounts_data_param type: object type: array price: maxLength: 5000 type: string price_data: properties: currency: type: string product: maxLength: 5000 type: string tax_behavior: enum: - exclusive - inclusive - unspecified type: string unit_amount: type: integer unit_amount_decimal: format: decimal type: string required: - currency - product title: one_time_price_data_with_negative_amounts type: object quantity: type: integer tax_rates: anyOf: - items: maxLength: 5000 type: string type: array - enum: - '' type: string title: add_invoice_item_entry type: object type: array application_fee_percent: type: number automatic_tax: properties: enabled: type: boolean liability: properties: account: type: string type: enum: - account - self type: string required: - type title: param type: object required: - enabled title: automatic_tax_config type: object billing_cycle_anchor: enum: - automatic - phase_start type: string billing_thresholds: anyOf: - properties: amount_gte: type: integer reset_billing_cycle_anchor: type: boolean title: billing_thresholds_param type: object - enum: - '' type: string collection_method: enum: - charge_automatically - send_invoice type: string coupon: maxLength: 5000 type: string default_payment_method: maxLength: 5000 type: string default_tax_rates: anyOf: - items: maxLength: 5000 type: string type: array - enum: - '' type: string description: anyOf: - maxLength: 500 type: string - enum: - '' type: string discounts: anyOf: - items: properties: coupon: maxLength: 5000 type: string discount: maxLength: 5000 type: string promotion_code: maxLength: 5000 type: string title: discounts_data_param type: object type: array - enum: - '' type: string end_date: anyOf: - format: unix-time type: integer - enum: - now maxLength: 5000 type: string invoice_settings: properties: account_tax_ids: anyOf: - items: maxLength: 5000 type: string type: array - enum: - '' type: string days_until_due: type: integer issuer: properties: account: type: string type: enum: - account - self type: string required: - type title: param type: object title: invoice_settings type: object items: items: properties: billing_thresholds: anyOf: - properties: usage_gte: type: integer required: - usage_gte title: item_billing_thresholds_param type: object - enum: - '' type: string discounts: anyOf: - items: properties: coupon: maxLength: 5000 type: string discount: maxLength: 5000 type: string promotion_code: maxLength: 5000 type: string title: discounts_data_param type: object type: array - enum: - '' type: string metadata: additionalProperties: type: string type: object price: maxLength: 5000 type: string price_data: properties: currency: type: string product: maxLength: 5000 type: string recurring: properties: interval: enum: - day - month - week - year type: string interval_count: type: integer required: - interval title: recurring_adhoc type: object tax_behavior: enum: - exclusive - inclusive - unspecified type: string unit_amount: type: integer unit_amount_decimal: format: decimal type: string required: - currency - product - recurring title: recurring_price_data type: object quantity: type: integer tax_rates: anyOf: - items: maxLength: 5000 type: string type: array - enum: - '' type: string title: configuration_item_params type: object type: array iterations: type: integer metadata: additionalProperties: type: string type: object on_behalf_of: type: string proration_behavior: enum: - always_invoice - create_prorations - none type: string start_date: anyOf: - format: unix-time type: integer - enum: - now maxLength: 5000 type: string transfer_data: properties: amount_percent: type: number destination: type: string required: - destination title: transfer_data_specs type: object trial: type: boolean trial_end: anyOf: - format: unix-time type: integer - enum: - now maxLength: 5000 type: string required: - items title: phase_configuration_params type: object type: array proration_behavior: enum: - always_invoice - create_prorations - none type: string title: schedule_details_params type: object style: deepObject - description: >- A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. in: query name: starting_after required: false schema: maxLength: 5000 type: string style: form - description: >- The identifier of the subscription for which you'd like to retrieve the upcoming invoice. If not provided, but a `subscription_items` is provided, you will preview creating a subscription with those items. If neither `subscription` nor `subscription_items` is provided, you will retrieve the next upcoming invoice from among the customer's subscriptions. in: query name: subscription required: false schema: maxLength: 5000 type: string style: form - description: >- For new subscriptions, a future timestamp to anchor the subscription's [billing cycle](https://stripe.com/docs/subscriptions/billing-cycle). This is used to determine the date of the first full invoice, and, for plans with `month` or `year` intervals, the day of the month for subsequent invoices. For existing subscriptions, the value can only be set to `now` or `unchanged`. explode: true in: query name: subscription_billing_cycle_anchor required: false schema: anyOf: - enum: - now - unchanged maxLength: 5000 type: string - format: unix-time type: integer style: deepObject - description: >- A timestamp at which the subscription should cancel. If set to a date before the current period ends, this will cause a proration if prorations have been enabled using `proration_behavior`. If set during a future period, this will always cause a proration for that period. explode: true in: query name: subscription_cancel_at required: false schema: anyOf: - format: unix-time type: integer - enum: - '' type: string style: deepObject - description: >- Boolean indicating whether this subscription should cancel at the end of the current period. in: query name: subscription_cancel_at_period_end required: false schema: type: boolean style: form - description: >- This simulates the subscription being canceled or expired immediately. in: query name: subscription_cancel_now required: false schema: type: boolean style: form - description: >- If provided, the invoice returned will preview updating or creating a subscription with these default tax rates. The default tax rates will apply to any line item that does not have `tax_rates` set. explode: true in: query name: subscription_default_tax_rates required: false schema: anyOf: - items: maxLength: 5000 type: string type: array - enum: - '' type: string style: deepObject - description: >- The subscription creation or modification params to apply as a preview. Cannot be used with `schedule` or `schedule_details` fields. explode: true in: query name: subscription_details required: false schema: properties: billing_cycle_anchor: anyOf: - enum: - now - unchanged maxLength: 5000 type: string - format: unix-time type: integer cancel_at: anyOf: - format: unix-time type: integer - enum: - '' type: string cancel_at_period_end: type: boolean cancel_now: type: boolean default_tax_rates: anyOf: - items: maxLength: 5000 type: string type: array - enum: - '' type: string items: items: properties: billing_thresholds: anyOf: - properties: usage_gte: type: integer required: - usage_gte title: item_billing_thresholds_param type: object - enum: - '' type: string clear_usage: type: boolean deleted: type: boolean discounts: anyOf: - items: properties: coupon: maxLength: 5000 type: string discount: maxLength: 5000 type: string promotion_code: maxLength: 5000 type: string title: discounts_data_param type: object type: array - enum: - '' type: string id: maxLength: 5000 type: string metadata: anyOf: - additionalProperties: type: string type: object - enum: - '' type: string price: maxLength: 5000 type: string price_data: properties: currency: type: string product: maxLength: 5000 type: string recurring: properties: interval: enum: - day - month - week - year type: string interval_count: type: integer required: - interval title: recurring_adhoc type: object tax_behavior: enum: - exclusive - inclusive - unspecified type: string unit_amount: type: integer unit_amount_decimal: format: decimal type: string required: - currency - product - recurring title: recurring_price_data type: object quantity: type: integer tax_rates: anyOf: - items: maxLength: 5000 type: string type: array - enum: - '' type: string title: subscription_item_update_params type: object type: array proration_behavior: enum: - always_invoice - create_prorations - none type: string proration_date: format: unix-time type: integer resume_at: enum: - now maxLength: 5000 type: string start_date: format: unix-time type: integer trial_end: anyOf: - enum: - now maxLength: 5000 type: string - format: unix-time type: integer title: subscription_details_params type: object style: deepObject - description: 'A list of up to 20 subscription items, each with an attached price.' explode: true in: query name: subscription_items required: false schema: items: properties: billing_thresholds: anyOf: - properties: usage_gte: type: integer required: - usage_gte title: item_billing_thresholds_param type: object - enum: - '' type: string clear_usage: type: boolean deleted: type: boolean discounts: anyOf: - items: properties: coupon: maxLength: 5000 type: string discount: maxLength: 5000 type: string promotion_code: maxLength: 5000 type: string title: discounts_data_param type: object type: array - enum: - '' type: string id: maxLength: 5000 type: string metadata: anyOf: - additionalProperties: type: string type: object - enum: - '' type: string price: maxLength: 5000 type: string price_data: properties: currency: type: string product: maxLength: 5000 type: string recurring: properties: interval: enum: - day - month - week - year type: string interval_count: type: integer required: - interval title: recurring_adhoc type: object tax_behavior: enum: - exclusive - inclusive - unspecified type: string unit_amount: type: integer unit_amount_decimal: format: decimal type: string required: - currency - product - recurring title: recurring_price_data type: object quantity: type: integer tax_rates: anyOf: - items: maxLength: 5000 type: string type: array - enum: - '' type: string title: subscription_item_update_params type: object type: array style: deepObject - description: >- Determines how to handle [prorations](https://stripe.com/docs/billing/subscriptions/prorations) when the billing cycle changes (e.g., when switching plans, resetting `billing_cycle_anchor=now`, or starting a trial), or if an item's `quantity` changes. The default value is `create_prorations`. in: query name: subscription_proration_behavior required: false schema: enum: - always_invoice - create_prorations - none type: string style: form - description: >- If previewing an update to a subscription, and doing proration, `subscription_proration_date` forces the proration to be calculated as though the update was done at the specified time. The time given must be within the current subscription period and within the current phase of the schedule backing this subscription, if the schedule exists. If set, `subscription`, and one of `subscription_items`, or `subscription_trial_end` are required. Also, `subscription_proration_behavior` cannot be set to 'none'. in: query name: subscription_proration_date required: false schema: format: unix-time type: integer style: form - description: >- For paused subscriptions, setting `subscription_resume_at` to `now` will preview the invoice that will be generated if the subscription is resumed. in: query name: subscription_resume_at required: false schema: enum: - now maxLength: 5000 type: string style: form - description: Date a subscription is intended to start (can be future or past). in: query name: subscription_start_date required: false schema: format: unix-time type: integer style: form - description: >- If provided, the invoice returned will preview updating or creating a subscription with that trial end. If set, one of `subscription_items` or `subscription` is required. explode: true in: query name: subscription_trial_end required: false schema: anyOf: - enum: - now maxLength: 5000 type: string - format: unix-time type: integer style: deepObject - description: >- Indicates if a plan's `trial_period_days` should be applied to the subscription. Setting `subscription_trial_end` per subscription is preferred, and this defaults to `false`. Setting this flag to `true` together with `subscription_trial_end` is not allowed. See [Using trial periods on subscriptions](https://stripe.com/docs/billing/subscriptions/trials) to learn more. in: query name: subscription_trial_from_plan required: false schema: type: boolean style: form requestBody: content: application/x-www-form-urlencoded: encoding: {} schema: additionalProperties: false properties: {} type: object required: false responses: '200': content: application/json: schema: description: '' properties: data: description: Details about each object. items: $ref: '#/components/schemas/line_item' type: array has_more: description: >- True if this list has another page of items after this one that can be fetched. type: boolean object: description: >- String representing the object's type. Objects of the same type share the same value. Always has the value `list`. enum: - list type: string url: description: The URL where this list can be accessed. maxLength: 5000 type: string required: - data - has_more - object - url title: InvoiceLinesList type: object x-expandableFields: - data description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. '/v1/invoices/{invoice}': delete: description: >-

Permanently deletes a one-off invoice draft. This cannot be undone. Attempts to delete invoices that are no longer in a draft state will fail; once an invoice has been finalized or if an invoice is for a subscription, it must be voided.

operationId: DeleteInvoicesInvoice parameters: - in: path name: invoice required: true schema: maxLength: 5000 type: string style: simple requestBody: content: application/x-www-form-urlencoded: encoding: {} schema: additionalProperties: false properties: {} type: object required: false responses: '200': content: application/json: schema: $ref: '#/components/schemas/deleted_invoice' description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. get: description:

Retrieves the invoice with the given ID.

operationId: GetInvoicesInvoice parameters: - description: Specifies which fields in the response should be expanded. explode: true in: query name: expand required: false schema: items: maxLength: 5000 type: string type: array style: deepObject - in: path name: invoice required: true schema: maxLength: 5000 type: string style: simple requestBody: content: application/x-www-form-urlencoded: encoding: {} schema: additionalProperties: false properties: {} type: object required: false responses: '200': content: application/json: schema: $ref: '#/components/schemas/invoice' description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. post: description: >-

Draft invoices are fully editable. Once an invoice is finalized, monetary values, as well as collection_method, become uneditable.

If you would like to stop the Stripe Billing engine from automatically finalizing, reattempting payments on, sending reminders for, or automatically reconciling invoices, pass auto_advance=false.

operationId: PostInvoicesInvoice parameters: - in: path name: invoice required: true schema: maxLength: 5000 type: string style: simple requestBody: content: application/x-www-form-urlencoded: encoding: account_tax_ids: explode: true style: deepObject automatic_tax: explode: true style: deepObject custom_fields: explode: true style: deepObject default_source: explode: true style: deepObject default_tax_rates: explode: true style: deepObject discounts: explode: true style: deepObject effective_at: explode: true style: deepObject expand: explode: true style: deepObject issuer: explode: true style: deepObject metadata: explode: true style: deepObject number: explode: true style: deepObject on_behalf_of: explode: true style: deepObject payment_settings: explode: true style: deepObject rendering: explode: true style: deepObject shipping_cost: explode: true style: deepObject shipping_details: explode: true style: deepObject transfer_data: explode: true style: deepObject schema: additionalProperties: false properties: account_tax_ids: anyOf: - items: maxLength: 5000 type: string type: array - enum: - '' type: string description: >- The account tax IDs associated with the invoice. Only editable when the invoice is a draft. application_fee_amount: description: >- A fee in cents (or local equivalent) that will be applied to the invoice and transferred to the application owner's Stripe account. The request must be made with an OAuth key or the Stripe-Account header in order to take an application fee. For more information, see the application fees [documentation](https://stripe.com/docs/billing/invoices/connect#collecting-fees). type: integer auto_advance: description: >- Controls whether Stripe performs [automatic collection](https://stripe.com/docs/invoicing/integration/automatic-advancement-collection) of the invoice. type: boolean automatic_tax: description: Settings for automatic tax lookup for this invoice. properties: enabled: type: boolean liability: properties: account: type: string type: enum: - account - self type: string required: - type title: param type: object required: - enabled title: automatic_tax_param type: object collection_method: description: >- Either `charge_automatically` or `send_invoice`. This field can be updated only on `draft` invoices. enum: - charge_automatically - send_invoice type: string custom_fields: anyOf: - items: properties: name: maxLength: 40 type: string value: maxLength: 140 type: string required: - name - value title: custom_field_params type: object type: array - enum: - '' type: string description: >- A list of up to 4 custom fields to be displayed on the invoice. If a value for `custom_fields` is specified, the list specified will replace the existing custom field list on this invoice. Pass an empty string to remove previously-defined fields. days_until_due: description: >- The number of days from which the invoice is created until it is due. Only valid for invoices where `collection_method=send_invoice`. This field can only be updated on `draft` invoices. type: integer default_payment_method: description: >- 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. maxLength: 5000 type: string default_source: anyOf: - maxLength: 5000 type: string - enum: - '' type: string description: >- 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: anyOf: - items: maxLength: 5000 type: string type: array - enum: - '' type: string description: >- The tax rates that will apply to any line item that does not have `tax_rates` set. Pass an empty string to remove previously-defined tax rates. description: description: >- An arbitrary string attached to the object. Often useful for displaying to users. Referenced as 'memo' in the Dashboard. maxLength: 1500 type: string discounts: anyOf: - items: properties: coupon: maxLength: 5000 type: string discount: maxLength: 5000 type: string promotion_code: maxLength: 5000 type: string title: discounts_data_param type: object type: array - enum: - '' type: string description: >- The discounts that will apply to the invoice. Pass an empty string to remove previously-defined discounts. due_date: description: >- The date on which payment for this invoice is due. Only valid for invoices where `collection_method=send_invoice`. This field can only be updated on `draft` invoices. format: unix-time type: integer effective_at: anyOf: - format: unix-time type: integer - enum: - '' type: string description: >- 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. expand: description: Specifies which fields in the response should be expanded. items: maxLength: 5000 type: string type: array footer: description: Footer to be displayed on the invoice. maxLength: 5000 type: string issuer: description: >- The connected account that issues the invoice. The invoice is presented with the branding and support information of the specified account. properties: account: type: string type: enum: - account - self type: string required: - type title: param type: object metadata: anyOf: - additionalProperties: type: string type: object - enum: - '' type: string description: >- Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. number: anyOf: - maxLength: 26 type: string - enum: - '' type: string description: >- Set the number for this invoice. If no number is present then a number will be assigned automatically when the invoice is finalized. In many markets, regulations require invoices to be unique, sequential and / or gapless. You are responsible for ensuring this is true across all your different invoicing systems in the event that you edit the invoice number using our API. If you use only Stripe for your invoices and do not change invoice numbers, Stripe handles this aspect of compliance for you automatically. on_behalf_of: anyOf: - type: string - enum: - '' type: string description: >- 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. payment_settings: description: >- Configuration settings for the PaymentIntent that is generated when the invoice is finalized. properties: default_mandate: anyOf: - maxLength: 5000 type: string - enum: - '' type: string payment_method_options: properties: acss_debit: anyOf: - properties: mandate_options: properties: transaction_type: enum: - business - personal type: string title: mandate_options_param type: object verification_method: enum: - automatic - instant - microdeposits type: string x-stripeBypassValidation: true title: invoice_payment_method_options_param type: object - enum: - '' type: string bancontact: anyOf: - properties: preferred_language: enum: - de - en - fr - nl type: string title: invoice_payment_method_options_param type: object - enum: - '' type: string card: anyOf: - properties: installments: properties: enabled: type: boolean plan: anyOf: - properties: count: type: integer interval: enum: - month type: string type: enum: - fixed_count type: string required: - count - interval - type title: installment_plan type: object - enum: - '' type: string title: installments_param type: object request_three_d_secure: enum: - any - automatic - challenge type: string title: invoice_payment_method_options_param type: object - enum: - '' type: string customer_balance: anyOf: - properties: bank_transfer: properties: eu_bank_transfer: properties: country: maxLength: 5000 type: string required: - country title: eu_bank_transfer_param type: object type: type: string title: bank_transfer_param type: object funding_type: type: string title: invoice_payment_method_options_param type: object - enum: - '' type: string konbini: anyOf: - properties: {} title: invoice_payment_method_options_param type: object - enum: - '' type: string sepa_debit: anyOf: - properties: {} title: invoice_payment_method_options_param type: object - enum: - '' type: string us_bank_account: anyOf: - properties: financial_connections: properties: permissions: items: enum: - balances - ownership - payment_method - transactions maxLength: 5000 type: string x-stripeBypassValidation: true type: array prefetch: items: enum: - balances - ownership - transactions type: string x-stripeBypassValidation: true type: array title: invoice_linked_account_options_param type: object verification_method: enum: - automatic - instant - microdeposits type: string x-stripeBypassValidation: true title: invoice_payment_method_options_param type: object - enum: - '' type: string title: payment_method_options type: object payment_method_types: anyOf: - items: enum: - ach_credit_transfer - ach_debit - acss_debit - au_becs_debit - bacs_debit - bancontact - boleto - card - cashapp - customer_balance - eps - fpx - giropay - grabpay - ideal - konbini - link - p24 - paynow - paypal - promptpay - sepa_debit - sofort - us_bank_account - wechat_pay type: string x-stripeBypassValidation: true type: array - enum: - '' type: string title: payment_settings type: object rendering: description: >- The rendering-related settings that control how the invoice is displayed on customer-facing surfaces such as PDF and Hosted Invoice Page. properties: amount_tax_display: enum: - '' - exclude_tax - include_inclusive_tax type: string pdf: properties: page_size: enum: - a4 - auto - letter type: string title: rendering_pdf_param type: object title: rendering_param type: object shipping_cost: anyOf: - properties: shipping_rate: maxLength: 5000 type: string shipping_rate_data: properties: delivery_estimate: properties: maximum: properties: unit: enum: - business_day - day - hour - month - week type: string value: type: integer required: - unit - value title: delivery_estimate_bound type: object minimum: properties: unit: enum: - business_day - day - hour - month - week type: string value: type: integer required: - unit - value title: delivery_estimate_bound type: object title: delivery_estimate type: object display_name: maxLength: 100 type: string fixed_amount: properties: amount: type: integer currency: type: string currency_options: additionalProperties: properties: amount: type: integer tax_behavior: enum: - exclusive - inclusive - unspecified type: string required: - amount title: currency_option type: object type: object required: - amount - currency title: fixed_amount type: object metadata: additionalProperties: type: string type: object tax_behavior: enum: - exclusive - inclusive - unspecified type: string tax_code: type: string type: enum: - fixed_amount type: string required: - display_name title: method_params type: object title: shipping_cost type: object - enum: - '' type: string description: Settings for the cost of shipping for this invoice. shipping_details: anyOf: - properties: address: properties: city: maxLength: 5000 type: string country: maxLength: 5000 type: string line1: maxLength: 5000 type: string line2: maxLength: 5000 type: string postal_code: maxLength: 5000 type: string state: maxLength: 5000 type: string title: optional_fields_address type: object name: maxLength: 5000 type: string phone: anyOf: - maxLength: 5000 type: string - enum: - '' type: string required: - address - name title: recipient_shipping_with_optional_fields_address type: object - enum: - '' type: string description: >- Shipping details for the invoice. The Invoice PDF will use the `shipping_details` value if it is set, otherwise the PDF will render the shipping address from the customer. statement_descriptor: description: >- Extra information about a charge for the customer's credit card statement. It must contain at least one letter. If not specified and this invoice is part of a subscription, the default `statement_descriptor` will be set to the first subscription item's product's `statement_descriptor`. maxLength: 22 type: string transfer_data: anyOf: - properties: amount: type: integer destination: type: string required: - destination title: transfer_data_specs type: object - enum: - '' type: string description: >- If specified, the funds from the invoice will be transferred to the destination and the ID of the resulting transfer will be found on the invoice's charge. This will be unset if you POST an empty value. type: object required: false responses: '200': content: application/json: schema: $ref: '#/components/schemas/invoice' description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. '/v1/invoices/{invoice}/finalize': post: description: >-

Stripe automatically finalizes drafts before sending and attempting payment on invoices. However, if you’d like to finalize a draft invoice manually, you can do so using this method.

operationId: PostInvoicesInvoiceFinalize parameters: - in: path name: invoice required: true schema: maxLength: 5000 type: string style: simple requestBody: content: application/x-www-form-urlencoded: encoding: expand: explode: true style: deepObject schema: additionalProperties: false properties: auto_advance: description: >- 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. type: boolean expand: description: Specifies which fields in the response should be expanded. items: maxLength: 5000 type: string type: array type: object required: false responses: '200': content: application/json: schema: $ref: '#/components/schemas/invoice' description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. '/v1/invoices/{invoice}/lines': get: description: >-

When retrieving an invoice, you’ll get a lines property containing the total count of line items and the first handful of those items. There is also a URL where you can retrieve the full (paginated) list of line items.

operationId: GetInvoicesInvoiceLines parameters: - description: >- A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. in: query name: ending_before required: false schema: maxLength: 5000 type: string style: form - description: Specifies which fields in the response should be expanded. explode: true in: query name: expand required: false schema: items: maxLength: 5000 type: string type: array style: deepObject - in: path name: invoice required: true schema: maxLength: 5000 type: string style: simple - description: >- A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. in: query name: limit required: false schema: type: integer style: form - description: >- A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. in: query name: starting_after required: false schema: maxLength: 5000 type: string style: form requestBody: content: application/x-www-form-urlencoded: encoding: {} schema: additionalProperties: false properties: {} type: object required: false responses: '200': content: application/json: schema: description: '' properties: data: description: Details about each object. items: $ref: '#/components/schemas/line_item' type: array has_more: description: >- True if this list has another page of items after this one that can be fetched. type: boolean object: description: >- String representing the object's type. Objects of the same type share the same value. Always has the value `list`. enum: - list type: string url: description: The URL where this list can be accessed. maxLength: 5000 type: string required: - data - has_more - object - url title: InvoiceLinesList type: object x-expandableFields: - data description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. '/v1/invoices/{invoice}/lines/{line_item_id}': post: description: >-

Updates an invoice’s line item. Some fields, such as tax_amounts, only live on the invoice line item, so they can only be updated through this endpoint. Other fields, such as amount, live on both the invoice item and the invoice line item, so updates on this endpoint will propagate to the invoice item as well. Updating an invoice’s line item is only possible before the invoice is finalized.

operationId: PostInvoicesInvoiceLinesLineItemId parameters: - description: Invoice ID of line item in: path name: invoice required: true schema: maxLength: 5000 type: string style: simple - description: Invoice line item ID in: path name: line_item_id required: true schema: maxLength: 5000 type: string style: simple requestBody: content: application/x-www-form-urlencoded: encoding: discounts: explode: true style: deepObject expand: explode: true style: deepObject metadata: explode: true style: deepObject period: explode: true style: deepObject price_data: explode: true style: deepObject tax_amounts: explode: true style: deepObject tax_rates: explode: true style: deepObject schema: additionalProperties: false properties: amount: description: >- The integer amount in cents (or local equivalent) of the charge to be applied to the upcoming invoice. If you want to apply a credit to the customer's account, pass a negative amount. type: integer description: description: >- An arbitrary string which you can attach to the invoice item. The description is displayed in the invoice for easy tracking. maxLength: 5000 type: string discountable: description: >- Controls whether discounts apply to this line item. Defaults to false for prorations or negative line items, and true for all other line items. Cannot be set to true for prorations. type: boolean discounts: anyOf: - items: properties: coupon: maxLength: 5000 type: string discount: maxLength: 5000 type: string promotion_code: maxLength: 5000 type: string title: discounts_data_param type: object type: array - enum: - '' type: string description: >- The coupons, promotion codes & existing discounts which apply to the line item. Item discounts are applied before invoice discounts. Pass an empty string to remove previously-defined discounts. expand: description: Specifies which fields in the response should be expanded. items: maxLength: 5000 type: string type: array metadata: anyOf: - additionalProperties: type: string type: object - enum: - '' type: string description: >- Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. period: description: >- The period associated with this invoice item. When set to different values, the period will be rendered on the invoice. If you have [Stripe Revenue Recognition](https://stripe.com/docs/revenue-recognition) enabled, the period will be used to recognize and defer revenue. See the [Revenue Recognition documentation](https://stripe.com/docs/revenue-recognition/methodology/subscriptions-and-invoicing) for details. properties: end: format: unix-time type: integer start: format: unix-time type: integer required: - end - start title: period type: object price: description: The ID of the price object. maxLength: 5000 type: string price_data: description: >- Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline. properties: currency: type: string product: maxLength: 5000 type: string product_data: properties: description: maxLength: 40000 type: string images: items: type: string type: array metadata: additionalProperties: type: string type: object name: maxLength: 5000 type: string tax_code: maxLength: 5000 type: string required: - name title: product_data type: object tax_behavior: enum: - exclusive - inclusive - unspecified type: string unit_amount: type: integer unit_amount_decimal: format: decimal type: string required: - currency title: one_time_price_data_with_product_data type: object quantity: description: >- Non-negative integer. The quantity of units for the line item. type: integer tax_amounts: anyOf: - items: properties: amount: type: integer tax_rate_data: properties: country: maxLength: 5000 type: string description: maxLength: 5000 type: string display_name: maxLength: 50 type: string inclusive: type: boolean jurisdiction: maxLength: 50 type: string percentage: type: number state: maxLength: 2 type: string tax_type: enum: - amusement_tax - communications_tax - gst - hst - igst - jct - lease_tax - pst - qst - rst - sales_tax - vat type: string x-stripeBypassValidation: true required: - display_name - inclusive - percentage title: tax_rate_data_param type: object taxable_amount: type: integer required: - amount - tax_rate_data - taxable_amount title: tax_amount_param type: object type: array - enum: - '' type: string description: >- A list of up to 10 tax amounts for this line item. This can be useful if you calculate taxes on your own or use a third-party to calculate them. You cannot set tax amounts if any line item has [tax_rates](https://stripe.com/docs/api/invoices/line_item#invoice_line_item_object-tax_rates) or if the invoice has [default_tax_rates](https://stripe.com/docs/api/invoices/object#invoice_object-default_tax_rates) or uses [automatic tax](https://stripe.com/docs/tax/invoicing). Pass an empty string to remove previously defined tax amounts. tax_rates: anyOf: - items: maxLength: 5000 type: string type: array - enum: - '' type: string description: >- The tax rates which apply to the line item. When set, the `default_tax_rates` on the invoice do not apply to this line item. Pass an empty string to remove previously-defined tax rates. type: object required: false responses: '200': content: application/json: schema: $ref: '#/components/schemas/line_item' description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. '/v1/invoices/{invoice}/mark_uncollectible': post: description: >-

Marking an invoice as uncollectible is useful for keeping track of bad debts that can be written off for accounting purposes.

operationId: PostInvoicesInvoiceMarkUncollectible parameters: - in: path name: invoice required: true schema: maxLength: 5000 type: string style: simple requestBody: content: application/x-www-form-urlencoded: encoding: expand: explode: true style: deepObject schema: additionalProperties: false properties: expand: description: Specifies which fields in the response should be expanded. items: maxLength: 5000 type: string type: array type: object required: false responses: '200': content: application/json: schema: $ref: '#/components/schemas/invoice' description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. '/v1/invoices/{invoice}/pay': post: description: >-

Stripe automatically creates and then attempts to collect payment on invoices for customers on subscriptions according to your subscriptions settings. However, if you’d like to attempt payment on an invoice out of the normal collection schedule or for some other reason, you can do so.

operationId: PostInvoicesInvoicePay parameters: - in: path name: invoice required: true schema: maxLength: 5000 type: string style: simple requestBody: content: application/x-www-form-urlencoded: encoding: expand: explode: true style: deepObject mandate: explode: true style: deepObject schema: additionalProperties: false properties: expand: description: Specifies which fields in the response should be expanded. items: maxLength: 5000 type: string type: array forgive: description: >- In cases where the source used to pay the invoice has insufficient funds, passing `forgive=true` controls whether a charge should be attempted for the full amount available on the source, up to the amount to fully pay the invoice. This effectively forgives the difference between the amount available on the source and the amount due. Passing `forgive=false` will fail the charge if the source hasn't been pre-funded with the right amount. An example for this case is with ACH Credit Transfers and wires: if the amount wired is less than the amount due by a small amount, you might want to forgive the difference. Defaults to `false`. type: boolean mandate: anyOf: - maxLength: 5000 type: string - enum: - '' type: string description: >- ID of the mandate to be used for this invoice. It must correspond to the payment method used to pay the invoice, including the payment_method param or the invoice's default_payment_method or default_source, if set. off_session: description: >- Indicates if a customer is on or off-session while an invoice payment is attempted. Defaults to `true` (off-session). type: boolean paid_out_of_band: description: >- Boolean representing whether an invoice is paid outside of Stripe. This will result in no charge being made. Defaults to `false`. type: boolean payment_method: description: >- A PaymentMethod to be charged. The PaymentMethod must be the ID of a PaymentMethod belonging to the customer associated with the invoice being paid. maxLength: 5000 type: string source: description: >- A payment source to be charged. The source must be the ID of a source belonging to the customer associated with the invoice being paid. maxLength: 5000 type: string type: object required: false responses: '200': content: application/json: schema: $ref: '#/components/schemas/invoice' description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. '/v1/invoices/{invoice}/send': post: description: >-

Stripe will automatically send invoices to customers according to your subscriptions settings. However, if you’d like to manually send an invoice to your customer out of the normal schedule, you can do so. When sending invoices that have already been paid, there will be no reference to the payment in the email.

Requests made in test-mode result in no emails being sent, despite sending an invoice.sent event.

operationId: PostInvoicesInvoiceSend parameters: - in: path name: invoice required: true schema: maxLength: 5000 type: string style: simple requestBody: content: application/x-www-form-urlencoded: encoding: expand: explode: true style: deepObject schema: additionalProperties: false properties: expand: description: Specifies which fields in the response should be expanded. items: maxLength: 5000 type: string type: array type: object required: false responses: '200': content: application/json: schema: $ref: '#/components/schemas/invoice' description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. '/v1/invoices/{invoice}/void': post: description: >-

Mark a finalized invoice as void. This cannot be undone. Voiding an invoice is similar to deletion, however it only applies to finalized invoices and maintains a papertrail where the invoice can still be found.

Consult with local regulations to determine whether and how an invoice might be amended, canceled, or voided in the jurisdiction you’re doing business in. You might need to issue another invoice or credit note instead. Stripe recommends that you consult with your legal counsel for advice specific to your business.

operationId: PostInvoicesInvoiceVoid parameters: - in: path name: invoice required: true schema: maxLength: 5000 type: string style: simple requestBody: content: application/x-www-form-urlencoded: encoding: expand: explode: true style: deepObject schema: additionalProperties: false properties: expand: description: Specifies which fields in the response should be expanded. items: maxLength: 5000 type: string type: array type: object required: false responses: '200': content: application/json: schema: $ref: '#/components/schemas/invoice' description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. /v1/issuing/authorizations: get: description: >-

Returns a list of Issuing Authorization objects. The objects are sorted in descending order by creation date, with the most recently created object appearing first.

operationId: GetIssuingAuthorizations parameters: - description: Only return authorizations that belong to the given card. in: query name: card required: false schema: maxLength: 5000 type: string style: form - description: Only return authorizations that belong to the given cardholder. in: query name: cardholder required: false schema: maxLength: 5000 type: string style: form - description: >- Only return authorizations that were created during the given date interval. explode: true in: query name: created required: false schema: anyOf: - properties: gt: type: integer gte: type: integer lt: type: integer lte: type: integer title: range_query_specs type: object - type: integer style: deepObject - description: >- A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. in: query name: ending_before required: false schema: maxLength: 5000 type: string style: form - description: Specifies which fields in the response should be expanded. explode: true in: query name: expand required: false schema: items: maxLength: 5000 type: string type: array style: deepObject - description: >- A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. in: query name: limit required: false schema: type: integer style: form - description: >- A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. in: query name: starting_after required: false schema: maxLength: 5000 type: string style: form - description: >- Only return authorizations with the given status. One of `pending`, `closed`, or `reversed`. in: query name: status required: false schema: enum: - closed - pending - reversed type: string style: form requestBody: content: application/x-www-form-urlencoded: encoding: {} schema: additionalProperties: false properties: {} type: object required: false responses: '200': content: application/json: schema: description: '' properties: data: items: $ref: '#/components/schemas/issuing.authorization' type: array has_more: description: >- True if this list has another page of items after this one that can be fetched. type: boolean object: description: >- String representing the object's type. Objects of the same type share the same value. Always has the value `list`. enum: - list type: string url: description: The URL where this list can be accessed. maxLength: 5000 pattern: ^/v1/issuing/authorizations type: string required: - data - has_more - object - url title: IssuingAuthorizationList type: object x-expandableFields: - data description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. '/v1/issuing/authorizations/{authorization}': get: description:

Retrieves an Issuing Authorization object.

operationId: GetIssuingAuthorizationsAuthorization parameters: - in: path name: authorization required: true schema: maxLength: 5000 type: string style: simple - description: Specifies which fields in the response should be expanded. explode: true in: query name: expand required: false schema: items: maxLength: 5000 type: string type: array style: deepObject requestBody: content: application/x-www-form-urlencoded: encoding: {} schema: additionalProperties: false properties: {} type: object required: false responses: '200': content: application/json: schema: $ref: '#/components/schemas/issuing.authorization' description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. post: description: >-

Updates the specified Issuing Authorization object by setting the values of the parameters passed. Any parameters not provided will be left unchanged.

operationId: PostIssuingAuthorizationsAuthorization parameters: - in: path name: authorization required: true schema: maxLength: 5000 type: string style: simple requestBody: content: application/x-www-form-urlencoded: encoding: expand: explode: true style: deepObject metadata: explode: true style: deepObject schema: additionalProperties: false properties: expand: description: Specifies which fields in the response should be expanded. items: maxLength: 5000 type: string type: array metadata: anyOf: - additionalProperties: type: string type: object - enum: - '' type: string description: >- Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. type: object required: false responses: '200': content: application/json: schema: $ref: '#/components/schemas/issuing.authorization' description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. '/v1/issuing/authorizations/{authorization}/approve': post: deprecated: true description: >-

[Deprecated] Approves a pending Issuing Authorization object. This request should be made within the timeout window of the real-time authorization flow. This method is deprecated. Instead, respond directly to the webhook request to approve an authorization.

operationId: PostIssuingAuthorizationsAuthorizationApprove parameters: - in: path name: authorization required: true schema: maxLength: 5000 type: string style: simple requestBody: content: application/x-www-form-urlencoded: encoding: expand: explode: true style: deepObject metadata: explode: true style: deepObject schema: additionalProperties: false properties: amount: description: >- If the authorization's `pending_request.is_amount_controllable` property is `true`, you may provide this value to control how much to hold for the authorization. Must be positive (use [`decline`](https://stripe.com/docs/api/issuing/authorizations/decline) to decline an authorization request). type: integer expand: description: Specifies which fields in the response should be expanded. items: maxLength: 5000 type: string type: array metadata: anyOf: - additionalProperties: type: string type: object - enum: - '' type: string description: >- Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. type: object required: false responses: '200': content: application/json: schema: $ref: '#/components/schemas/issuing.authorization' description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. '/v1/issuing/authorizations/{authorization}/decline': post: deprecated: true description: >-

[Deprecated] Declines a pending Issuing Authorization object. This request should be made within the timeout window of the real time authorization flow. This method is deprecated. Instead, respond directly to the webhook request to decline an authorization.

operationId: PostIssuingAuthorizationsAuthorizationDecline parameters: - in: path name: authorization required: true schema: maxLength: 5000 type: string style: simple requestBody: content: application/x-www-form-urlencoded: encoding: expand: explode: true style: deepObject metadata: explode: true style: deepObject schema: additionalProperties: false properties: expand: description: Specifies which fields in the response should be expanded. items: maxLength: 5000 type: string type: array metadata: anyOf: - additionalProperties: type: string type: object - enum: - '' type: string description: >- Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. type: object required: false responses: '200': content: application/json: schema: $ref: '#/components/schemas/issuing.authorization' description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. /v1/issuing/cardholders: get: description: >-

Returns a list of Issuing Cardholder objects. The objects are sorted in descending order by creation date, with the most recently created object appearing first.

operationId: GetIssuingCardholders parameters: - description: >- Only return cardholders that were created during the given date interval. explode: true in: query name: created required: false schema: anyOf: - properties: gt: type: integer gte: type: integer lt: type: integer lte: type: integer title: range_query_specs type: object - type: integer style: deepObject - description: Only return cardholders that have the given email address. in: query name: email required: false schema: type: string style: form - description: >- A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. in: query name: ending_before required: false schema: maxLength: 5000 type: string style: form - description: Specifies which fields in the response should be expanded. explode: true in: query name: expand required: false schema: items: maxLength: 5000 type: string type: array style: deepObject - description: >- A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. in: query name: limit required: false schema: type: integer style: form - description: Only return cardholders that have the given phone number. in: query name: phone_number required: false schema: type: string style: form - description: >- A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. in: query name: starting_after required: false schema: maxLength: 5000 type: string style: form - description: >- Only return cardholders that have the given status. One of `active`, `inactive`, or `blocked`. in: query name: status required: false schema: enum: - active - blocked - inactive type: string style: form - description: >- Only return cardholders that have the given type. One of `individual` or `company`. in: query name: type required: false schema: enum: - company - individual type: string x-stripeBypassValidation: true style: form requestBody: content: application/x-www-form-urlencoded: encoding: {} schema: additionalProperties: false properties: {} type: object required: false responses: '200': content: application/json: schema: description: '' properties: data: items: $ref: '#/components/schemas/issuing.cardholder' type: array has_more: description: >- True if this list has another page of items after this one that can be fetched. type: boolean object: description: >- String representing the object's type. Objects of the same type share the same value. Always has the value `list`. enum: - list type: string url: description: The URL where this list can be accessed. maxLength: 5000 pattern: ^/v1/issuing/cardholders type: string required: - data - has_more - object - url title: IssuingCardholderList type: object x-expandableFields: - data description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. post: description: >-

Creates a new Issuing Cardholder object that can be issued cards.

operationId: PostIssuingCardholders requestBody: content: application/x-www-form-urlencoded: encoding: billing: explode: true style: deepObject company: explode: true style: deepObject expand: explode: true style: deepObject individual: explode: true style: deepObject metadata: explode: true style: deepObject preferred_locales: explode: true style: deepObject spending_controls: explode: true style: deepObject schema: additionalProperties: false properties: billing: description: The cardholder's billing address. properties: address: properties: city: maxLength: 5000 type: string country: maxLength: 5000 type: string line1: maxLength: 5000 type: string line2: maxLength: 5000 type: string postal_code: maxLength: 5000 type: string state: maxLength: 5000 type: string required: - city - country - line1 - postal_code title: required_address type: object required: - address title: billing_specs type: object company: description: Additional information about a `company` cardholder. properties: tax_id: maxLength: 5000 type: string title: company_param type: object email: description: The cardholder's email address. type: string expand: description: Specifies which fields in the response should be expanded. items: maxLength: 5000 type: string type: array individual: description: Additional information about an `individual` cardholder. properties: card_issuing: properties: user_terms_acceptance: properties: date: format: unix-time type: integer ip: type: string user_agent: anyOf: - maxLength: 5000 type: string - enum: - '' type: string title: terms_acceptance_param type: object title: card_issuing_param type: object dob: properties: day: type: integer month: type: integer year: type: integer required: - day - month - year title: date_of_birth_specs type: object first_name: type: string last_name: type: string verification: properties: document: properties: back: maxLength: 5000 type: string front: maxLength: 5000 type: string title: person_verification_document_param type: object title: person_verification_param type: object title: individual_param type: object metadata: additionalProperties: type: string description: >- Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. type: object name: description: >- The cardholder's name. This will be printed on cards issued to them. The maximum length of this field is 24 characters. This field cannot contain any special characters or numbers. type: string phone_number: description: >- The cardholder's phone number. This will be transformed to [E.164](https://en.wikipedia.org/wiki/E.164) if it is not provided in that format already. This is required for all cardholders who will be creating EU cards. See the [3D Secure documentation](https://stripe.com/docs/issuing/3d-secure#when-is-3d-secure-applied) for more details. type: string preferred_locales: description: >- The cardholder’s preferred locales (languages), ordered by preference. Locales can be `de`, `en`, `es`, `fr`, or `it`. This changes the language of the [3D Secure flow](https://stripe.com/docs/issuing/3d-secure) and one-time password messages sent to the cardholder. items: enum: - de - en - es - fr - it type: string type: array spending_controls: description: >- Rules that control spending across this cardholder's cards. Refer to our [documentation](https://stripe.com/docs/issuing/controls/spending-controls) for more details. properties: allowed_categories: items: enum: - ac_refrigeration_repair - accounting_bookkeeping_services - advertising_services - agricultural_cooperative - airlines_air_carriers - airports_flying_fields - ambulance_services - amusement_parks_carnivals - antique_reproductions - antique_shops - aquariums - architectural_surveying_services - art_dealers_and_galleries - artists_supply_and_craft_shops - auto_and_home_supply_stores - auto_body_repair_shops - auto_paint_shops - auto_service_shops - automated_cash_disburse - automated_fuel_dispensers - automobile_associations - automotive_parts_and_accessories_stores - automotive_tire_stores - bail_and_bond_payments - bakeries - bands_orchestras - barber_and_beauty_shops - betting_casino_gambling - bicycle_shops - billiard_pool_establishments - boat_dealers - boat_rentals_and_leases - book_stores - books_periodicals_and_newspapers - bowling_alleys - bus_lines - business_secretarial_schools - buying_shopping_services - cable_satellite_and_other_pay_television_and_radio - camera_and_photographic_supply_stores - candy_nut_and_confectionery_stores - car_and_truck_dealers_new_used - car_and_truck_dealers_used_only - car_rental_agencies - car_washes - carpentry_services - carpet_upholstery_cleaning - caterers - >- charitable_and_social_service_organizations_fundraising - chemicals_and_allied_products - child_care_services - childrens_and_infants_wear_stores - chiropodists_podiatrists - chiropractors - cigar_stores_and_stands - civic_social_fraternal_associations - cleaning_and_maintenance - clothing_rental - colleges_universities - commercial_equipment - commercial_footwear - commercial_photography_art_and_graphics - commuter_transport_and_ferries - computer_network_services - computer_programming - computer_repair - computer_software_stores - computers_peripherals_and_software - concrete_work_services - construction_materials - consulting_public_relations - correspondence_schools - cosmetic_stores - counseling_services - country_clubs - courier_services - court_costs - credit_reporting_agencies - cruise_lines - dairy_products_stores - dance_hall_studios_schools - dating_escort_services - dentists_orthodontists - department_stores - detective_agencies - digital_goods_applications - digital_goods_games - digital_goods_large_volume - digital_goods_media - direct_marketing_catalog_merchant - >- direct_marketing_combination_catalog_and_retail_merchant - direct_marketing_inbound_telemarketing - direct_marketing_insurance_services - direct_marketing_other - direct_marketing_outbound_telemarketing - direct_marketing_subscription - direct_marketing_travel - discount_stores - doctors - door_to_door_sales - drapery_window_covering_and_upholstery_stores - drinking_places - drug_stores_and_pharmacies - drugs_drug_proprietaries_and_druggist_sundries - dry_cleaners - durable_goods - duty_free_stores - eating_places_restaurants - educational_services - electric_razor_stores - electric_vehicle_charging - electrical_parts_and_equipment - electrical_services - electronics_repair_shops - electronics_stores - elementary_secondary_schools - emergency_services_gcas_visa_use_only - employment_temp_agencies - equipment_rental - exterminating_services - family_clothing_stores - fast_food_restaurants - financial_institutions - fines_government_administrative_entities - fireplace_fireplace_screens_and_accessories_stores - floor_covering_stores - florists - florists_supplies_nursery_stock_and_flowers - freezer_and_locker_meat_provisioners - fuel_dealers_non_automotive - funeral_services_crematories - >- furniture_home_furnishings_and_equipment_stores_except_appliances - furniture_repair_refinishing - furriers_and_fur_shops - general_services - gift_card_novelty_and_souvenir_shops - glass_paint_and_wallpaper_stores - glassware_crystal_stores - golf_courses_public - government_licensed_horse_dog_racing_us_region_only - >- government_licensed_online_casions_online_gambling_us_region_only - government_owned_lotteries_non_us_region - government_owned_lotteries_us_region_only - government_services - grocery_stores_supermarkets - hardware_equipment_and_supplies - hardware_stores - health_and_beauty_spas - hearing_aids_sales_and_supplies - heating_plumbing_a_c - hobby_toy_and_game_shops - home_supply_warehouse_stores - hospitals - hotels_motels_and_resorts - household_appliance_stores - industrial_supplies - information_retrieval_services - insurance_default - insurance_underwriting_premiums - intra_company_purchases - jewelry_stores_watches_clocks_and_silverware_stores - landscaping_services - laundries - laundry_cleaning_services - legal_services_attorneys - luggage_and_leather_goods_stores - lumber_building_materials_stores - manual_cash_disburse - marinas_service_and_supplies - marketplaces - masonry_stonework_and_plaster - massage_parlors - medical_and_dental_labs - >- medical_dental_ophthalmic_and_hospital_equipment_and_supplies - medical_services - membership_organizations - mens_and_boys_clothing_and_accessories_stores - mens_womens_clothing_stores - metal_service_centers - miscellaneous - miscellaneous_apparel_and_accessory_shops - miscellaneous_auto_dealers - miscellaneous_business_services - miscellaneous_food_stores - miscellaneous_general_merchandise - miscellaneous_general_services - miscellaneous_home_furnishing_specialty_stores - miscellaneous_publishing_and_printing - miscellaneous_recreation_services - miscellaneous_repair_shops - miscellaneous_specialty_retail - mobile_home_dealers - motion_picture_theaters - motor_freight_carriers_and_trucking - motor_homes_dealers - motor_vehicle_supplies_and_new_parts - motorcycle_shops_and_dealers - motorcycle_shops_dealers - >- music_stores_musical_instruments_pianos_and_sheet_music - news_dealers_and_newsstands - non_fi_money_orders - non_fi_stored_value_card_purchase_load - nondurable_goods - nurseries_lawn_and_garden_supply_stores - nursing_personal_care - office_and_commercial_furniture - opticians_eyeglasses - optometrists_ophthalmologist - orthopedic_goods_prosthetic_devices - osteopaths - package_stores_beer_wine_and_liquor - paints_varnishes_and_supplies - parking_lots_garages - passenger_railways - pawn_shops - pet_shops_pet_food_and_supplies - petroleum_and_petroleum_products - photo_developing - >- photographic_photocopy_microfilm_equipment_and_supplies - photographic_studios - picture_video_production - piece_goods_notions_and_other_dry_goods - plumbing_heating_equipment_and_supplies - political_organizations - postal_services_government_only - precious_stones_and_metals_watches_and_jewelry - professional_services - public_warehousing_and_storage - quick_copy_repro_and_blueprint - railroads - real_estate_agents_and_managers_rentals - record_stores - recreational_vehicle_rentals - religious_goods_stores - religious_organizations - roofing_siding_sheet_metal - secretarial_support_services - security_brokers_dealers - service_stations - sewing_needlework_fabric_and_piece_goods_stores - shoe_repair_hat_cleaning - shoe_stores - small_appliance_repair - snowmobile_dealers - special_trade_services - specialty_cleaning - sporting_goods_stores - sporting_recreation_camps - sports_and_riding_apparel_stores - sports_clubs_fields - stamp_and_coin_stores - >- stationary_office_supplies_printing_and_writing_paper - stationery_stores_office_and_school_supply_stores - swimming_pools_sales - t_ui_travel_germany - tailors_alterations - tax_payments_government_agencies - tax_preparation_services - taxicabs_limousines - telecommunication_equipment_and_telephone_sales - telecommunication_services - telegraph_services - tent_and_awning_shops - testing_laboratories - theatrical_ticket_agencies - timeshares - tire_retreading_and_repair - tolls_bridge_fees - tourist_attractions_and_exhibits - towing_services - trailer_parks_campgrounds - transportation_services - travel_agencies_tour_operators - truck_stop_iteration - truck_utility_trailer_rentals - typesetting_plate_making_and_related_services - typewriter_stores - u_s_federal_government_agencies_or_departments - uniforms_commercial_clothing - used_merchandise_and_secondhand_stores - utilities - variety_stores - veterinary_services - video_amusement_game_supplies - video_game_arcades - video_tape_rental_stores - vocational_trade_schools - watch_jewelry_repair - welding_repair - wholesale_clubs - wig_and_toupee_stores - wires_money_orders - womens_accessory_and_specialty_shops - womens_ready_to_wear_stores - wrecking_and_salvage_yards maxLength: 5000 type: string type: array allowed_merchant_countries: items: maxLength: 5000 type: string type: array blocked_categories: items: enum: - ac_refrigeration_repair - accounting_bookkeeping_services - advertising_services - agricultural_cooperative - airlines_air_carriers - airports_flying_fields - ambulance_services - amusement_parks_carnivals - antique_reproductions - antique_shops - aquariums - architectural_surveying_services - art_dealers_and_galleries - artists_supply_and_craft_shops - auto_and_home_supply_stores - auto_body_repair_shops - auto_paint_shops - auto_service_shops - automated_cash_disburse - automated_fuel_dispensers - automobile_associations - automotive_parts_and_accessories_stores - automotive_tire_stores - bail_and_bond_payments - bakeries - bands_orchestras - barber_and_beauty_shops - betting_casino_gambling - bicycle_shops - billiard_pool_establishments - boat_dealers - boat_rentals_and_leases - book_stores - books_periodicals_and_newspapers - bowling_alleys - bus_lines - business_secretarial_schools - buying_shopping_services - cable_satellite_and_other_pay_television_and_radio - camera_and_photographic_supply_stores - candy_nut_and_confectionery_stores - car_and_truck_dealers_new_used - car_and_truck_dealers_used_only - car_rental_agencies - car_washes - carpentry_services - carpet_upholstery_cleaning - caterers - >- charitable_and_social_service_organizations_fundraising - chemicals_and_allied_products - child_care_services - childrens_and_infants_wear_stores - chiropodists_podiatrists - chiropractors - cigar_stores_and_stands - civic_social_fraternal_associations - cleaning_and_maintenance - clothing_rental - colleges_universities - commercial_equipment - commercial_footwear - commercial_photography_art_and_graphics - commuter_transport_and_ferries - computer_network_services - computer_programming - computer_repair - computer_software_stores - computers_peripherals_and_software - concrete_work_services - construction_materials - consulting_public_relations - correspondence_schools - cosmetic_stores - counseling_services - country_clubs - courier_services - court_costs - credit_reporting_agencies - cruise_lines - dairy_products_stores - dance_hall_studios_schools - dating_escort_services - dentists_orthodontists - department_stores - detective_agencies - digital_goods_applications - digital_goods_games - digital_goods_large_volume - digital_goods_media - direct_marketing_catalog_merchant - >- direct_marketing_combination_catalog_and_retail_merchant - direct_marketing_inbound_telemarketing - direct_marketing_insurance_services - direct_marketing_other - direct_marketing_outbound_telemarketing - direct_marketing_subscription - direct_marketing_travel - discount_stores - doctors - door_to_door_sales - drapery_window_covering_and_upholstery_stores - drinking_places - drug_stores_and_pharmacies - drugs_drug_proprietaries_and_druggist_sundries - dry_cleaners - durable_goods - duty_free_stores - eating_places_restaurants - educational_services - electric_razor_stores - electric_vehicle_charging - electrical_parts_and_equipment - electrical_services - electronics_repair_shops - electronics_stores - elementary_secondary_schools - emergency_services_gcas_visa_use_only - employment_temp_agencies - equipment_rental - exterminating_services - family_clothing_stores - fast_food_restaurants - financial_institutions - fines_government_administrative_entities - fireplace_fireplace_screens_and_accessories_stores - floor_covering_stores - florists - florists_supplies_nursery_stock_and_flowers - freezer_and_locker_meat_provisioners - fuel_dealers_non_automotive - funeral_services_crematories - >- furniture_home_furnishings_and_equipment_stores_except_appliances - furniture_repair_refinishing - furriers_and_fur_shops - general_services - gift_card_novelty_and_souvenir_shops - glass_paint_and_wallpaper_stores - glassware_crystal_stores - golf_courses_public - government_licensed_horse_dog_racing_us_region_only - >- government_licensed_online_casions_online_gambling_us_region_only - government_owned_lotteries_non_us_region - government_owned_lotteries_us_region_only - government_services - grocery_stores_supermarkets - hardware_equipment_and_supplies - hardware_stores - health_and_beauty_spas - hearing_aids_sales_and_supplies - heating_plumbing_a_c - hobby_toy_and_game_shops - home_supply_warehouse_stores - hospitals - hotels_motels_and_resorts - household_appliance_stores - industrial_supplies - information_retrieval_services - insurance_default - insurance_underwriting_premiums - intra_company_purchases - jewelry_stores_watches_clocks_and_silverware_stores - landscaping_services - laundries - laundry_cleaning_services - legal_services_attorneys - luggage_and_leather_goods_stores - lumber_building_materials_stores - manual_cash_disburse - marinas_service_and_supplies - marketplaces - masonry_stonework_and_plaster - massage_parlors - medical_and_dental_labs - >- medical_dental_ophthalmic_and_hospital_equipment_and_supplies - medical_services - membership_organizations - mens_and_boys_clothing_and_accessories_stores - mens_womens_clothing_stores - metal_service_centers - miscellaneous - miscellaneous_apparel_and_accessory_shops - miscellaneous_auto_dealers - miscellaneous_business_services - miscellaneous_food_stores - miscellaneous_general_merchandise - miscellaneous_general_services - miscellaneous_home_furnishing_specialty_stores - miscellaneous_publishing_and_printing - miscellaneous_recreation_services - miscellaneous_repair_shops - miscellaneous_specialty_retail - mobile_home_dealers - motion_picture_theaters - motor_freight_carriers_and_trucking - motor_homes_dealers - motor_vehicle_supplies_and_new_parts - motorcycle_shops_and_dealers - motorcycle_shops_dealers - >- music_stores_musical_instruments_pianos_and_sheet_music - news_dealers_and_newsstands - non_fi_money_orders - non_fi_stored_value_card_purchase_load - nondurable_goods - nurseries_lawn_and_garden_supply_stores - nursing_personal_care - office_and_commercial_furniture - opticians_eyeglasses - optometrists_ophthalmologist - orthopedic_goods_prosthetic_devices - osteopaths - package_stores_beer_wine_and_liquor - paints_varnishes_and_supplies - parking_lots_garages - passenger_railways - pawn_shops - pet_shops_pet_food_and_supplies - petroleum_and_petroleum_products - photo_developing - >- photographic_photocopy_microfilm_equipment_and_supplies - photographic_studios - picture_video_production - piece_goods_notions_and_other_dry_goods - plumbing_heating_equipment_and_supplies - political_organizations - postal_services_government_only - precious_stones_and_metals_watches_and_jewelry - professional_services - public_warehousing_and_storage - quick_copy_repro_and_blueprint - railroads - real_estate_agents_and_managers_rentals - record_stores - recreational_vehicle_rentals - religious_goods_stores - religious_organizations - roofing_siding_sheet_metal - secretarial_support_services - security_brokers_dealers - service_stations - sewing_needlework_fabric_and_piece_goods_stores - shoe_repair_hat_cleaning - shoe_stores - small_appliance_repair - snowmobile_dealers - special_trade_services - specialty_cleaning - sporting_goods_stores - sporting_recreation_camps - sports_and_riding_apparel_stores - sports_clubs_fields - stamp_and_coin_stores - >- stationary_office_supplies_printing_and_writing_paper - stationery_stores_office_and_school_supply_stores - swimming_pools_sales - t_ui_travel_germany - tailors_alterations - tax_payments_government_agencies - tax_preparation_services - taxicabs_limousines - telecommunication_equipment_and_telephone_sales - telecommunication_services - telegraph_services - tent_and_awning_shops - testing_laboratories - theatrical_ticket_agencies - timeshares - tire_retreading_and_repair - tolls_bridge_fees - tourist_attractions_and_exhibits - towing_services - trailer_parks_campgrounds - transportation_services - travel_agencies_tour_operators - truck_stop_iteration - truck_utility_trailer_rentals - typesetting_plate_making_and_related_services - typewriter_stores - u_s_federal_government_agencies_or_departments - uniforms_commercial_clothing - used_merchandise_and_secondhand_stores - utilities - variety_stores - veterinary_services - video_amusement_game_supplies - video_game_arcades - video_tape_rental_stores - vocational_trade_schools - watch_jewelry_repair - welding_repair - wholesale_clubs - wig_and_toupee_stores - wires_money_orders - womens_accessory_and_specialty_shops - womens_ready_to_wear_stores - wrecking_and_salvage_yards maxLength: 5000 type: string type: array blocked_merchant_countries: items: maxLength: 5000 type: string type: array spending_limits: items: properties: amount: type: integer categories: items: enum: - ac_refrigeration_repair - accounting_bookkeeping_services - advertising_services - agricultural_cooperative - airlines_air_carriers - airports_flying_fields - ambulance_services - amusement_parks_carnivals - antique_reproductions - antique_shops - aquariums - architectural_surveying_services - art_dealers_and_galleries - artists_supply_and_craft_shops - auto_and_home_supply_stores - auto_body_repair_shops - auto_paint_shops - auto_service_shops - automated_cash_disburse - automated_fuel_dispensers - automobile_associations - automotive_parts_and_accessories_stores - automotive_tire_stores - bail_and_bond_payments - bakeries - bands_orchestras - barber_and_beauty_shops - betting_casino_gambling - bicycle_shops - billiard_pool_establishments - boat_dealers - boat_rentals_and_leases - book_stores - books_periodicals_and_newspapers - bowling_alleys - bus_lines - business_secretarial_schools - buying_shopping_services - >- cable_satellite_and_other_pay_television_and_radio - camera_and_photographic_supply_stores - candy_nut_and_confectionery_stores - car_and_truck_dealers_new_used - car_and_truck_dealers_used_only - car_rental_agencies - car_washes - carpentry_services - carpet_upholstery_cleaning - caterers - >- charitable_and_social_service_organizations_fundraising - chemicals_and_allied_products - child_care_services - childrens_and_infants_wear_stores - chiropodists_podiatrists - chiropractors - cigar_stores_and_stands - civic_social_fraternal_associations - cleaning_and_maintenance - clothing_rental - colleges_universities - commercial_equipment - commercial_footwear - commercial_photography_art_and_graphics - commuter_transport_and_ferries - computer_network_services - computer_programming - computer_repair - computer_software_stores - computers_peripherals_and_software - concrete_work_services - construction_materials - consulting_public_relations - correspondence_schools - cosmetic_stores - counseling_services - country_clubs - courier_services - court_costs - credit_reporting_agencies - cruise_lines - dairy_products_stores - dance_hall_studios_schools - dating_escort_services - dentists_orthodontists - department_stores - detective_agencies - digital_goods_applications - digital_goods_games - digital_goods_large_volume - digital_goods_media - direct_marketing_catalog_merchant - >- direct_marketing_combination_catalog_and_retail_merchant - direct_marketing_inbound_telemarketing - direct_marketing_insurance_services - direct_marketing_other - direct_marketing_outbound_telemarketing - direct_marketing_subscription - direct_marketing_travel - discount_stores - doctors - door_to_door_sales - drapery_window_covering_and_upholstery_stores - drinking_places - drug_stores_and_pharmacies - drugs_drug_proprietaries_and_druggist_sundries - dry_cleaners - durable_goods - duty_free_stores - eating_places_restaurants - educational_services - electric_razor_stores - electric_vehicle_charging - electrical_parts_and_equipment - electrical_services - electronics_repair_shops - electronics_stores - elementary_secondary_schools - emergency_services_gcas_visa_use_only - employment_temp_agencies - equipment_rental - exterminating_services - family_clothing_stores - fast_food_restaurants - financial_institutions - fines_government_administrative_entities - >- fireplace_fireplace_screens_and_accessories_stores - floor_covering_stores - florists - florists_supplies_nursery_stock_and_flowers - freezer_and_locker_meat_provisioners - fuel_dealers_non_automotive - funeral_services_crematories - >- furniture_home_furnishings_and_equipment_stores_except_appliances - furniture_repair_refinishing - furriers_and_fur_shops - general_services - gift_card_novelty_and_souvenir_shops - glass_paint_and_wallpaper_stores - glassware_crystal_stores - golf_courses_public - >- government_licensed_horse_dog_racing_us_region_only - >- government_licensed_online_casions_online_gambling_us_region_only - government_owned_lotteries_non_us_region - government_owned_lotteries_us_region_only - government_services - grocery_stores_supermarkets - hardware_equipment_and_supplies - hardware_stores - health_and_beauty_spas - hearing_aids_sales_and_supplies - heating_plumbing_a_c - hobby_toy_and_game_shops - home_supply_warehouse_stores - hospitals - hotels_motels_and_resorts - household_appliance_stores - industrial_supplies - information_retrieval_services - insurance_default - insurance_underwriting_premiums - intra_company_purchases - >- jewelry_stores_watches_clocks_and_silverware_stores - landscaping_services - laundries - laundry_cleaning_services - legal_services_attorneys - luggage_and_leather_goods_stores - lumber_building_materials_stores - manual_cash_disburse - marinas_service_and_supplies - marketplaces - masonry_stonework_and_plaster - massage_parlors - medical_and_dental_labs - >- medical_dental_ophthalmic_and_hospital_equipment_and_supplies - medical_services - membership_organizations - mens_and_boys_clothing_and_accessories_stores - mens_womens_clothing_stores - metal_service_centers - miscellaneous - miscellaneous_apparel_and_accessory_shops - miscellaneous_auto_dealers - miscellaneous_business_services - miscellaneous_food_stores - miscellaneous_general_merchandise - miscellaneous_general_services - miscellaneous_home_furnishing_specialty_stores - miscellaneous_publishing_and_printing - miscellaneous_recreation_services - miscellaneous_repair_shops - miscellaneous_specialty_retail - mobile_home_dealers - motion_picture_theaters - motor_freight_carriers_and_trucking - motor_homes_dealers - motor_vehicle_supplies_and_new_parts - motorcycle_shops_and_dealers - motorcycle_shops_dealers - >- music_stores_musical_instruments_pianos_and_sheet_music - news_dealers_and_newsstands - non_fi_money_orders - non_fi_stored_value_card_purchase_load - nondurable_goods - nurseries_lawn_and_garden_supply_stores - nursing_personal_care - office_and_commercial_furniture - opticians_eyeglasses - optometrists_ophthalmologist - orthopedic_goods_prosthetic_devices - osteopaths - package_stores_beer_wine_and_liquor - paints_varnishes_and_supplies - parking_lots_garages - passenger_railways - pawn_shops - pet_shops_pet_food_and_supplies - petroleum_and_petroleum_products - photo_developing - >- photographic_photocopy_microfilm_equipment_and_supplies - photographic_studios - picture_video_production - piece_goods_notions_and_other_dry_goods - plumbing_heating_equipment_and_supplies - political_organizations - postal_services_government_only - precious_stones_and_metals_watches_and_jewelry - professional_services - public_warehousing_and_storage - quick_copy_repro_and_blueprint - railroads - real_estate_agents_and_managers_rentals - record_stores - recreational_vehicle_rentals - religious_goods_stores - religious_organizations - roofing_siding_sheet_metal - secretarial_support_services - security_brokers_dealers - service_stations - >- sewing_needlework_fabric_and_piece_goods_stores - shoe_repair_hat_cleaning - shoe_stores - small_appliance_repair - snowmobile_dealers - special_trade_services - specialty_cleaning - sporting_goods_stores - sporting_recreation_camps - sports_and_riding_apparel_stores - sports_clubs_fields - stamp_and_coin_stores - >- stationary_office_supplies_printing_and_writing_paper - >- stationery_stores_office_and_school_supply_stores - swimming_pools_sales - t_ui_travel_germany - tailors_alterations - tax_payments_government_agencies - tax_preparation_services - taxicabs_limousines - >- telecommunication_equipment_and_telephone_sales - telecommunication_services - telegraph_services - tent_and_awning_shops - testing_laboratories - theatrical_ticket_agencies - timeshares - tire_retreading_and_repair - tolls_bridge_fees - tourist_attractions_and_exhibits - towing_services - trailer_parks_campgrounds - transportation_services - travel_agencies_tour_operators - truck_stop_iteration - truck_utility_trailer_rentals - typesetting_plate_making_and_related_services - typewriter_stores - u_s_federal_government_agencies_or_departments - uniforms_commercial_clothing - used_merchandise_and_secondhand_stores - utilities - variety_stores - veterinary_services - video_amusement_game_supplies - video_game_arcades - video_tape_rental_stores - vocational_trade_schools - watch_jewelry_repair - welding_repair - wholesale_clubs - wig_and_toupee_stores - wires_money_orders - womens_accessory_and_specialty_shops - womens_ready_to_wear_stores - wrecking_and_salvage_yards maxLength: 5000 type: string type: array interval: enum: - all_time - daily - monthly - per_authorization - weekly - yearly type: string required: - amount - interval title: spending_limits_param type: object type: array spending_limits_currency: type: string title: authorization_controls_param_v2 type: object status: description: >- Specifies whether to permit authorizations on this cardholder's cards. Defaults to `active`. enum: - active - inactive type: string type: description: >- One of `individual` or `company`. See [Choose a cardholder type](https://stripe.com/docs/issuing/other/choose-cardholder) for more details. enum: - company - individual type: string x-stripeBypassValidation: true required: - billing - name type: object required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/issuing.cardholder' description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. '/v1/issuing/cardholders/{cardholder}': get: description:

Retrieves an Issuing Cardholder object.

operationId: GetIssuingCardholdersCardholder parameters: - in: path name: cardholder required: true schema: maxLength: 5000 type: string style: simple - description: Specifies which fields in the response should be expanded. explode: true in: query name: expand required: false schema: items: maxLength: 5000 type: string type: array style: deepObject requestBody: content: application/x-www-form-urlencoded: encoding: {} schema: additionalProperties: false properties: {} type: object required: false responses: '200': content: application/json: schema: $ref: '#/components/schemas/issuing.cardholder' description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. post: description: >-

Updates the specified Issuing Cardholder object by setting the values of the parameters passed. Any parameters not provided will be left unchanged.

operationId: PostIssuingCardholdersCardholder parameters: - in: path name: cardholder required: true schema: maxLength: 5000 type: string style: simple requestBody: content: application/x-www-form-urlencoded: encoding: billing: explode: true style: deepObject company: explode: true style: deepObject expand: explode: true style: deepObject individual: explode: true style: deepObject metadata: explode: true style: deepObject preferred_locales: explode: true style: deepObject spending_controls: explode: true style: deepObject schema: additionalProperties: false properties: billing: description: The cardholder's billing address. properties: address: properties: city: maxLength: 5000 type: string country: maxLength: 5000 type: string line1: maxLength: 5000 type: string line2: maxLength: 5000 type: string postal_code: maxLength: 5000 type: string state: maxLength: 5000 type: string required: - city - country - line1 - postal_code title: required_address type: object required: - address title: billing_specs type: object company: description: Additional information about a `company` cardholder. properties: tax_id: maxLength: 5000 type: string title: company_param type: object email: description: The cardholder's email address. type: string expand: description: Specifies which fields in the response should be expanded. items: maxLength: 5000 type: string type: array individual: description: Additional information about an `individual` cardholder. properties: card_issuing: properties: user_terms_acceptance: properties: date: format: unix-time type: integer ip: type: string user_agent: anyOf: - maxLength: 5000 type: string - enum: - '' type: string title: terms_acceptance_param type: object title: card_issuing_param type: object dob: properties: day: type: integer month: type: integer year: type: integer required: - day - month - year title: date_of_birth_specs type: object first_name: type: string last_name: type: string verification: properties: document: properties: back: maxLength: 5000 type: string front: maxLength: 5000 type: string title: person_verification_document_param type: object title: person_verification_param type: object title: individual_param type: object metadata: additionalProperties: type: string description: >- Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. type: object phone_number: description: >- The cardholder's phone number. This is required for all cardholders who will be creating EU cards. See the [3D Secure documentation](https://stripe.com/docs/issuing/3d-secure) for more details. type: string preferred_locales: description: >- The cardholder’s preferred locales (languages), ordered by preference. Locales can be `de`, `en`, `es`, `fr`, or `it`. This changes the language of the [3D Secure flow](https://stripe.com/docs/issuing/3d-secure) and one-time password messages sent to the cardholder. items: enum: - de - en - es - fr - it type: string type: array spending_controls: description: >- Rules that control spending across this cardholder's cards. Refer to our [documentation](https://stripe.com/docs/issuing/controls/spending-controls) for more details. properties: allowed_categories: items: enum: - ac_refrigeration_repair - accounting_bookkeeping_services - advertising_services - agricultural_cooperative - airlines_air_carriers - airports_flying_fields - ambulance_services - amusement_parks_carnivals - antique_reproductions - antique_shops - aquariums - architectural_surveying_services - art_dealers_and_galleries - artists_supply_and_craft_shops - auto_and_home_supply_stores - auto_body_repair_shops - auto_paint_shops - auto_service_shops - automated_cash_disburse - automated_fuel_dispensers - automobile_associations - automotive_parts_and_accessories_stores - automotive_tire_stores - bail_and_bond_payments - bakeries - bands_orchestras - barber_and_beauty_shops - betting_casino_gambling - bicycle_shops - billiard_pool_establishments - boat_dealers - boat_rentals_and_leases - book_stores - books_periodicals_and_newspapers - bowling_alleys - bus_lines - business_secretarial_schools - buying_shopping_services - cable_satellite_and_other_pay_television_and_radio - camera_and_photographic_supply_stores - candy_nut_and_confectionery_stores - car_and_truck_dealers_new_used - car_and_truck_dealers_used_only - car_rental_agencies - car_washes - carpentry_services - carpet_upholstery_cleaning - caterers - >- charitable_and_social_service_organizations_fundraising - chemicals_and_allied_products - child_care_services - childrens_and_infants_wear_stores - chiropodists_podiatrists - chiropractors - cigar_stores_and_stands - civic_social_fraternal_associations - cleaning_and_maintenance - clothing_rental - colleges_universities - commercial_equipment - commercial_footwear - commercial_photography_art_and_graphics - commuter_transport_and_ferries - computer_network_services - computer_programming - computer_repair - computer_software_stores - computers_peripherals_and_software - concrete_work_services - construction_materials - consulting_public_relations - correspondence_schools - cosmetic_stores - counseling_services - country_clubs - courier_services - court_costs - credit_reporting_agencies - cruise_lines - dairy_products_stores - dance_hall_studios_schools - dating_escort_services - dentists_orthodontists - department_stores - detective_agencies - digital_goods_applications - digital_goods_games - digital_goods_large_volume - digital_goods_media - direct_marketing_catalog_merchant - >- direct_marketing_combination_catalog_and_retail_merchant - direct_marketing_inbound_telemarketing - direct_marketing_insurance_services - direct_marketing_other - direct_marketing_outbound_telemarketing - direct_marketing_subscription - direct_marketing_travel - discount_stores - doctors - door_to_door_sales - drapery_window_covering_and_upholstery_stores - drinking_places - drug_stores_and_pharmacies - drugs_drug_proprietaries_and_druggist_sundries - dry_cleaners - durable_goods - duty_free_stores - eating_places_restaurants - educational_services - electric_razor_stores - electric_vehicle_charging - electrical_parts_and_equipment - electrical_services - electronics_repair_shops - electronics_stores - elementary_secondary_schools - emergency_services_gcas_visa_use_only - employment_temp_agencies - equipment_rental - exterminating_services - family_clothing_stores - fast_food_restaurants - financial_institutions - fines_government_administrative_entities - fireplace_fireplace_screens_and_accessories_stores - floor_covering_stores - florists - florists_supplies_nursery_stock_and_flowers - freezer_and_locker_meat_provisioners - fuel_dealers_non_automotive - funeral_services_crematories - >- furniture_home_furnishings_and_equipment_stores_except_appliances - furniture_repair_refinishing - furriers_and_fur_shops - general_services - gift_card_novelty_and_souvenir_shops - glass_paint_and_wallpaper_stores - glassware_crystal_stores - golf_courses_public - government_licensed_horse_dog_racing_us_region_only - >- government_licensed_online_casions_online_gambling_us_region_only - government_owned_lotteries_non_us_region - government_owned_lotteries_us_region_only - government_services - grocery_stores_supermarkets - hardware_equipment_and_supplies - hardware_stores - health_and_beauty_spas - hearing_aids_sales_and_supplies - heating_plumbing_a_c - hobby_toy_and_game_shops - home_supply_warehouse_stores - hospitals - hotels_motels_and_resorts - household_appliance_stores - industrial_supplies - information_retrieval_services - insurance_default - insurance_underwriting_premiums - intra_company_purchases - jewelry_stores_watches_clocks_and_silverware_stores - landscaping_services - laundries - laundry_cleaning_services - legal_services_attorneys - luggage_and_leather_goods_stores - lumber_building_materials_stores - manual_cash_disburse - marinas_service_and_supplies - marketplaces - masonry_stonework_and_plaster - massage_parlors - medical_and_dental_labs - >- medical_dental_ophthalmic_and_hospital_equipment_and_supplies - medical_services - membership_organizations - mens_and_boys_clothing_and_accessories_stores - mens_womens_clothing_stores - metal_service_centers - miscellaneous - miscellaneous_apparel_and_accessory_shops - miscellaneous_auto_dealers - miscellaneous_business_services - miscellaneous_food_stores - miscellaneous_general_merchandise - miscellaneous_general_services - miscellaneous_home_furnishing_specialty_stores - miscellaneous_publishing_and_printing - miscellaneous_recreation_services - miscellaneous_repair_shops - miscellaneous_specialty_retail - mobile_home_dealers - motion_picture_theaters - motor_freight_carriers_and_trucking - motor_homes_dealers - motor_vehicle_supplies_and_new_parts - motorcycle_shops_and_dealers - motorcycle_shops_dealers - >- music_stores_musical_instruments_pianos_and_sheet_music - news_dealers_and_newsstands - non_fi_money_orders - non_fi_stored_value_card_purchase_load - nondurable_goods - nurseries_lawn_and_garden_supply_stores - nursing_personal_care - office_and_commercial_furniture - opticians_eyeglasses - optometrists_ophthalmologist - orthopedic_goods_prosthetic_devices - osteopaths - package_stores_beer_wine_and_liquor - paints_varnishes_and_supplies - parking_lots_garages - passenger_railways - pawn_shops - pet_shops_pet_food_and_supplies - petroleum_and_petroleum_products - photo_developing - >- photographic_photocopy_microfilm_equipment_and_supplies - photographic_studios - picture_video_production - piece_goods_notions_and_other_dry_goods - plumbing_heating_equipment_and_supplies - political_organizations - postal_services_government_only - precious_stones_and_metals_watches_and_jewelry - professional_services - public_warehousing_and_storage - quick_copy_repro_and_blueprint - railroads - real_estate_agents_and_managers_rentals - record_stores - recreational_vehicle_rentals - religious_goods_stores - religious_organizations - roofing_siding_sheet_metal - secretarial_support_services - security_brokers_dealers - service_stations - sewing_needlework_fabric_and_piece_goods_stores - shoe_repair_hat_cleaning - shoe_stores - small_appliance_repair - snowmobile_dealers - special_trade_services - specialty_cleaning - sporting_goods_stores - sporting_recreation_camps - sports_and_riding_apparel_stores - sports_clubs_fields - stamp_and_coin_stores - >- stationary_office_supplies_printing_and_writing_paper - stationery_stores_office_and_school_supply_stores - swimming_pools_sales - t_ui_travel_germany - tailors_alterations - tax_payments_government_agencies - tax_preparation_services - taxicabs_limousines - telecommunication_equipment_and_telephone_sales - telecommunication_services - telegraph_services - tent_and_awning_shops - testing_laboratories - theatrical_ticket_agencies - timeshares - tire_retreading_and_repair - tolls_bridge_fees - tourist_attractions_and_exhibits - towing_services - trailer_parks_campgrounds - transportation_services - travel_agencies_tour_operators - truck_stop_iteration - truck_utility_trailer_rentals - typesetting_plate_making_and_related_services - typewriter_stores - u_s_federal_government_agencies_or_departments - uniforms_commercial_clothing - used_merchandise_and_secondhand_stores - utilities - variety_stores - veterinary_services - video_amusement_game_supplies - video_game_arcades - video_tape_rental_stores - vocational_trade_schools - watch_jewelry_repair - welding_repair - wholesale_clubs - wig_and_toupee_stores - wires_money_orders - womens_accessory_and_specialty_shops - womens_ready_to_wear_stores - wrecking_and_salvage_yards maxLength: 5000 type: string type: array allowed_merchant_countries: items: maxLength: 5000 type: string type: array blocked_categories: items: enum: - ac_refrigeration_repair - accounting_bookkeeping_services - advertising_services - agricultural_cooperative - airlines_air_carriers - airports_flying_fields - ambulance_services - amusement_parks_carnivals - antique_reproductions - antique_shops - aquariums - architectural_surveying_services - art_dealers_and_galleries - artists_supply_and_craft_shops - auto_and_home_supply_stores - auto_body_repair_shops - auto_paint_shops - auto_service_shops - automated_cash_disburse - automated_fuel_dispensers - automobile_associations - automotive_parts_and_accessories_stores - automotive_tire_stores - bail_and_bond_payments - bakeries - bands_orchestras - barber_and_beauty_shops - betting_casino_gambling - bicycle_shops - billiard_pool_establishments - boat_dealers - boat_rentals_and_leases - book_stores - books_periodicals_and_newspapers - bowling_alleys - bus_lines - business_secretarial_schools - buying_shopping_services - cable_satellite_and_other_pay_television_and_radio - camera_and_photographic_supply_stores - candy_nut_and_confectionery_stores - car_and_truck_dealers_new_used - car_and_truck_dealers_used_only - car_rental_agencies - car_washes - carpentry_services - carpet_upholstery_cleaning - caterers - >- charitable_and_social_service_organizations_fundraising - chemicals_and_allied_products - child_care_services - childrens_and_infants_wear_stores - chiropodists_podiatrists - chiropractors - cigar_stores_and_stands - civic_social_fraternal_associations - cleaning_and_maintenance - clothing_rental - colleges_universities - commercial_equipment - commercial_footwear - commercial_photography_art_and_graphics - commuter_transport_and_ferries - computer_network_services - computer_programming - computer_repair - computer_software_stores - computers_peripherals_and_software - concrete_work_services - construction_materials - consulting_public_relations - correspondence_schools - cosmetic_stores - counseling_services - country_clubs - courier_services - court_costs - credit_reporting_agencies - cruise_lines - dairy_products_stores - dance_hall_studios_schools - dating_escort_services - dentists_orthodontists - department_stores - detective_agencies - digital_goods_applications - digital_goods_games - digital_goods_large_volume - digital_goods_media - direct_marketing_catalog_merchant - >- direct_marketing_combination_catalog_and_retail_merchant - direct_marketing_inbound_telemarketing - direct_marketing_insurance_services - direct_marketing_other - direct_marketing_outbound_telemarketing - direct_marketing_subscription - direct_marketing_travel - discount_stores - doctors - door_to_door_sales - drapery_window_covering_and_upholstery_stores - drinking_places - drug_stores_and_pharmacies - drugs_drug_proprietaries_and_druggist_sundries - dry_cleaners - durable_goods - duty_free_stores - eating_places_restaurants - educational_services - electric_razor_stores - electric_vehicle_charging - electrical_parts_and_equipment - electrical_services - electronics_repair_shops - electronics_stores - elementary_secondary_schools - emergency_services_gcas_visa_use_only - employment_temp_agencies - equipment_rental - exterminating_services - family_clothing_stores - fast_food_restaurants - financial_institutions - fines_government_administrative_entities - fireplace_fireplace_screens_and_accessories_stores - floor_covering_stores - florists - florists_supplies_nursery_stock_and_flowers - freezer_and_locker_meat_provisioners - fuel_dealers_non_automotive - funeral_services_crematories - >- furniture_home_furnishings_and_equipment_stores_except_appliances - furniture_repair_refinishing - furriers_and_fur_shops - general_services - gift_card_novelty_and_souvenir_shops - glass_paint_and_wallpaper_stores - glassware_crystal_stores - golf_courses_public - government_licensed_horse_dog_racing_us_region_only - >- government_licensed_online_casions_online_gambling_us_region_only - government_owned_lotteries_non_us_region - government_owned_lotteries_us_region_only - government_services - grocery_stores_supermarkets - hardware_equipment_and_supplies - hardware_stores - health_and_beauty_spas - hearing_aids_sales_and_supplies - heating_plumbing_a_c - hobby_toy_and_game_shops - home_supply_warehouse_stores - hospitals - hotels_motels_and_resorts - household_appliance_stores - industrial_supplies - information_retrieval_services - insurance_default - insurance_underwriting_premiums - intra_company_purchases - jewelry_stores_watches_clocks_and_silverware_stores - landscaping_services - laundries - laundry_cleaning_services - legal_services_attorneys - luggage_and_leather_goods_stores - lumber_building_materials_stores - manual_cash_disburse - marinas_service_and_supplies - marketplaces - masonry_stonework_and_plaster - massage_parlors - medical_and_dental_labs - >- medical_dental_ophthalmic_and_hospital_equipment_and_supplies - medical_services - membership_organizations - mens_and_boys_clothing_and_accessories_stores - mens_womens_clothing_stores - metal_service_centers - miscellaneous - miscellaneous_apparel_and_accessory_shops - miscellaneous_auto_dealers - miscellaneous_business_services - miscellaneous_food_stores - miscellaneous_general_merchandise - miscellaneous_general_services - miscellaneous_home_furnishing_specialty_stores - miscellaneous_publishing_and_printing - miscellaneous_recreation_services - miscellaneous_repair_shops - miscellaneous_specialty_retail - mobile_home_dealers - motion_picture_theaters - motor_freight_carriers_and_trucking - motor_homes_dealers - motor_vehicle_supplies_and_new_parts - motorcycle_shops_and_dealers - motorcycle_shops_dealers - >- music_stores_musical_instruments_pianos_and_sheet_music - news_dealers_and_newsstands - non_fi_money_orders - non_fi_stored_value_card_purchase_load - nondurable_goods - nurseries_lawn_and_garden_supply_stores - nursing_personal_care - office_and_commercial_furniture - opticians_eyeglasses - optometrists_ophthalmologist - orthopedic_goods_prosthetic_devices - osteopaths - package_stores_beer_wine_and_liquor - paints_varnishes_and_supplies - parking_lots_garages - passenger_railways - pawn_shops - pet_shops_pet_food_and_supplies - petroleum_and_petroleum_products - photo_developing - >- photographic_photocopy_microfilm_equipment_and_supplies - photographic_studios - picture_video_production - piece_goods_notions_and_other_dry_goods - plumbing_heating_equipment_and_supplies - political_organizations - postal_services_government_only - precious_stones_and_metals_watches_and_jewelry - professional_services - public_warehousing_and_storage - quick_copy_repro_and_blueprint - railroads - real_estate_agents_and_managers_rentals - record_stores - recreational_vehicle_rentals - religious_goods_stores - religious_organizations - roofing_siding_sheet_metal - secretarial_support_services - security_brokers_dealers - service_stations - sewing_needlework_fabric_and_piece_goods_stores - shoe_repair_hat_cleaning - shoe_stores - small_appliance_repair - snowmobile_dealers - special_trade_services - specialty_cleaning - sporting_goods_stores - sporting_recreation_camps - sports_and_riding_apparel_stores - sports_clubs_fields - stamp_and_coin_stores - >- stationary_office_supplies_printing_and_writing_paper - stationery_stores_office_and_school_supply_stores - swimming_pools_sales - t_ui_travel_germany - tailors_alterations - tax_payments_government_agencies - tax_preparation_services - taxicabs_limousines - telecommunication_equipment_and_telephone_sales - telecommunication_services - telegraph_services - tent_and_awning_shops - testing_laboratories - theatrical_ticket_agencies - timeshares - tire_retreading_and_repair - tolls_bridge_fees - tourist_attractions_and_exhibits - towing_services - trailer_parks_campgrounds - transportation_services - travel_agencies_tour_operators - truck_stop_iteration - truck_utility_trailer_rentals - typesetting_plate_making_and_related_services - typewriter_stores - u_s_federal_government_agencies_or_departments - uniforms_commercial_clothing - used_merchandise_and_secondhand_stores - utilities - variety_stores - veterinary_services - video_amusement_game_supplies - video_game_arcades - video_tape_rental_stores - vocational_trade_schools - watch_jewelry_repair - welding_repair - wholesale_clubs - wig_and_toupee_stores - wires_money_orders - womens_accessory_and_specialty_shops - womens_ready_to_wear_stores - wrecking_and_salvage_yards maxLength: 5000 type: string type: array blocked_merchant_countries: items: maxLength: 5000 type: string type: array spending_limits: items: properties: amount: type: integer categories: items: enum: - ac_refrigeration_repair - accounting_bookkeeping_services - advertising_services - agricultural_cooperative - airlines_air_carriers - airports_flying_fields - ambulance_services - amusement_parks_carnivals - antique_reproductions - antique_shops - aquariums - architectural_surveying_services - art_dealers_and_galleries - artists_supply_and_craft_shops - auto_and_home_supply_stores - auto_body_repair_shops - auto_paint_shops - auto_service_shops - automated_cash_disburse - automated_fuel_dispensers - automobile_associations - automotive_parts_and_accessories_stores - automotive_tire_stores - bail_and_bond_payments - bakeries - bands_orchestras - barber_and_beauty_shops - betting_casino_gambling - bicycle_shops - billiard_pool_establishments - boat_dealers - boat_rentals_and_leases - book_stores - books_periodicals_and_newspapers - bowling_alleys - bus_lines - business_secretarial_schools - buying_shopping_services - >- cable_satellite_and_other_pay_television_and_radio - camera_and_photographic_supply_stores - candy_nut_and_confectionery_stores - car_and_truck_dealers_new_used - car_and_truck_dealers_used_only - car_rental_agencies - car_washes - carpentry_services - carpet_upholstery_cleaning - caterers - >- charitable_and_social_service_organizations_fundraising - chemicals_and_allied_products - child_care_services - childrens_and_infants_wear_stores - chiropodists_podiatrists - chiropractors - cigar_stores_and_stands - civic_social_fraternal_associations - cleaning_and_maintenance - clothing_rental - colleges_universities - commercial_equipment - commercial_footwear - commercial_photography_art_and_graphics - commuter_transport_and_ferries - computer_network_services - computer_programming - computer_repair - computer_software_stores - computers_peripherals_and_software - concrete_work_services - construction_materials - consulting_public_relations - correspondence_schools - cosmetic_stores - counseling_services - country_clubs - courier_services - court_costs - credit_reporting_agencies - cruise_lines - dairy_products_stores - dance_hall_studios_schools - dating_escort_services - dentists_orthodontists - department_stores - detective_agencies - digital_goods_applications - digital_goods_games - digital_goods_large_volume - digital_goods_media - direct_marketing_catalog_merchant - >- direct_marketing_combination_catalog_and_retail_merchant - direct_marketing_inbound_telemarketing - direct_marketing_insurance_services - direct_marketing_other - direct_marketing_outbound_telemarketing - direct_marketing_subscription - direct_marketing_travel - discount_stores - doctors - door_to_door_sales - drapery_window_covering_and_upholstery_stores - drinking_places - drug_stores_and_pharmacies - drugs_drug_proprietaries_and_druggist_sundries - dry_cleaners - durable_goods - duty_free_stores - eating_places_restaurants - educational_services - electric_razor_stores - electric_vehicle_charging - electrical_parts_and_equipment - electrical_services - electronics_repair_shops - electronics_stores - elementary_secondary_schools - emergency_services_gcas_visa_use_only - employment_temp_agencies - equipment_rental - exterminating_services - family_clothing_stores - fast_food_restaurants - financial_institutions - fines_government_administrative_entities - >- fireplace_fireplace_screens_and_accessories_stores - floor_covering_stores - florists - florists_supplies_nursery_stock_and_flowers - freezer_and_locker_meat_provisioners - fuel_dealers_non_automotive - funeral_services_crematories - >- furniture_home_furnishings_and_equipment_stores_except_appliances - furniture_repair_refinishing - furriers_and_fur_shops - general_services - gift_card_novelty_and_souvenir_shops - glass_paint_and_wallpaper_stores - glassware_crystal_stores - golf_courses_public - >- government_licensed_horse_dog_racing_us_region_only - >- government_licensed_online_casions_online_gambling_us_region_only - government_owned_lotteries_non_us_region - government_owned_lotteries_us_region_only - government_services - grocery_stores_supermarkets - hardware_equipment_and_supplies - hardware_stores - health_and_beauty_spas - hearing_aids_sales_and_supplies - heating_plumbing_a_c - hobby_toy_and_game_shops - home_supply_warehouse_stores - hospitals - hotels_motels_and_resorts - household_appliance_stores - industrial_supplies - information_retrieval_services - insurance_default - insurance_underwriting_premiums - intra_company_purchases - >- jewelry_stores_watches_clocks_and_silverware_stores - landscaping_services - laundries - laundry_cleaning_services - legal_services_attorneys - luggage_and_leather_goods_stores - lumber_building_materials_stores - manual_cash_disburse - marinas_service_and_supplies - marketplaces - masonry_stonework_and_plaster - massage_parlors - medical_and_dental_labs - >- medical_dental_ophthalmic_and_hospital_equipment_and_supplies - medical_services - membership_organizations - mens_and_boys_clothing_and_accessories_stores - mens_womens_clothing_stores - metal_service_centers - miscellaneous - miscellaneous_apparel_and_accessory_shops - miscellaneous_auto_dealers - miscellaneous_business_services - miscellaneous_food_stores - miscellaneous_general_merchandise - miscellaneous_general_services - miscellaneous_home_furnishing_specialty_stores - miscellaneous_publishing_and_printing - miscellaneous_recreation_services - miscellaneous_repair_shops - miscellaneous_specialty_retail - mobile_home_dealers - motion_picture_theaters - motor_freight_carriers_and_trucking - motor_homes_dealers - motor_vehicle_supplies_and_new_parts - motorcycle_shops_and_dealers - motorcycle_shops_dealers - >- music_stores_musical_instruments_pianos_and_sheet_music - news_dealers_and_newsstands - non_fi_money_orders - non_fi_stored_value_card_purchase_load - nondurable_goods - nurseries_lawn_and_garden_supply_stores - nursing_personal_care - office_and_commercial_furniture - opticians_eyeglasses - optometrists_ophthalmologist - orthopedic_goods_prosthetic_devices - osteopaths - package_stores_beer_wine_and_liquor - paints_varnishes_and_supplies - parking_lots_garages - passenger_railways - pawn_shops - pet_shops_pet_food_and_supplies - petroleum_and_petroleum_products - photo_developing - >- photographic_photocopy_microfilm_equipment_and_supplies - photographic_studios - picture_video_production - piece_goods_notions_and_other_dry_goods - plumbing_heating_equipment_and_supplies - political_organizations - postal_services_government_only - precious_stones_and_metals_watches_and_jewelry - professional_services - public_warehousing_and_storage - quick_copy_repro_and_blueprint - railroads - real_estate_agents_and_managers_rentals - record_stores - recreational_vehicle_rentals - religious_goods_stores - religious_organizations - roofing_siding_sheet_metal - secretarial_support_services - security_brokers_dealers - service_stations - >- sewing_needlework_fabric_and_piece_goods_stores - shoe_repair_hat_cleaning - shoe_stores - small_appliance_repair - snowmobile_dealers - special_trade_services - specialty_cleaning - sporting_goods_stores - sporting_recreation_camps - sports_and_riding_apparel_stores - sports_clubs_fields - stamp_and_coin_stores - >- stationary_office_supplies_printing_and_writing_paper - >- stationery_stores_office_and_school_supply_stores - swimming_pools_sales - t_ui_travel_germany - tailors_alterations - tax_payments_government_agencies - tax_preparation_services - taxicabs_limousines - >- telecommunication_equipment_and_telephone_sales - telecommunication_services - telegraph_services - tent_and_awning_shops - testing_laboratories - theatrical_ticket_agencies - timeshares - tire_retreading_and_repair - tolls_bridge_fees - tourist_attractions_and_exhibits - towing_services - trailer_parks_campgrounds - transportation_services - travel_agencies_tour_operators - truck_stop_iteration - truck_utility_trailer_rentals - typesetting_plate_making_and_related_services - typewriter_stores - u_s_federal_government_agencies_or_departments - uniforms_commercial_clothing - used_merchandise_and_secondhand_stores - utilities - variety_stores - veterinary_services - video_amusement_game_supplies - video_game_arcades - video_tape_rental_stores - vocational_trade_schools - watch_jewelry_repair - welding_repair - wholesale_clubs - wig_and_toupee_stores - wires_money_orders - womens_accessory_and_specialty_shops - womens_ready_to_wear_stores - wrecking_and_salvage_yards maxLength: 5000 type: string type: array interval: enum: - all_time - daily - monthly - per_authorization - weekly - yearly type: string required: - amount - interval title: spending_limits_param type: object type: array spending_limits_currency: type: string title: authorization_controls_param_v2 type: object status: description: >- Specifies whether to permit authorizations on this cardholder's cards. enum: - active - inactive type: string type: object required: false responses: '200': content: application/json: schema: $ref: '#/components/schemas/issuing.cardholder' description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. /v1/issuing/cards: get: description: >-

Returns a list of Issuing Card objects. The objects are sorted in descending order by creation date, with the most recently created object appearing first.

operationId: GetIssuingCards parameters: - description: Only return cards belonging to the Cardholder with the provided ID. in: query name: cardholder required: false schema: maxLength: 5000 type: string style: form - description: Only return cards that were issued during the given date interval. explode: true in: query name: created required: false schema: anyOf: - properties: gt: type: integer gte: type: integer lt: type: integer lte: type: integer title: range_query_specs type: object - type: integer style: deepObject - description: >- A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. in: query name: ending_before required: false schema: maxLength: 5000 type: string style: form - description: Only return cards that have the given expiration month. in: query name: exp_month required: false schema: type: integer style: form - description: Only return cards that have the given expiration year. in: query name: exp_year required: false schema: type: integer style: form - description: Specifies which fields in the response should be expanded. explode: true in: query name: expand required: false schema: items: maxLength: 5000 type: string type: array style: deepObject - description: Only return cards that have the given last four digits. in: query name: last4 required: false schema: maxLength: 5000 type: string style: form - description: >- A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. in: query name: limit required: false schema: type: integer style: form - in: query name: personalization_design required: false schema: maxLength: 5000 type: string style: form - description: >- A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. in: query name: starting_after required: false schema: maxLength: 5000 type: string style: form - description: >- Only return cards that have the given status. One of `active`, `inactive`, or `canceled`. in: query name: status required: false schema: enum: - active - canceled - inactive type: string x-stripeBypassValidation: true style: form - description: >- Only return cards that have the given type. One of `virtual` or `physical`. in: query name: type required: false schema: enum: - physical - virtual type: string style: form requestBody: content: application/x-www-form-urlencoded: encoding: {} schema: additionalProperties: false properties: {} type: object required: false responses: '200': content: application/json: schema: description: '' properties: data: items: $ref: '#/components/schemas/issuing.card' type: array has_more: description: >- True if this list has another page of items after this one that can be fetched. type: boolean object: description: >- String representing the object's type. Objects of the same type share the same value. Always has the value `list`. enum: - list type: string url: description: The URL where this list can be accessed. maxLength: 5000 pattern: ^/v1/issuing/cards type: string required: - data - has_more - object - url title: IssuingCardList type: object x-expandableFields: - data description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. post: description:

Creates an Issuing Card object.

operationId: PostIssuingCards requestBody: content: application/x-www-form-urlencoded: encoding: expand: explode: true style: deepObject metadata: explode: true style: deepObject pin: explode: true style: deepObject second_line: explode: true style: deepObject shipping: explode: true style: deepObject spending_controls: explode: true style: deepObject schema: additionalProperties: false properties: cardholder: description: >- The [Cardholder](https://stripe.com/docs/api#issuing_cardholder_object) object with which the card will be associated. maxLength: 5000 type: string currency: description: The currency for the card. type: string expand: description: Specifies which fields in the response should be expanded. items: maxLength: 5000 type: string type: array financial_account: type: string metadata: additionalProperties: type: string description: >- Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. type: object personalization_design: description: The personalization design object belonging to this card. maxLength: 5000 type: string pin: description: The desired PIN for this card. properties: encrypted_number: maxLength: 5000 type: string title: encrypted_pin_param type: object replacement_for: description: The card this is meant to be a replacement for (if any). maxLength: 5000 type: string replacement_reason: description: >- If `replacement_for` is specified, this should indicate why that card is being replaced. enum: - damaged - expired - lost - stolen type: string x-stripeBypassValidation: true second_line: anyOf: - maxLength: 5000 type: string - enum: - '' type: string description: The second line to print on the card. shipping: description: The address where the card will be shipped. properties: address: properties: city: maxLength: 5000 type: string country: maxLength: 5000 type: string line1: maxLength: 5000 type: string line2: maxLength: 5000 type: string postal_code: maxLength: 5000 type: string state: maxLength: 5000 type: string required: - city - country - line1 - postal_code title: required_address type: object customs: properties: eori_number: maxLength: 5000 type: string title: customs_param type: object name: maxLength: 5000 type: string phone_number: type: string require_signature: type: boolean service: enum: - express - priority - standard type: string x-stripeBypassValidation: true type: enum: - bulk - individual type: string required: - address - name title: shipping_specs type: object spending_controls: description: >- Rules that control spending for this card. Refer to our [documentation](https://stripe.com/docs/issuing/controls/spending-controls) for more details. properties: allowed_categories: items: enum: - ac_refrigeration_repair - accounting_bookkeeping_services - advertising_services - agricultural_cooperative - airlines_air_carriers - airports_flying_fields - ambulance_services - amusement_parks_carnivals - antique_reproductions - antique_shops - aquariums - architectural_surveying_services - art_dealers_and_galleries - artists_supply_and_craft_shops - auto_and_home_supply_stores - auto_body_repair_shops - auto_paint_shops - auto_service_shops - automated_cash_disburse - automated_fuel_dispensers - automobile_associations - automotive_parts_and_accessories_stores - automotive_tire_stores - bail_and_bond_payments - bakeries - bands_orchestras - barber_and_beauty_shops - betting_casino_gambling - bicycle_shops - billiard_pool_establishments - boat_dealers - boat_rentals_and_leases - book_stores - books_periodicals_and_newspapers - bowling_alleys - bus_lines - business_secretarial_schools - buying_shopping_services - cable_satellite_and_other_pay_television_and_radio - camera_and_photographic_supply_stores - candy_nut_and_confectionery_stores - car_and_truck_dealers_new_used - car_and_truck_dealers_used_only - car_rental_agencies - car_washes - carpentry_services - carpet_upholstery_cleaning - caterers - >- charitable_and_social_service_organizations_fundraising - chemicals_and_allied_products - child_care_services - childrens_and_infants_wear_stores - chiropodists_podiatrists - chiropractors - cigar_stores_and_stands - civic_social_fraternal_associations - cleaning_and_maintenance - clothing_rental - colleges_universities - commercial_equipment - commercial_footwear - commercial_photography_art_and_graphics - commuter_transport_and_ferries - computer_network_services - computer_programming - computer_repair - computer_software_stores - computers_peripherals_and_software - concrete_work_services - construction_materials - consulting_public_relations - correspondence_schools - cosmetic_stores - counseling_services - country_clubs - courier_services - court_costs - credit_reporting_agencies - cruise_lines - dairy_products_stores - dance_hall_studios_schools - dating_escort_services - dentists_orthodontists - department_stores - detective_agencies - digital_goods_applications - digital_goods_games - digital_goods_large_volume - digital_goods_media - direct_marketing_catalog_merchant - >- direct_marketing_combination_catalog_and_retail_merchant - direct_marketing_inbound_telemarketing - direct_marketing_insurance_services - direct_marketing_other - direct_marketing_outbound_telemarketing - direct_marketing_subscription - direct_marketing_travel - discount_stores - doctors - door_to_door_sales - drapery_window_covering_and_upholstery_stores - drinking_places - drug_stores_and_pharmacies - drugs_drug_proprietaries_and_druggist_sundries - dry_cleaners - durable_goods - duty_free_stores - eating_places_restaurants - educational_services - electric_razor_stores - electric_vehicle_charging - electrical_parts_and_equipment - electrical_services - electronics_repair_shops - electronics_stores - elementary_secondary_schools - emergency_services_gcas_visa_use_only - employment_temp_agencies - equipment_rental - exterminating_services - family_clothing_stores - fast_food_restaurants - financial_institutions - fines_government_administrative_entities - fireplace_fireplace_screens_and_accessories_stores - floor_covering_stores - florists - florists_supplies_nursery_stock_and_flowers - freezer_and_locker_meat_provisioners - fuel_dealers_non_automotive - funeral_services_crematories - >- furniture_home_furnishings_and_equipment_stores_except_appliances - furniture_repair_refinishing - furriers_and_fur_shops - general_services - gift_card_novelty_and_souvenir_shops - glass_paint_and_wallpaper_stores - glassware_crystal_stores - golf_courses_public - government_licensed_horse_dog_racing_us_region_only - >- government_licensed_online_casions_online_gambling_us_region_only - government_owned_lotteries_non_us_region - government_owned_lotteries_us_region_only - government_services - grocery_stores_supermarkets - hardware_equipment_and_supplies - hardware_stores - health_and_beauty_spas - hearing_aids_sales_and_supplies - heating_plumbing_a_c - hobby_toy_and_game_shops - home_supply_warehouse_stores - hospitals - hotels_motels_and_resorts - household_appliance_stores - industrial_supplies - information_retrieval_services - insurance_default - insurance_underwriting_premiums - intra_company_purchases - jewelry_stores_watches_clocks_and_silverware_stores - landscaping_services - laundries - laundry_cleaning_services - legal_services_attorneys - luggage_and_leather_goods_stores - lumber_building_materials_stores - manual_cash_disburse - marinas_service_and_supplies - marketplaces - masonry_stonework_and_plaster - massage_parlors - medical_and_dental_labs - >- medical_dental_ophthalmic_and_hospital_equipment_and_supplies - medical_services - membership_organizations - mens_and_boys_clothing_and_accessories_stores - mens_womens_clothing_stores - metal_service_centers - miscellaneous - miscellaneous_apparel_and_accessory_shops - miscellaneous_auto_dealers - miscellaneous_business_services - miscellaneous_food_stores - miscellaneous_general_merchandise - miscellaneous_general_services - miscellaneous_home_furnishing_specialty_stores - miscellaneous_publishing_and_printing - miscellaneous_recreation_services - miscellaneous_repair_shops - miscellaneous_specialty_retail - mobile_home_dealers - motion_picture_theaters - motor_freight_carriers_and_trucking - motor_homes_dealers - motor_vehicle_supplies_and_new_parts - motorcycle_shops_and_dealers - motorcycle_shops_dealers - >- music_stores_musical_instruments_pianos_and_sheet_music - news_dealers_and_newsstands - non_fi_money_orders - non_fi_stored_value_card_purchase_load - nondurable_goods - nurseries_lawn_and_garden_supply_stores - nursing_personal_care - office_and_commercial_furniture - opticians_eyeglasses - optometrists_ophthalmologist - orthopedic_goods_prosthetic_devices - osteopaths - package_stores_beer_wine_and_liquor - paints_varnishes_and_supplies - parking_lots_garages - passenger_railways - pawn_shops - pet_shops_pet_food_and_supplies - petroleum_and_petroleum_products - photo_developing - >- photographic_photocopy_microfilm_equipment_and_supplies - photographic_studios - picture_video_production - piece_goods_notions_and_other_dry_goods - plumbing_heating_equipment_and_supplies - political_organizations - postal_services_government_only - precious_stones_and_metals_watches_and_jewelry - professional_services - public_warehousing_and_storage - quick_copy_repro_and_blueprint - railroads - real_estate_agents_and_managers_rentals - record_stores - recreational_vehicle_rentals - religious_goods_stores - religious_organizations - roofing_siding_sheet_metal - secretarial_support_services - security_brokers_dealers - service_stations - sewing_needlework_fabric_and_piece_goods_stores - shoe_repair_hat_cleaning - shoe_stores - small_appliance_repair - snowmobile_dealers - special_trade_services - specialty_cleaning - sporting_goods_stores - sporting_recreation_camps - sports_and_riding_apparel_stores - sports_clubs_fields - stamp_and_coin_stores - >- stationary_office_supplies_printing_and_writing_paper - stationery_stores_office_and_school_supply_stores - swimming_pools_sales - t_ui_travel_germany - tailors_alterations - tax_payments_government_agencies - tax_preparation_services - taxicabs_limousines - telecommunication_equipment_and_telephone_sales - telecommunication_services - telegraph_services - tent_and_awning_shops - testing_laboratories - theatrical_ticket_agencies - timeshares - tire_retreading_and_repair - tolls_bridge_fees - tourist_attractions_and_exhibits - towing_services - trailer_parks_campgrounds - transportation_services - travel_agencies_tour_operators - truck_stop_iteration - truck_utility_trailer_rentals - typesetting_plate_making_and_related_services - typewriter_stores - u_s_federal_government_agencies_or_departments - uniforms_commercial_clothing - used_merchandise_and_secondhand_stores - utilities - variety_stores - veterinary_services - video_amusement_game_supplies - video_game_arcades - video_tape_rental_stores - vocational_trade_schools - watch_jewelry_repair - welding_repair - wholesale_clubs - wig_and_toupee_stores - wires_money_orders - womens_accessory_and_specialty_shops - womens_ready_to_wear_stores - wrecking_and_salvage_yards maxLength: 5000 type: string type: array allowed_merchant_countries: items: maxLength: 5000 type: string type: array blocked_categories: items: enum: - ac_refrigeration_repair - accounting_bookkeeping_services - advertising_services - agricultural_cooperative - airlines_air_carriers - airports_flying_fields - ambulance_services - amusement_parks_carnivals - antique_reproductions - antique_shops - aquariums - architectural_surveying_services - art_dealers_and_galleries - artists_supply_and_craft_shops - auto_and_home_supply_stores - auto_body_repair_shops - auto_paint_shops - auto_service_shops - automated_cash_disburse - automated_fuel_dispensers - automobile_associations - automotive_parts_and_accessories_stores - automotive_tire_stores - bail_and_bond_payments - bakeries - bands_orchestras - barber_and_beauty_shops - betting_casino_gambling - bicycle_shops - billiard_pool_establishments - boat_dealers - boat_rentals_and_leases - book_stores - books_periodicals_and_newspapers - bowling_alleys - bus_lines - business_secretarial_schools - buying_shopping_services - cable_satellite_and_other_pay_television_and_radio - camera_and_photographic_supply_stores - candy_nut_and_confectionery_stores - car_and_truck_dealers_new_used - car_and_truck_dealers_used_only - car_rental_agencies - car_washes - carpentry_services - carpet_upholstery_cleaning - caterers - >- charitable_and_social_service_organizations_fundraising - chemicals_and_allied_products - child_care_services - childrens_and_infants_wear_stores - chiropodists_podiatrists - chiropractors - cigar_stores_and_stands - civic_social_fraternal_associations - cleaning_and_maintenance - clothing_rental - colleges_universities - commercial_equipment - commercial_footwear - commercial_photography_art_and_graphics - commuter_transport_and_ferries - computer_network_services - computer_programming - computer_repair - computer_software_stores - computers_peripherals_and_software - concrete_work_services - construction_materials - consulting_public_relations - correspondence_schools - cosmetic_stores - counseling_services - country_clubs - courier_services - court_costs - credit_reporting_agencies - cruise_lines - dairy_products_stores - dance_hall_studios_schools - dating_escort_services - dentists_orthodontists - department_stores - detective_agencies - digital_goods_applications - digital_goods_games - digital_goods_large_volume - digital_goods_media - direct_marketing_catalog_merchant - >- direct_marketing_combination_catalog_and_retail_merchant - direct_marketing_inbound_telemarketing - direct_marketing_insurance_services - direct_marketing_other - direct_marketing_outbound_telemarketing - direct_marketing_subscription - direct_marketing_travel - discount_stores - doctors - door_to_door_sales - drapery_window_covering_and_upholstery_stores - drinking_places - drug_stores_and_pharmacies - drugs_drug_proprietaries_and_druggist_sundries - dry_cleaners - durable_goods - duty_free_stores - eating_places_restaurants - educational_services - electric_razor_stores - electric_vehicle_charging - electrical_parts_and_equipment - electrical_services - electronics_repair_shops - electronics_stores - elementary_secondary_schools - emergency_services_gcas_visa_use_only - employment_temp_agencies - equipment_rental - exterminating_services - family_clothing_stores - fast_food_restaurants - financial_institutions - fines_government_administrative_entities - fireplace_fireplace_screens_and_accessories_stores - floor_covering_stores - florists - florists_supplies_nursery_stock_and_flowers - freezer_and_locker_meat_provisioners - fuel_dealers_non_automotive - funeral_services_crematories - >- furniture_home_furnishings_and_equipment_stores_except_appliances - furniture_repair_refinishing - furriers_and_fur_shops - general_services - gift_card_novelty_and_souvenir_shops - glass_paint_and_wallpaper_stores - glassware_crystal_stores - golf_courses_public - government_licensed_horse_dog_racing_us_region_only - >- government_licensed_online_casions_online_gambling_us_region_only - government_owned_lotteries_non_us_region - government_owned_lotteries_us_region_only - government_services - grocery_stores_supermarkets - hardware_equipment_and_supplies - hardware_stores - health_and_beauty_spas - hearing_aids_sales_and_supplies - heating_plumbing_a_c - hobby_toy_and_game_shops - home_supply_warehouse_stores - hospitals - hotels_motels_and_resorts - household_appliance_stores - industrial_supplies - information_retrieval_services - insurance_default - insurance_underwriting_premiums - intra_company_purchases - jewelry_stores_watches_clocks_and_silverware_stores - landscaping_services - laundries - laundry_cleaning_services - legal_services_attorneys - luggage_and_leather_goods_stores - lumber_building_materials_stores - manual_cash_disburse - marinas_service_and_supplies - marketplaces - masonry_stonework_and_plaster - massage_parlors - medical_and_dental_labs - >- medical_dental_ophthalmic_and_hospital_equipment_and_supplies - medical_services - membership_organizations - mens_and_boys_clothing_and_accessories_stores - mens_womens_clothing_stores - metal_service_centers - miscellaneous - miscellaneous_apparel_and_accessory_shops - miscellaneous_auto_dealers - miscellaneous_business_services - miscellaneous_food_stores - miscellaneous_general_merchandise - miscellaneous_general_services - miscellaneous_home_furnishing_specialty_stores - miscellaneous_publishing_and_printing - miscellaneous_recreation_services - miscellaneous_repair_shops - miscellaneous_specialty_retail - mobile_home_dealers - motion_picture_theaters - motor_freight_carriers_and_trucking - motor_homes_dealers - motor_vehicle_supplies_and_new_parts - motorcycle_shops_and_dealers - motorcycle_shops_dealers - >- music_stores_musical_instruments_pianos_and_sheet_music - news_dealers_and_newsstands - non_fi_money_orders - non_fi_stored_value_card_purchase_load - nondurable_goods - nurseries_lawn_and_garden_supply_stores - nursing_personal_care - office_and_commercial_furniture - opticians_eyeglasses - optometrists_ophthalmologist - orthopedic_goods_prosthetic_devices - osteopaths - package_stores_beer_wine_and_liquor - paints_varnishes_and_supplies - parking_lots_garages - passenger_railways - pawn_shops - pet_shops_pet_food_and_supplies - petroleum_and_petroleum_products - photo_developing - >- photographic_photocopy_microfilm_equipment_and_supplies - photographic_studios - picture_video_production - piece_goods_notions_and_other_dry_goods - plumbing_heating_equipment_and_supplies - political_organizations - postal_services_government_only - precious_stones_and_metals_watches_and_jewelry - professional_services - public_warehousing_and_storage - quick_copy_repro_and_blueprint - railroads - real_estate_agents_and_managers_rentals - record_stores - recreational_vehicle_rentals - religious_goods_stores - religious_organizations - roofing_siding_sheet_metal - secretarial_support_services - security_brokers_dealers - service_stations - sewing_needlework_fabric_and_piece_goods_stores - shoe_repair_hat_cleaning - shoe_stores - small_appliance_repair - snowmobile_dealers - special_trade_services - specialty_cleaning - sporting_goods_stores - sporting_recreation_camps - sports_and_riding_apparel_stores - sports_clubs_fields - stamp_and_coin_stores - >- stationary_office_supplies_printing_and_writing_paper - stationery_stores_office_and_school_supply_stores - swimming_pools_sales - t_ui_travel_germany - tailors_alterations - tax_payments_government_agencies - tax_preparation_services - taxicabs_limousines - telecommunication_equipment_and_telephone_sales - telecommunication_services - telegraph_services - tent_and_awning_shops - testing_laboratories - theatrical_ticket_agencies - timeshares - tire_retreading_and_repair - tolls_bridge_fees - tourist_attractions_and_exhibits - towing_services - trailer_parks_campgrounds - transportation_services - travel_agencies_tour_operators - truck_stop_iteration - truck_utility_trailer_rentals - typesetting_plate_making_and_related_services - typewriter_stores - u_s_federal_government_agencies_or_departments - uniforms_commercial_clothing - used_merchandise_and_secondhand_stores - utilities - variety_stores - veterinary_services - video_amusement_game_supplies - video_game_arcades - video_tape_rental_stores - vocational_trade_schools - watch_jewelry_repair - welding_repair - wholesale_clubs - wig_and_toupee_stores - wires_money_orders - womens_accessory_and_specialty_shops - womens_ready_to_wear_stores - wrecking_and_salvage_yards maxLength: 5000 type: string type: array blocked_merchant_countries: items: maxLength: 5000 type: string type: array spending_limits: items: properties: amount: type: integer categories: items: enum: - ac_refrigeration_repair - accounting_bookkeeping_services - advertising_services - agricultural_cooperative - airlines_air_carriers - airports_flying_fields - ambulance_services - amusement_parks_carnivals - antique_reproductions - antique_shops - aquariums - architectural_surveying_services - art_dealers_and_galleries - artists_supply_and_craft_shops - auto_and_home_supply_stores - auto_body_repair_shops - auto_paint_shops - auto_service_shops - automated_cash_disburse - automated_fuel_dispensers - automobile_associations - automotive_parts_and_accessories_stores - automotive_tire_stores - bail_and_bond_payments - bakeries - bands_orchestras - barber_and_beauty_shops - betting_casino_gambling - bicycle_shops - billiard_pool_establishments - boat_dealers - boat_rentals_and_leases - book_stores - books_periodicals_and_newspapers - bowling_alleys - bus_lines - business_secretarial_schools - buying_shopping_services - >- cable_satellite_and_other_pay_television_and_radio - camera_and_photographic_supply_stores - candy_nut_and_confectionery_stores - car_and_truck_dealers_new_used - car_and_truck_dealers_used_only - car_rental_agencies - car_washes - carpentry_services - carpet_upholstery_cleaning - caterers - >- charitable_and_social_service_organizations_fundraising - chemicals_and_allied_products - child_care_services - childrens_and_infants_wear_stores - chiropodists_podiatrists - chiropractors - cigar_stores_and_stands - civic_social_fraternal_associations - cleaning_and_maintenance - clothing_rental - colleges_universities - commercial_equipment - commercial_footwear - commercial_photography_art_and_graphics - commuter_transport_and_ferries - computer_network_services - computer_programming - computer_repair - computer_software_stores - computers_peripherals_and_software - concrete_work_services - construction_materials - consulting_public_relations - correspondence_schools - cosmetic_stores - counseling_services - country_clubs - courier_services - court_costs - credit_reporting_agencies - cruise_lines - dairy_products_stores - dance_hall_studios_schools - dating_escort_services - dentists_orthodontists - department_stores - detective_agencies - digital_goods_applications - digital_goods_games - digital_goods_large_volume - digital_goods_media - direct_marketing_catalog_merchant - >- direct_marketing_combination_catalog_and_retail_merchant - direct_marketing_inbound_telemarketing - direct_marketing_insurance_services - direct_marketing_other - direct_marketing_outbound_telemarketing - direct_marketing_subscription - direct_marketing_travel - discount_stores - doctors - door_to_door_sales - drapery_window_covering_and_upholstery_stores - drinking_places - drug_stores_and_pharmacies - drugs_drug_proprietaries_and_druggist_sundries - dry_cleaners - durable_goods - duty_free_stores - eating_places_restaurants - educational_services - electric_razor_stores - electric_vehicle_charging - electrical_parts_and_equipment - electrical_services - electronics_repair_shops - electronics_stores - elementary_secondary_schools - emergency_services_gcas_visa_use_only - employment_temp_agencies - equipment_rental - exterminating_services - family_clothing_stores - fast_food_restaurants - financial_institutions - fines_government_administrative_entities - >- fireplace_fireplace_screens_and_accessories_stores - floor_covering_stores - florists - florists_supplies_nursery_stock_and_flowers - freezer_and_locker_meat_provisioners - fuel_dealers_non_automotive - funeral_services_crematories - >- furniture_home_furnishings_and_equipment_stores_except_appliances - furniture_repair_refinishing - furriers_and_fur_shops - general_services - gift_card_novelty_and_souvenir_shops - glass_paint_and_wallpaper_stores - glassware_crystal_stores - golf_courses_public - >- government_licensed_horse_dog_racing_us_region_only - >- government_licensed_online_casions_online_gambling_us_region_only - government_owned_lotteries_non_us_region - government_owned_lotteries_us_region_only - government_services - grocery_stores_supermarkets - hardware_equipment_and_supplies - hardware_stores - health_and_beauty_spas - hearing_aids_sales_and_supplies - heating_plumbing_a_c - hobby_toy_and_game_shops - home_supply_warehouse_stores - hospitals - hotels_motels_and_resorts - household_appliance_stores - industrial_supplies - information_retrieval_services - insurance_default - insurance_underwriting_premiums - intra_company_purchases - >- jewelry_stores_watches_clocks_and_silverware_stores - landscaping_services - laundries - laundry_cleaning_services - legal_services_attorneys - luggage_and_leather_goods_stores - lumber_building_materials_stores - manual_cash_disburse - marinas_service_and_supplies - marketplaces - masonry_stonework_and_plaster - massage_parlors - medical_and_dental_labs - >- medical_dental_ophthalmic_and_hospital_equipment_and_supplies - medical_services - membership_organizations - mens_and_boys_clothing_and_accessories_stores - mens_womens_clothing_stores - metal_service_centers - miscellaneous - miscellaneous_apparel_and_accessory_shops - miscellaneous_auto_dealers - miscellaneous_business_services - miscellaneous_food_stores - miscellaneous_general_merchandise - miscellaneous_general_services - miscellaneous_home_furnishing_specialty_stores - miscellaneous_publishing_and_printing - miscellaneous_recreation_services - miscellaneous_repair_shops - miscellaneous_specialty_retail - mobile_home_dealers - motion_picture_theaters - motor_freight_carriers_and_trucking - motor_homes_dealers - motor_vehicle_supplies_and_new_parts - motorcycle_shops_and_dealers - motorcycle_shops_dealers - >- music_stores_musical_instruments_pianos_and_sheet_music - news_dealers_and_newsstands - non_fi_money_orders - non_fi_stored_value_card_purchase_load - nondurable_goods - nurseries_lawn_and_garden_supply_stores - nursing_personal_care - office_and_commercial_furniture - opticians_eyeglasses - optometrists_ophthalmologist - orthopedic_goods_prosthetic_devices - osteopaths - package_stores_beer_wine_and_liquor - paints_varnishes_and_supplies - parking_lots_garages - passenger_railways - pawn_shops - pet_shops_pet_food_and_supplies - petroleum_and_petroleum_products - photo_developing - >- photographic_photocopy_microfilm_equipment_and_supplies - photographic_studios - picture_video_production - piece_goods_notions_and_other_dry_goods - plumbing_heating_equipment_and_supplies - political_organizations - postal_services_government_only - precious_stones_and_metals_watches_and_jewelry - professional_services - public_warehousing_and_storage - quick_copy_repro_and_blueprint - railroads - real_estate_agents_and_managers_rentals - record_stores - recreational_vehicle_rentals - religious_goods_stores - religious_organizations - roofing_siding_sheet_metal - secretarial_support_services - security_brokers_dealers - service_stations - >- sewing_needlework_fabric_and_piece_goods_stores - shoe_repair_hat_cleaning - shoe_stores - small_appliance_repair - snowmobile_dealers - special_trade_services - specialty_cleaning - sporting_goods_stores - sporting_recreation_camps - sports_and_riding_apparel_stores - sports_clubs_fields - stamp_and_coin_stores - >- stationary_office_supplies_printing_and_writing_paper - >- stationery_stores_office_and_school_supply_stores - swimming_pools_sales - t_ui_travel_germany - tailors_alterations - tax_payments_government_agencies - tax_preparation_services - taxicabs_limousines - >- telecommunication_equipment_and_telephone_sales - telecommunication_services - telegraph_services - tent_and_awning_shops - testing_laboratories - theatrical_ticket_agencies - timeshares - tire_retreading_and_repair - tolls_bridge_fees - tourist_attractions_and_exhibits - towing_services - trailer_parks_campgrounds - transportation_services - travel_agencies_tour_operators - truck_stop_iteration - truck_utility_trailer_rentals - typesetting_plate_making_and_related_services - typewriter_stores - u_s_federal_government_agencies_or_departments - uniforms_commercial_clothing - used_merchandise_and_secondhand_stores - utilities - variety_stores - veterinary_services - video_amusement_game_supplies - video_game_arcades - video_tape_rental_stores - vocational_trade_schools - watch_jewelry_repair - welding_repair - wholesale_clubs - wig_and_toupee_stores - wires_money_orders - womens_accessory_and_specialty_shops - womens_ready_to_wear_stores - wrecking_and_salvage_yards maxLength: 5000 type: string type: array interval: enum: - all_time - daily - monthly - per_authorization - weekly - yearly type: string required: - amount - interval title: spending_limits_param type: object type: array title: authorization_controls_param type: object status: description: >- Whether authorizations can be approved on this card. May be blocked from activating cards depending on past-due Cardholder requirements. Defaults to `inactive`. enum: - active - inactive type: string type: description: >- The type of card to issue. Possible values are `physical` or `virtual`. enum: - physical - virtual type: string required: - currency - type type: object required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/issuing.card' description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. '/v1/issuing/cards/{card}': get: description:

Retrieves an Issuing Card object.

operationId: GetIssuingCardsCard parameters: - in: path name: card required: true schema: maxLength: 5000 type: string style: simple - description: Specifies which fields in the response should be expanded. explode: true in: query name: expand required: false schema: items: maxLength: 5000 type: string type: array style: deepObject requestBody: content: application/x-www-form-urlencoded: encoding: {} schema: additionalProperties: false properties: {} type: object required: false responses: '200': content: application/json: schema: $ref: '#/components/schemas/issuing.card' description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. post: description: >-

Updates the specified Issuing Card object by setting the values of the parameters passed. Any parameters not provided will be left unchanged.

operationId: PostIssuingCardsCard parameters: - in: path name: card required: true schema: maxLength: 5000 type: string style: simple requestBody: content: application/x-www-form-urlencoded: encoding: expand: explode: true style: deepObject metadata: explode: true style: deepObject pin: explode: true style: deepObject spending_controls: explode: true style: deepObject schema: additionalProperties: false properties: cancellation_reason: description: Reason why the `status` of this card is `canceled`. enum: - lost - stolen type: string x-stripeBypassValidation: true expand: description: Specifies which fields in the response should be expanded. items: maxLength: 5000 type: string type: array metadata: anyOf: - additionalProperties: type: string type: object - enum: - '' type: string description: >- Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. personalization_design: maxLength: 5000 type: string pin: description: The desired new PIN for this card. properties: encrypted_number: maxLength: 5000 type: string title: encrypted_pin_param type: object spending_controls: description: >- Rules that control spending for this card. Refer to our [documentation](https://stripe.com/docs/issuing/controls/spending-controls) for more details. properties: allowed_categories: items: enum: - ac_refrigeration_repair - accounting_bookkeeping_services - advertising_services - agricultural_cooperative - airlines_air_carriers - airports_flying_fields - ambulance_services - amusement_parks_carnivals - antique_reproductions - antique_shops - aquariums - architectural_surveying_services - art_dealers_and_galleries - artists_supply_and_craft_shops - auto_and_home_supply_stores - auto_body_repair_shops - auto_paint_shops - auto_service_shops - automated_cash_disburse - automated_fuel_dispensers - automobile_associations - automotive_parts_and_accessories_stores - automotive_tire_stores - bail_and_bond_payments - bakeries - bands_orchestras - barber_and_beauty_shops - betting_casino_gambling - bicycle_shops - billiard_pool_establishments - boat_dealers - boat_rentals_and_leases - book_stores - books_periodicals_and_newspapers - bowling_alleys - bus_lines - business_secretarial_schools - buying_shopping_services - cable_satellite_and_other_pay_television_and_radio - camera_and_photographic_supply_stores - candy_nut_and_confectionery_stores - car_and_truck_dealers_new_used - car_and_truck_dealers_used_only - car_rental_agencies - car_washes - carpentry_services - carpet_upholstery_cleaning - caterers - >- charitable_and_social_service_organizations_fundraising - chemicals_and_allied_products - child_care_services - childrens_and_infants_wear_stores - chiropodists_podiatrists - chiropractors - cigar_stores_and_stands - civic_social_fraternal_associations - cleaning_and_maintenance - clothing_rental - colleges_universities - commercial_equipment - commercial_footwear - commercial_photography_art_and_graphics - commuter_transport_and_ferries - computer_network_services - computer_programming - computer_repair - computer_software_stores - computers_peripherals_and_software - concrete_work_services - construction_materials - consulting_public_relations - correspondence_schools - cosmetic_stores - counseling_services - country_clubs - courier_services - court_costs - credit_reporting_agencies - cruise_lines - dairy_products_stores - dance_hall_studios_schools - dating_escort_services - dentists_orthodontists - department_stores - detective_agencies - digital_goods_applications - digital_goods_games - digital_goods_large_volume - digital_goods_media - direct_marketing_catalog_merchant - >- direct_marketing_combination_catalog_and_retail_merchant - direct_marketing_inbound_telemarketing - direct_marketing_insurance_services - direct_marketing_other - direct_marketing_outbound_telemarketing - direct_marketing_subscription - direct_marketing_travel - discount_stores - doctors - door_to_door_sales - drapery_window_covering_and_upholstery_stores - drinking_places - drug_stores_and_pharmacies - drugs_drug_proprietaries_and_druggist_sundries - dry_cleaners - durable_goods - duty_free_stores - eating_places_restaurants - educational_services - electric_razor_stores - electric_vehicle_charging - electrical_parts_and_equipment - electrical_services - electronics_repair_shops - electronics_stores - elementary_secondary_schools - emergency_services_gcas_visa_use_only - employment_temp_agencies - equipment_rental - exterminating_services - family_clothing_stores - fast_food_restaurants - financial_institutions - fines_government_administrative_entities - fireplace_fireplace_screens_and_accessories_stores - floor_covering_stores - florists - florists_supplies_nursery_stock_and_flowers - freezer_and_locker_meat_provisioners - fuel_dealers_non_automotive - funeral_services_crematories - >- furniture_home_furnishings_and_equipment_stores_except_appliances - furniture_repair_refinishing - furriers_and_fur_shops - general_services - gift_card_novelty_and_souvenir_shops - glass_paint_and_wallpaper_stores - glassware_crystal_stores - golf_courses_public - government_licensed_horse_dog_racing_us_region_only - >- government_licensed_online_casions_online_gambling_us_region_only - government_owned_lotteries_non_us_region - government_owned_lotteries_us_region_only - government_services - grocery_stores_supermarkets - hardware_equipment_and_supplies - hardware_stores - health_and_beauty_spas - hearing_aids_sales_and_supplies - heating_plumbing_a_c - hobby_toy_and_game_shops - home_supply_warehouse_stores - hospitals - hotels_motels_and_resorts - household_appliance_stores - industrial_supplies - information_retrieval_services - insurance_default - insurance_underwriting_premiums - intra_company_purchases - jewelry_stores_watches_clocks_and_silverware_stores - landscaping_services - laundries - laundry_cleaning_services - legal_services_attorneys - luggage_and_leather_goods_stores - lumber_building_materials_stores - manual_cash_disburse - marinas_service_and_supplies - marketplaces - masonry_stonework_and_plaster - massage_parlors - medical_and_dental_labs - >- medical_dental_ophthalmic_and_hospital_equipment_and_supplies - medical_services - membership_organizations - mens_and_boys_clothing_and_accessories_stores - mens_womens_clothing_stores - metal_service_centers - miscellaneous - miscellaneous_apparel_and_accessory_shops - miscellaneous_auto_dealers - miscellaneous_business_services - miscellaneous_food_stores - miscellaneous_general_merchandise - miscellaneous_general_services - miscellaneous_home_furnishing_specialty_stores - miscellaneous_publishing_and_printing - miscellaneous_recreation_services - miscellaneous_repair_shops - miscellaneous_specialty_retail - mobile_home_dealers - motion_picture_theaters - motor_freight_carriers_and_trucking - motor_homes_dealers - motor_vehicle_supplies_and_new_parts - motorcycle_shops_and_dealers - motorcycle_shops_dealers - >- music_stores_musical_instruments_pianos_and_sheet_music - news_dealers_and_newsstands - non_fi_money_orders - non_fi_stored_value_card_purchase_load - nondurable_goods - nurseries_lawn_and_garden_supply_stores - nursing_personal_care - office_and_commercial_furniture - opticians_eyeglasses - optometrists_ophthalmologist - orthopedic_goods_prosthetic_devices - osteopaths - package_stores_beer_wine_and_liquor - paints_varnishes_and_supplies - parking_lots_garages - passenger_railways - pawn_shops - pet_shops_pet_food_and_supplies - petroleum_and_petroleum_products - photo_developing - >- photographic_photocopy_microfilm_equipment_and_supplies - photographic_studios - picture_video_production - piece_goods_notions_and_other_dry_goods - plumbing_heating_equipment_and_supplies - political_organizations - postal_services_government_only - precious_stones_and_metals_watches_and_jewelry - professional_services - public_warehousing_and_storage - quick_copy_repro_and_blueprint - railroads - real_estate_agents_and_managers_rentals - record_stores - recreational_vehicle_rentals - religious_goods_stores - religious_organizations - roofing_siding_sheet_metal - secretarial_support_services - security_brokers_dealers - service_stations - sewing_needlework_fabric_and_piece_goods_stores - shoe_repair_hat_cleaning - shoe_stores - small_appliance_repair - snowmobile_dealers - special_trade_services - specialty_cleaning - sporting_goods_stores - sporting_recreation_camps - sports_and_riding_apparel_stores - sports_clubs_fields - stamp_and_coin_stores - >- stationary_office_supplies_printing_and_writing_paper - stationery_stores_office_and_school_supply_stores - swimming_pools_sales - t_ui_travel_germany - tailors_alterations - tax_payments_government_agencies - tax_preparation_services - taxicabs_limousines - telecommunication_equipment_and_telephone_sales - telecommunication_services - telegraph_services - tent_and_awning_shops - testing_laboratories - theatrical_ticket_agencies - timeshares - tire_retreading_and_repair - tolls_bridge_fees - tourist_attractions_and_exhibits - towing_services - trailer_parks_campgrounds - transportation_services - travel_agencies_tour_operators - truck_stop_iteration - truck_utility_trailer_rentals - typesetting_plate_making_and_related_services - typewriter_stores - u_s_federal_government_agencies_or_departments - uniforms_commercial_clothing - used_merchandise_and_secondhand_stores - utilities - variety_stores - veterinary_services - video_amusement_game_supplies - video_game_arcades - video_tape_rental_stores - vocational_trade_schools - watch_jewelry_repair - welding_repair - wholesale_clubs - wig_and_toupee_stores - wires_money_orders - womens_accessory_and_specialty_shops - womens_ready_to_wear_stores - wrecking_and_salvage_yards maxLength: 5000 type: string type: array allowed_merchant_countries: items: maxLength: 5000 type: string type: array blocked_categories: items: enum: - ac_refrigeration_repair - accounting_bookkeeping_services - advertising_services - agricultural_cooperative - airlines_air_carriers - airports_flying_fields - ambulance_services - amusement_parks_carnivals - antique_reproductions - antique_shops - aquariums - architectural_surveying_services - art_dealers_and_galleries - artists_supply_and_craft_shops - auto_and_home_supply_stores - auto_body_repair_shops - auto_paint_shops - auto_service_shops - automated_cash_disburse - automated_fuel_dispensers - automobile_associations - automotive_parts_and_accessories_stores - automotive_tire_stores - bail_and_bond_payments - bakeries - bands_orchestras - barber_and_beauty_shops - betting_casino_gambling - bicycle_shops - billiard_pool_establishments - boat_dealers - boat_rentals_and_leases - book_stores - books_periodicals_and_newspapers - bowling_alleys - bus_lines - business_secretarial_schools - buying_shopping_services - cable_satellite_and_other_pay_television_and_radio - camera_and_photographic_supply_stores - candy_nut_and_confectionery_stores - car_and_truck_dealers_new_used - car_and_truck_dealers_used_only - car_rental_agencies - car_washes - carpentry_services - carpet_upholstery_cleaning - caterers - >- charitable_and_social_service_organizations_fundraising - chemicals_and_allied_products - child_care_services - childrens_and_infants_wear_stores - chiropodists_podiatrists - chiropractors - cigar_stores_and_stands - civic_social_fraternal_associations - cleaning_and_maintenance - clothing_rental - colleges_universities - commercial_equipment - commercial_footwear - commercial_photography_art_and_graphics - commuter_transport_and_ferries - computer_network_services - computer_programming - computer_repair - computer_software_stores - computers_peripherals_and_software - concrete_work_services - construction_materials - consulting_public_relations - correspondence_schools - cosmetic_stores - counseling_services - country_clubs - courier_services - court_costs - credit_reporting_agencies - cruise_lines - dairy_products_stores - dance_hall_studios_schools - dating_escort_services - dentists_orthodontists - department_stores - detective_agencies - digital_goods_applications - digital_goods_games - digital_goods_large_volume - digital_goods_media - direct_marketing_catalog_merchant - >- direct_marketing_combination_catalog_and_retail_merchant - direct_marketing_inbound_telemarketing - direct_marketing_insurance_services - direct_marketing_other - direct_marketing_outbound_telemarketing - direct_marketing_subscription - direct_marketing_travel - discount_stores - doctors - door_to_door_sales - drapery_window_covering_and_upholstery_stores - drinking_places - drug_stores_and_pharmacies - drugs_drug_proprietaries_and_druggist_sundries - dry_cleaners - durable_goods - duty_free_stores - eating_places_restaurants - educational_services - electric_razor_stores - electric_vehicle_charging - electrical_parts_and_equipment - electrical_services - electronics_repair_shops - electronics_stores - elementary_secondary_schools - emergency_services_gcas_visa_use_only - employment_temp_agencies - equipment_rental - exterminating_services - family_clothing_stores - fast_food_restaurants - financial_institutions - fines_government_administrative_entities - fireplace_fireplace_screens_and_accessories_stores - floor_covering_stores - florists - florists_supplies_nursery_stock_and_flowers - freezer_and_locker_meat_provisioners - fuel_dealers_non_automotive - funeral_services_crematories - >- furniture_home_furnishings_and_equipment_stores_except_appliances - furniture_repair_refinishing - furriers_and_fur_shops - general_services - gift_card_novelty_and_souvenir_shops - glass_paint_and_wallpaper_stores - glassware_crystal_stores - golf_courses_public - government_licensed_horse_dog_racing_us_region_only - >- government_licensed_online_casions_online_gambling_us_region_only - government_owned_lotteries_non_us_region - government_owned_lotteries_us_region_only - government_services - grocery_stores_supermarkets - hardware_equipment_and_supplies - hardware_stores - health_and_beauty_spas - hearing_aids_sales_and_supplies - heating_plumbing_a_c - hobby_toy_and_game_shops - home_supply_warehouse_stores - hospitals - hotels_motels_and_resorts - household_appliance_stores - industrial_supplies - information_retrieval_services - insurance_default - insurance_underwriting_premiums - intra_company_purchases - jewelry_stores_watches_clocks_and_silverware_stores - landscaping_services - laundries - laundry_cleaning_services - legal_services_attorneys - luggage_and_leather_goods_stores - lumber_building_materials_stores - manual_cash_disburse - marinas_service_and_supplies - marketplaces - masonry_stonework_and_plaster - massage_parlors - medical_and_dental_labs - >- medical_dental_ophthalmic_and_hospital_equipment_and_supplies - medical_services - membership_organizations - mens_and_boys_clothing_and_accessories_stores - mens_womens_clothing_stores - metal_service_centers - miscellaneous - miscellaneous_apparel_and_accessory_shops - miscellaneous_auto_dealers - miscellaneous_business_services - miscellaneous_food_stores - miscellaneous_general_merchandise - miscellaneous_general_services - miscellaneous_home_furnishing_specialty_stores - miscellaneous_publishing_and_printing - miscellaneous_recreation_services - miscellaneous_repair_shops - miscellaneous_specialty_retail - mobile_home_dealers - motion_picture_theaters - motor_freight_carriers_and_trucking - motor_homes_dealers - motor_vehicle_supplies_and_new_parts - motorcycle_shops_and_dealers - motorcycle_shops_dealers - >- music_stores_musical_instruments_pianos_and_sheet_music - news_dealers_and_newsstands - non_fi_money_orders - non_fi_stored_value_card_purchase_load - nondurable_goods - nurseries_lawn_and_garden_supply_stores - nursing_personal_care - office_and_commercial_furniture - opticians_eyeglasses - optometrists_ophthalmologist - orthopedic_goods_prosthetic_devices - osteopaths - package_stores_beer_wine_and_liquor - paints_varnishes_and_supplies - parking_lots_garages - passenger_railways - pawn_shops - pet_shops_pet_food_and_supplies - petroleum_and_petroleum_products - photo_developing - >- photographic_photocopy_microfilm_equipment_and_supplies - photographic_studios - picture_video_production - piece_goods_notions_and_other_dry_goods - plumbing_heating_equipment_and_supplies - political_organizations - postal_services_government_only - precious_stones_and_metals_watches_and_jewelry - professional_services - public_warehousing_and_storage - quick_copy_repro_and_blueprint - railroads - real_estate_agents_and_managers_rentals - record_stores - recreational_vehicle_rentals - religious_goods_stores - religious_organizations - roofing_siding_sheet_metal - secretarial_support_services - security_brokers_dealers - service_stations - sewing_needlework_fabric_and_piece_goods_stores - shoe_repair_hat_cleaning - shoe_stores - small_appliance_repair - snowmobile_dealers - special_trade_services - specialty_cleaning - sporting_goods_stores - sporting_recreation_camps - sports_and_riding_apparel_stores - sports_clubs_fields - stamp_and_coin_stores - >- stationary_office_supplies_printing_and_writing_paper - stationery_stores_office_and_school_supply_stores - swimming_pools_sales - t_ui_travel_germany - tailors_alterations - tax_payments_government_agencies - tax_preparation_services - taxicabs_limousines - telecommunication_equipment_and_telephone_sales - telecommunication_services - telegraph_services - tent_and_awning_shops - testing_laboratories - theatrical_ticket_agencies - timeshares - tire_retreading_and_repair - tolls_bridge_fees - tourist_attractions_and_exhibits - towing_services - trailer_parks_campgrounds - transportation_services - travel_agencies_tour_operators - truck_stop_iteration - truck_utility_trailer_rentals - typesetting_plate_making_and_related_services - typewriter_stores - u_s_federal_government_agencies_or_departments - uniforms_commercial_clothing - used_merchandise_and_secondhand_stores - utilities - variety_stores - veterinary_services - video_amusement_game_supplies - video_game_arcades - video_tape_rental_stores - vocational_trade_schools - watch_jewelry_repair - welding_repair - wholesale_clubs - wig_and_toupee_stores - wires_money_orders - womens_accessory_and_specialty_shops - womens_ready_to_wear_stores - wrecking_and_salvage_yards maxLength: 5000 type: string type: array blocked_merchant_countries: items: maxLength: 5000 type: string type: array spending_limits: items: properties: amount: type: integer categories: items: enum: - ac_refrigeration_repair - accounting_bookkeeping_services - advertising_services - agricultural_cooperative - airlines_air_carriers - airports_flying_fields - ambulance_services - amusement_parks_carnivals - antique_reproductions - antique_shops - aquariums - architectural_surveying_services - art_dealers_and_galleries - artists_supply_and_craft_shops - auto_and_home_supply_stores - auto_body_repair_shops - auto_paint_shops - auto_service_shops - automated_cash_disburse - automated_fuel_dispensers - automobile_associations - automotive_parts_and_accessories_stores - automotive_tire_stores - bail_and_bond_payments - bakeries - bands_orchestras - barber_and_beauty_shops - betting_casino_gambling - bicycle_shops - billiard_pool_establishments - boat_dealers - boat_rentals_and_leases - book_stores - books_periodicals_and_newspapers - bowling_alleys - bus_lines - business_secretarial_schools - buying_shopping_services - >- cable_satellite_and_other_pay_television_and_radio - camera_and_photographic_supply_stores - candy_nut_and_confectionery_stores - car_and_truck_dealers_new_used - car_and_truck_dealers_used_only - car_rental_agencies - car_washes - carpentry_services - carpet_upholstery_cleaning - caterers - >- charitable_and_social_service_organizations_fundraising - chemicals_and_allied_products - child_care_services - childrens_and_infants_wear_stores - chiropodists_podiatrists - chiropractors - cigar_stores_and_stands - civic_social_fraternal_associations - cleaning_and_maintenance - clothing_rental - colleges_universities - commercial_equipment - commercial_footwear - commercial_photography_art_and_graphics - commuter_transport_and_ferries - computer_network_services - computer_programming - computer_repair - computer_software_stores - computers_peripherals_and_software - concrete_work_services - construction_materials - consulting_public_relations - correspondence_schools - cosmetic_stores - counseling_services - country_clubs - courier_services - court_costs - credit_reporting_agencies - cruise_lines - dairy_products_stores - dance_hall_studios_schools - dating_escort_services - dentists_orthodontists - department_stores - detective_agencies - digital_goods_applications - digital_goods_games - digital_goods_large_volume - digital_goods_media - direct_marketing_catalog_merchant - >- direct_marketing_combination_catalog_and_retail_merchant - direct_marketing_inbound_telemarketing - direct_marketing_insurance_services - direct_marketing_other - direct_marketing_outbound_telemarketing - direct_marketing_subscription - direct_marketing_travel - discount_stores - doctors - door_to_door_sales - drapery_window_covering_and_upholstery_stores - drinking_places - drug_stores_and_pharmacies - drugs_drug_proprietaries_and_druggist_sundries - dry_cleaners - durable_goods - duty_free_stores - eating_places_restaurants - educational_services - electric_razor_stores - electric_vehicle_charging - electrical_parts_and_equipment - electrical_services - electronics_repair_shops - electronics_stores - elementary_secondary_schools - emergency_services_gcas_visa_use_only - employment_temp_agencies - equipment_rental - exterminating_services - family_clothing_stores - fast_food_restaurants - financial_institutions - fines_government_administrative_entities - >- fireplace_fireplace_screens_and_accessories_stores - floor_covering_stores - florists - florists_supplies_nursery_stock_and_flowers - freezer_and_locker_meat_provisioners - fuel_dealers_non_automotive - funeral_services_crematories - >- furniture_home_furnishings_and_equipment_stores_except_appliances - furniture_repair_refinishing - furriers_and_fur_shops - general_services - gift_card_novelty_and_souvenir_shops - glass_paint_and_wallpaper_stores - glassware_crystal_stores - golf_courses_public - >- government_licensed_horse_dog_racing_us_region_only - >- government_licensed_online_casions_online_gambling_us_region_only - government_owned_lotteries_non_us_region - government_owned_lotteries_us_region_only - government_services - grocery_stores_supermarkets - hardware_equipment_and_supplies - hardware_stores - health_and_beauty_spas - hearing_aids_sales_and_supplies - heating_plumbing_a_c - hobby_toy_and_game_shops - home_supply_warehouse_stores - hospitals - hotels_motels_and_resorts - household_appliance_stores - industrial_supplies - information_retrieval_services - insurance_default - insurance_underwriting_premiums - intra_company_purchases - >- jewelry_stores_watches_clocks_and_silverware_stores - landscaping_services - laundries - laundry_cleaning_services - legal_services_attorneys - luggage_and_leather_goods_stores - lumber_building_materials_stores - manual_cash_disburse - marinas_service_and_supplies - marketplaces - masonry_stonework_and_plaster - massage_parlors - medical_and_dental_labs - >- medical_dental_ophthalmic_and_hospital_equipment_and_supplies - medical_services - membership_organizations - mens_and_boys_clothing_and_accessories_stores - mens_womens_clothing_stores - metal_service_centers - miscellaneous - miscellaneous_apparel_and_accessory_shops - miscellaneous_auto_dealers - miscellaneous_business_services - miscellaneous_food_stores - miscellaneous_general_merchandise - miscellaneous_general_services - miscellaneous_home_furnishing_specialty_stores - miscellaneous_publishing_and_printing - miscellaneous_recreation_services - miscellaneous_repair_shops - miscellaneous_specialty_retail - mobile_home_dealers - motion_picture_theaters - motor_freight_carriers_and_trucking - motor_homes_dealers - motor_vehicle_supplies_and_new_parts - motorcycle_shops_and_dealers - motorcycle_shops_dealers - >- music_stores_musical_instruments_pianos_and_sheet_music - news_dealers_and_newsstands - non_fi_money_orders - non_fi_stored_value_card_purchase_load - nondurable_goods - nurseries_lawn_and_garden_supply_stores - nursing_personal_care - office_and_commercial_furniture - opticians_eyeglasses - optometrists_ophthalmologist - orthopedic_goods_prosthetic_devices - osteopaths - package_stores_beer_wine_and_liquor - paints_varnishes_and_supplies - parking_lots_garages - passenger_railways - pawn_shops - pet_shops_pet_food_and_supplies - petroleum_and_petroleum_products - photo_developing - >- photographic_photocopy_microfilm_equipment_and_supplies - photographic_studios - picture_video_production - piece_goods_notions_and_other_dry_goods - plumbing_heating_equipment_and_supplies - political_organizations - postal_services_government_only - precious_stones_and_metals_watches_and_jewelry - professional_services - public_warehousing_and_storage - quick_copy_repro_and_blueprint - railroads - real_estate_agents_and_managers_rentals - record_stores - recreational_vehicle_rentals - religious_goods_stores - religious_organizations - roofing_siding_sheet_metal - secretarial_support_services - security_brokers_dealers - service_stations - >- sewing_needlework_fabric_and_piece_goods_stores - shoe_repair_hat_cleaning - shoe_stores - small_appliance_repair - snowmobile_dealers - special_trade_services - specialty_cleaning - sporting_goods_stores - sporting_recreation_camps - sports_and_riding_apparel_stores - sports_clubs_fields - stamp_and_coin_stores - >- stationary_office_supplies_printing_and_writing_paper - >- stationery_stores_office_and_school_supply_stores - swimming_pools_sales - t_ui_travel_germany - tailors_alterations - tax_payments_government_agencies - tax_preparation_services - taxicabs_limousines - >- telecommunication_equipment_and_telephone_sales - telecommunication_services - telegraph_services - tent_and_awning_shops - testing_laboratories - theatrical_ticket_agencies - timeshares - tire_retreading_and_repair - tolls_bridge_fees - tourist_attractions_and_exhibits - towing_services - trailer_parks_campgrounds - transportation_services - travel_agencies_tour_operators - truck_stop_iteration - truck_utility_trailer_rentals - typesetting_plate_making_and_related_services - typewriter_stores - u_s_federal_government_agencies_or_departments - uniforms_commercial_clothing - used_merchandise_and_secondhand_stores - utilities - variety_stores - veterinary_services - video_amusement_game_supplies - video_game_arcades - video_tape_rental_stores - vocational_trade_schools - watch_jewelry_repair - welding_repair - wholesale_clubs - wig_and_toupee_stores - wires_money_orders - womens_accessory_and_specialty_shops - womens_ready_to_wear_stores - wrecking_and_salvage_yards maxLength: 5000 type: string type: array interval: enum: - all_time - daily - monthly - per_authorization - weekly - yearly type: string required: - amount - interval title: spending_limits_param type: object type: array title: authorization_controls_param type: object status: description: >- Dictates whether authorizations can be approved on this card. May be blocked from activating cards depending on past-due Cardholder requirements. Defaults to `inactive`. If this card is being canceled because it was lost or stolen, this information should be provided as `cancellation_reason`. enum: - active - canceled - inactive type: string x-stripeBypassValidation: true type: object required: false responses: '200': content: application/json: schema: $ref: '#/components/schemas/issuing.card' description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. /v1/issuing/disputes: get: description: >-

Returns a list of Issuing Dispute objects. The objects are sorted in descending order by creation date, with the most recently created object appearing first.

operationId: GetIssuingDisputes parameters: - description: >- Only return Issuing disputes that were created during the given date interval. explode: true in: query name: created required: false schema: anyOf: - properties: gt: type: integer gte: type: integer lt: type: integer lte: type: integer title: range_query_specs type: object - type: integer style: deepObject - description: >- A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. in: query name: ending_before required: false schema: maxLength: 5000 type: string style: form - description: Specifies which fields in the response should be expanded. explode: true in: query name: expand required: false schema: items: maxLength: 5000 type: string type: array style: deepObject - description: >- A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. in: query name: limit required: false schema: type: integer style: form - description: >- A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. in: query name: starting_after required: false schema: maxLength: 5000 type: string style: form - description: Select Issuing disputes with the given status. in: query name: status required: false schema: enum: - expired - lost - submitted - unsubmitted - won type: string style: form - description: Select the Issuing dispute for the given transaction. in: query name: transaction required: false schema: maxLength: 5000 type: string style: form requestBody: content: application/x-www-form-urlencoded: encoding: {} schema: additionalProperties: false properties: {} type: object required: false responses: '200': content: application/json: schema: description: '' properties: data: items: $ref: '#/components/schemas/issuing.dispute' type: array has_more: description: >- True if this list has another page of items after this one that can be fetched. type: boolean object: description: >- String representing the object's type. Objects of the same type share the same value. Always has the value `list`. enum: - list type: string url: description: The URL where this list can be accessed. maxLength: 5000 pattern: ^/v1/issuing/disputes type: string required: - data - has_more - object - url title: IssuingDisputeList type: object x-expandableFields: - data description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. post: description: >-

Creates an Issuing Dispute object. Individual pieces of evidence within the evidence object are optional at this point. Stripe only validates that required evidence is present during submission. Refer to Dispute reasons and evidence for more details about evidence requirements.

operationId: PostIssuingDisputes requestBody: content: application/x-www-form-urlencoded: encoding: evidence: explode: true style: deepObject expand: explode: true style: deepObject metadata: explode: true style: deepObject treasury: explode: true style: deepObject schema: additionalProperties: false properties: amount: description: >- The dispute amount in the card's currency and in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). If not set, defaults to the full transaction amount. type: integer evidence: description: Evidence provided for the dispute. properties: canceled: anyOf: - properties: additional_documentation: anyOf: - type: string - enum: - '' type: string canceled_at: anyOf: - format: unix-time type: integer - enum: - '' type: string cancellation_policy_provided: anyOf: - type: boolean - enum: - '' type: string cancellation_reason: anyOf: - maxLength: 1500 type: string - enum: - '' type: string expected_at: anyOf: - format: unix-time type: integer - enum: - '' type: string explanation: anyOf: - maxLength: 1500 type: string - enum: - '' type: string product_description: anyOf: - maxLength: 1500 type: string - enum: - '' type: string product_type: enum: - '' - merchandise - service type: string return_status: enum: - '' - merchant_rejected - successful type: string returned_at: anyOf: - format: unix-time type: integer - enum: - '' type: string title: canceled type: object - enum: - '' type: string duplicate: anyOf: - properties: additional_documentation: anyOf: - type: string - enum: - '' type: string card_statement: anyOf: - type: string - enum: - '' type: string cash_receipt: anyOf: - type: string - enum: - '' type: string check_image: anyOf: - type: string - enum: - '' type: string explanation: anyOf: - maxLength: 1500 type: string - enum: - '' type: string original_transaction: maxLength: 5000 type: string title: duplicate type: object - enum: - '' type: string fraudulent: anyOf: - properties: additional_documentation: anyOf: - type: string - enum: - '' type: string explanation: anyOf: - maxLength: 1500 type: string - enum: - '' type: string title: fraudulent type: object - enum: - '' type: string merchandise_not_as_described: anyOf: - properties: additional_documentation: anyOf: - type: string - enum: - '' type: string explanation: anyOf: - maxLength: 1500 type: string - enum: - '' type: string received_at: anyOf: - format: unix-time type: integer - enum: - '' type: string return_description: anyOf: - maxLength: 1500 type: string - enum: - '' type: string return_status: enum: - '' - merchant_rejected - successful type: string returned_at: anyOf: - format: unix-time type: integer - enum: - '' type: string title: merchandise_not_as_described type: object - enum: - '' type: string not_received: anyOf: - properties: additional_documentation: anyOf: - type: string - enum: - '' type: string expected_at: anyOf: - format: unix-time type: integer - enum: - '' type: string explanation: anyOf: - maxLength: 1500 type: string - enum: - '' type: string product_description: anyOf: - maxLength: 1500 type: string - enum: - '' type: string product_type: enum: - '' - merchandise - service type: string title: not_received type: object - enum: - '' type: string other: anyOf: - properties: additional_documentation: anyOf: - type: string - enum: - '' type: string explanation: anyOf: - maxLength: 1500 type: string - enum: - '' type: string product_description: anyOf: - maxLength: 1500 type: string - enum: - '' type: string product_type: enum: - '' - merchandise - service type: string title: other type: object - enum: - '' type: string reason: enum: - canceled - duplicate - fraudulent - merchandise_not_as_described - not_received - other - service_not_as_described type: string x-stripeBypassValidation: true service_not_as_described: anyOf: - properties: additional_documentation: anyOf: - type: string - enum: - '' type: string canceled_at: anyOf: - format: unix-time type: integer - enum: - '' type: string cancellation_reason: anyOf: - maxLength: 1500 type: string - enum: - '' type: string explanation: anyOf: - maxLength: 1500 type: string - enum: - '' type: string received_at: anyOf: - format: unix-time type: integer - enum: - '' type: string title: service_not_as_described type: object - enum: - '' type: string title: evidence_param type: object expand: description: Specifies which fields in the response should be expanded. items: maxLength: 5000 type: string type: array metadata: additionalProperties: type: string description: >- Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. type: object transaction: description: >- The ID of the issuing transaction to create a dispute for. For transaction on Treasury FinancialAccounts, use `treasury.received_debit`. maxLength: 5000 type: string treasury: description: Params for disputes related to Treasury FinancialAccounts properties: received_debit: maxLength: 5000 type: string required: - received_debit title: treasury_param type: object type: object required: false responses: '200': content: application/json: schema: $ref: '#/components/schemas/issuing.dispute' description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. '/v1/issuing/disputes/{dispute}': get: description:

Retrieves an Issuing Dispute object.

operationId: GetIssuingDisputesDispute parameters: - in: path name: dispute required: true schema: maxLength: 5000 type: string style: simple - description: Specifies which fields in the response should be expanded. explode: true in: query name: expand required: false schema: items: maxLength: 5000 type: string type: array style: deepObject requestBody: content: application/x-www-form-urlencoded: encoding: {} schema: additionalProperties: false properties: {} type: object required: false responses: '200': content: application/json: schema: $ref: '#/components/schemas/issuing.dispute' description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. post: description: >-

Updates the specified Issuing Dispute object by setting the values of the parameters passed. Any parameters not provided will be left unchanged. Properties on the evidence object can be unset by passing in an empty string.

operationId: PostIssuingDisputesDispute parameters: - in: path name: dispute required: true schema: maxLength: 5000 type: string style: simple requestBody: content: application/x-www-form-urlencoded: encoding: evidence: explode: true style: deepObject expand: explode: true style: deepObject metadata: explode: true style: deepObject schema: additionalProperties: false properties: amount: description: >- The dispute amount in the card's currency and in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). type: integer evidence: description: Evidence provided for the dispute. properties: canceled: anyOf: - properties: additional_documentation: anyOf: - type: string - enum: - '' type: string canceled_at: anyOf: - format: unix-time type: integer - enum: - '' type: string cancellation_policy_provided: anyOf: - type: boolean - enum: - '' type: string cancellation_reason: anyOf: - maxLength: 1500 type: string - enum: - '' type: string expected_at: anyOf: - format: unix-time type: integer - enum: - '' type: string explanation: anyOf: - maxLength: 1500 type: string - enum: - '' type: string product_description: anyOf: - maxLength: 1500 type: string - enum: - '' type: string product_type: enum: - '' - merchandise - service type: string return_status: enum: - '' - merchant_rejected - successful type: string returned_at: anyOf: - format: unix-time type: integer - enum: - '' type: string title: canceled type: object - enum: - '' type: string duplicate: anyOf: - properties: additional_documentation: anyOf: - type: string - enum: - '' type: string card_statement: anyOf: - type: string - enum: - '' type: string cash_receipt: anyOf: - type: string - enum: - '' type: string check_image: anyOf: - type: string - enum: - '' type: string explanation: anyOf: - maxLength: 1500 type: string - enum: - '' type: string original_transaction: maxLength: 5000 type: string title: duplicate type: object - enum: - '' type: string fraudulent: anyOf: - properties: additional_documentation: anyOf: - type: string - enum: - '' type: string explanation: anyOf: - maxLength: 1500 type: string - enum: - '' type: string title: fraudulent type: object - enum: - '' type: string merchandise_not_as_described: anyOf: - properties: additional_documentation: anyOf: - type: string - enum: - '' type: string explanation: anyOf: - maxLength: 1500 type: string - enum: - '' type: string received_at: anyOf: - format: unix-time type: integer - enum: - '' type: string return_description: anyOf: - maxLength: 1500 type: string - enum: - '' type: string return_status: enum: - '' - merchant_rejected - successful type: string returned_at: anyOf: - format: unix-time type: integer - enum: - '' type: string title: merchandise_not_as_described type: object - enum: - '' type: string not_received: anyOf: - properties: additional_documentation: anyOf: - type: string - enum: - '' type: string expected_at: anyOf: - format: unix-time type: integer - enum: - '' type: string explanation: anyOf: - maxLength: 1500 type: string - enum: - '' type: string product_description: anyOf: - maxLength: 1500 type: string - enum: - '' type: string product_type: enum: - '' - merchandise - service type: string title: not_received type: object - enum: - '' type: string other: anyOf: - properties: additional_documentation: anyOf: - type: string - enum: - '' type: string explanation: anyOf: - maxLength: 1500 type: string - enum: - '' type: string product_description: anyOf: - maxLength: 1500 type: string - enum: - '' type: string product_type: enum: - '' - merchandise - service type: string title: other type: object - enum: - '' type: string reason: enum: - canceled - duplicate - fraudulent - merchandise_not_as_described - not_received - other - service_not_as_described type: string x-stripeBypassValidation: true service_not_as_described: anyOf: - properties: additional_documentation: anyOf: - type: string - enum: - '' type: string canceled_at: anyOf: - format: unix-time type: integer - enum: - '' type: string cancellation_reason: anyOf: - maxLength: 1500 type: string - enum: - '' type: string explanation: anyOf: - maxLength: 1500 type: string - enum: - '' type: string received_at: anyOf: - format: unix-time type: integer - enum: - '' type: string title: service_not_as_described type: object - enum: - '' type: string title: evidence_param type: object expand: description: Specifies which fields in the response should be expanded. items: maxLength: 5000 type: string type: array metadata: anyOf: - additionalProperties: type: string type: object - enum: - '' type: string description: >- Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. type: object required: false responses: '200': content: application/json: schema: $ref: '#/components/schemas/issuing.dispute' description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. '/v1/issuing/disputes/{dispute}/submit': post: description: >-

Submits an Issuing Dispute to the card network. Stripe validates that all evidence fields required for the dispute’s reason are present. For more details, see Dispute reasons and evidence.

operationId: PostIssuingDisputesDisputeSubmit parameters: - in: path name: dispute required: true schema: maxLength: 5000 type: string style: simple requestBody: content: application/x-www-form-urlencoded: encoding: expand: explode: true style: deepObject metadata: explode: true style: deepObject schema: additionalProperties: false properties: expand: description: Specifies which fields in the response should be expanded. items: maxLength: 5000 type: string type: array metadata: anyOf: - additionalProperties: type: string type: object - enum: - '' type: string description: >- Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. type: object required: false responses: '200': content: application/json: schema: $ref: '#/components/schemas/issuing.dispute' description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. /v1/issuing/personalization_designs: get: description: >-

Returns a list of personalization design objects. The objects are sorted in descending order by creation date, with the most recently created object appearing first.

operationId: GetIssuingPersonalizationDesigns parameters: - description: >- A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. in: query name: ending_before required: false schema: maxLength: 5000 type: string style: form - description: Specifies which fields in the response should be expanded. explode: true in: query name: expand required: false schema: items: maxLength: 5000 type: string type: array style: deepObject - description: >- A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. in: query name: limit required: false schema: type: integer style: form - description: Only return personalization designs with the given lookup keys. explode: true in: query name: lookup_keys required: false schema: items: maxLength: 200 type: string type: array style: deepObject - description: Only return personalization designs with the given preferences. explode: true in: query name: preferences required: false schema: properties: is_default: type: boolean is_platform_default: type: boolean title: preferences_list_param type: object style: deepObject - description: >- A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. in: query name: starting_after required: false schema: maxLength: 5000 type: string style: form - description: Only return personalization designs with the given status. in: query name: status required: false schema: enum: - active - inactive - rejected - review type: string style: form requestBody: content: application/x-www-form-urlencoded: encoding: {} schema: additionalProperties: false properties: {} type: object required: false responses: '200': content: application/json: schema: description: '' properties: data: items: $ref: '#/components/schemas/issuing.personalization_design' type: array has_more: description: >- True if this list has another page of items after this one that can be fetched. type: boolean object: description: >- String representing the object's type. Objects of the same type share the same value. Always has the value `list`. enum: - list type: string url: description: The URL where this list can be accessed. maxLength: 5000 pattern: ^/v1/issuing/personalization_designs type: string required: - data - has_more - object - url title: IssuingPersonalizationDesignList type: object x-expandableFields: - data description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. post: description:

Creates a personalization design object.

operationId: PostIssuingPersonalizationDesigns requestBody: content: application/x-www-form-urlencoded: encoding: carrier_text: explode: true style: deepObject expand: explode: true style: deepObject metadata: explode: true style: deepObject preferences: explode: true style: deepObject schema: additionalProperties: false properties: card_logo: description: >- The file for the card logo, for use with physical bundles that support card logos. Must have a `purpose` value of `issuing_logo`. type: string carrier_text: description: >- Hash containing carrier text, for use with physical bundles that support carrier text. properties: footer_body: anyOf: - maxLength: 200 type: string - enum: - '' type: string footer_title: anyOf: - maxLength: 30 type: string - enum: - '' type: string header_body: anyOf: - maxLength: 200 type: string - enum: - '' type: string header_title: anyOf: - maxLength: 30 type: string - enum: - '' type: string title: carrier_text_param type: object expand: description: Specifies which fields in the response should be expanded. items: maxLength: 5000 type: string type: array lookup_key: description: >- A lookup key used to retrieve personalization designs dynamically from a static string. This may be up to 200 characters. maxLength: 200 type: string metadata: additionalProperties: type: string description: >- Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. type: object name: description: Friendly display name. maxLength: 200 type: string physical_bundle: description: >- The physical bundle object belonging to this personalization design. maxLength: 5000 type: string preferences: description: >- Information on whether this personalization design is used to create cards when one is not specified. properties: is_default: type: boolean required: - is_default title: preferences_param type: object transfer_lookup_key: description: >- If set to true, will atomically remove the lookup key from the existing personalization design, and assign it to this personalization design. type: boolean required: - physical_bundle type: object required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/issuing.personalization_design' description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. '/v1/issuing/personalization_designs/{personalization_design}': get: description:

Retrieves a personalization design object.

operationId: GetIssuingPersonalizationDesignsPersonalizationDesign parameters: - description: Specifies which fields in the response should be expanded. explode: true in: query name: expand required: false schema: items: maxLength: 5000 type: string type: array style: deepObject - in: path name: personalization_design required: true schema: maxLength: 5000 type: string style: simple requestBody: content: application/x-www-form-urlencoded: encoding: {} schema: additionalProperties: false properties: {} type: object required: false responses: '200': content: application/json: schema: $ref: '#/components/schemas/issuing.personalization_design' description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. post: description:

Updates a card personalization object.

operationId: PostIssuingPersonalizationDesignsPersonalizationDesign parameters: - in: path name: personalization_design required: true schema: maxLength: 5000 type: string style: simple requestBody: content: application/x-www-form-urlencoded: encoding: card_logo: explode: true style: deepObject carrier_text: explode: true style: deepObject expand: explode: true style: deepObject lookup_key: explode: true style: deepObject metadata: explode: true style: deepObject name: explode: true style: deepObject preferences: explode: true style: deepObject schema: additionalProperties: false properties: card_logo: anyOf: - type: string - enum: - '' type: string description: >- The file for the card logo, for use with physical bundles that support card logos. Must have a `purpose` value of `issuing_logo`. carrier_text: anyOf: - properties: footer_body: anyOf: - maxLength: 200 type: string - enum: - '' type: string footer_title: anyOf: - maxLength: 30 type: string - enum: - '' type: string header_body: anyOf: - maxLength: 200 type: string - enum: - '' type: string header_title: anyOf: - maxLength: 30 type: string - enum: - '' type: string title: carrier_text_param type: object - enum: - '' type: string description: >- Hash containing carrier text, for use with physical bundles that support carrier text. expand: description: Specifies which fields in the response should be expanded. items: maxLength: 5000 type: string type: array lookup_key: anyOf: - maxLength: 200 type: string - enum: - '' type: string description: >- A lookup key used to retrieve personalization designs dynamically from a static string. This may be up to 200 characters. metadata: additionalProperties: type: string description: >- Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. type: object name: anyOf: - maxLength: 200 type: string - enum: - '' type: string description: >- Friendly display name. Providing an empty string will set the field to null. physical_bundle: description: >- The physical bundle object belonging to this personalization design. maxLength: 5000 type: string preferences: description: >- Information on whether this personalization design is used to create cards when one is not specified. properties: is_default: type: boolean required: - is_default title: preferences_param type: object transfer_lookup_key: description: >- If set to true, will atomically remove the lookup key from the existing personalization design, and assign it to this personalization design. type: boolean type: object required: false responses: '200': content: application/json: schema: $ref: '#/components/schemas/issuing.personalization_design' description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. /v1/issuing/physical_bundles: get: description: >-

Returns a list of physical bundle objects. The objects are sorted in descending order by creation date, with the most recently created object appearing first.

operationId: GetIssuingPhysicalBundles parameters: - description: >- A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. in: query name: ending_before required: false schema: maxLength: 5000 type: string style: form - description: Specifies which fields in the response should be expanded. explode: true in: query name: expand required: false schema: items: maxLength: 5000 type: string type: array style: deepObject - description: >- A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. in: query name: limit required: false schema: type: integer style: form - description: >- A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. in: query name: starting_after required: false schema: maxLength: 5000 type: string style: form - description: Only return physical bundles with the given status. in: query name: status required: false schema: enum: - active - inactive - review type: string style: form - description: Only return physical bundles with the given type. in: query name: type required: false schema: enum: - custom - standard type: string style: form requestBody: content: application/x-www-form-urlencoded: encoding: {} schema: additionalProperties: false properties: {} type: object required: false responses: '200': content: application/json: schema: description: '' properties: data: items: $ref: '#/components/schemas/issuing.physical_bundle' type: array has_more: description: >- True if this list has another page of items after this one that can be fetched. type: boolean object: description: >- String representing the object's type. Objects of the same type share the same value. Always has the value `list`. enum: - list type: string url: description: The URL where this list can be accessed. maxLength: 5000 pattern: ^/v1/issuing/physical_bundles type: string required: - data - has_more - object - url title: IssuingPhysicalBundleList type: object x-expandableFields: - data description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. '/v1/issuing/physical_bundles/{physical_bundle}': get: description:

Retrieves a physical bundle object.

operationId: GetIssuingPhysicalBundlesPhysicalBundle parameters: - description: Specifies which fields in the response should be expanded. explode: true in: query name: expand required: false schema: items: maxLength: 5000 type: string type: array style: deepObject - in: path name: physical_bundle required: true schema: maxLength: 5000 type: string style: simple requestBody: content: application/x-www-form-urlencoded: encoding: {} schema: additionalProperties: false properties: {} type: object required: false responses: '200': content: application/json: schema: $ref: '#/components/schemas/issuing.physical_bundle' description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. /v1/issuing/settlements: get: description: >-

Returns a list of Issuing Settlement objects. The objects are sorted in descending order by creation date, with the most recently created object appearing first.

operationId: GetIssuingSettlements parameters: - description: >- Only return issuing settlements that were created during the given date interval. explode: true in: query name: created required: false schema: anyOf: - properties: gt: type: integer gte: type: integer lt: type: integer lte: type: integer title: range_query_specs type: object - type: integer style: deepObject - description: >- A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. in: query name: ending_before required: false schema: maxLength: 5000 type: string style: form - description: Specifies which fields in the response should be expanded. explode: true in: query name: expand required: false schema: items: maxLength: 5000 type: string type: array style: deepObject - description: >- A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. in: query name: limit required: false schema: type: integer style: form - description: >- A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. in: query name: starting_after required: false schema: maxLength: 5000 type: string style: form requestBody: content: application/x-www-form-urlencoded: encoding: {} schema: additionalProperties: false properties: {} type: object required: false responses: '200': content: application/json: schema: description: '' properties: data: items: $ref: '#/components/schemas/issuing.settlement' type: array has_more: description: >- True if this list has another page of items after this one that can be fetched. type: boolean object: description: >- String representing the object's type. Objects of the same type share the same value. Always has the value `list`. enum: - list type: string url: description: The URL where this list can be accessed. maxLength: 5000 pattern: ^/v1/issuing/settlements type: string required: - data - has_more - object - url title: IssuingSettlementList type: object x-expandableFields: - data description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. '/v1/issuing/settlements/{settlement}': get: description:

Retrieves an Issuing Settlement object.

operationId: GetIssuingSettlementsSettlement parameters: - description: Specifies which fields in the response should be expanded. explode: true in: query name: expand required: false schema: items: maxLength: 5000 type: string type: array style: deepObject - in: path name: settlement required: true schema: maxLength: 5000 type: string style: simple requestBody: content: application/x-www-form-urlencoded: encoding: {} schema: additionalProperties: false properties: {} type: object required: false responses: '200': content: application/json: schema: $ref: '#/components/schemas/issuing.settlement' description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. post: description: >-

Updates the specified Issuing Settlement object by setting the values of the parameters passed. Any parameters not provided will be left unchanged.

operationId: PostIssuingSettlementsSettlement parameters: - in: path name: settlement required: true schema: maxLength: 5000 type: string style: simple requestBody: content: application/x-www-form-urlencoded: encoding: expand: explode: true style: deepObject metadata: explode: true style: deepObject schema: additionalProperties: false properties: expand: description: Specifies which fields in the response should be expanded. items: maxLength: 5000 type: string type: array metadata: additionalProperties: type: string description: >- Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. type: object type: object required: false responses: '200': content: application/json: schema: $ref: '#/components/schemas/issuing.settlement' description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. /v1/issuing/tokens: get: description:

Lists all Issuing Token objects for a given card.

operationId: GetIssuingTokens parameters: - description: The Issuing card identifier to list tokens for. in: query name: card required: true schema: maxLength: 5000 type: string style: form - description: >- Only return Issuing tokens that were created during the given date interval. explode: true in: query name: created required: false schema: anyOf: - properties: gt: type: integer gte: type: integer lt: type: integer lte: type: integer title: range_query_specs type: object - type: integer style: deepObject - description: >- A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. in: query name: ending_before required: false schema: maxLength: 5000 type: string style: form - description: Specifies which fields in the response should be expanded. explode: true in: query name: expand required: false schema: items: maxLength: 5000 type: string type: array style: deepObject - description: >- A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. in: query name: limit required: false schema: type: integer style: form - description: >- A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. in: query name: starting_after required: false schema: maxLength: 5000 type: string style: form - description: Select Issuing tokens with the given status. in: query name: status required: false schema: enum: - active - deleted - requested - suspended type: string style: form requestBody: content: application/x-www-form-urlencoded: encoding: {} schema: additionalProperties: false properties: {} type: object required: false responses: '200': content: application/json: schema: description: '' properties: data: items: $ref: '#/components/schemas/issuing.token' type: array has_more: description: >- True if this list has another page of items after this one that can be fetched. type: boolean object: description: >- String representing the object's type. Objects of the same type share the same value. Always has the value `list`. enum: - list type: string url: description: The URL where this list can be accessed. maxLength: 5000 type: string required: - data - has_more - object - url title: IssuingNetworkTokenList type: object x-expandableFields: - data description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. '/v1/issuing/tokens/{token}': get: description:

Retrieves an Issuing Token object.

operationId: GetIssuingTokensToken parameters: - description: Specifies which fields in the response should be expanded. explode: true in: query name: expand required: false schema: items: maxLength: 5000 type: string type: array style: deepObject - in: path name: token required: true schema: maxLength: 5000 type: string style: simple requestBody: content: application/x-www-form-urlencoded: encoding: {} schema: additionalProperties: false properties: {} type: object required: false responses: '200': content: application/json: schema: $ref: '#/components/schemas/issuing.token' description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. post: description: >-

Attempts to update the specified Issuing Token object to the status specified.

operationId: PostIssuingTokensToken parameters: - in: path name: token required: true schema: maxLength: 5000 type: string style: simple requestBody: content: application/x-www-form-urlencoded: encoding: expand: explode: true style: deepObject schema: additionalProperties: false properties: expand: description: Specifies which fields in the response should be expanded. items: maxLength: 5000 type: string type: array status: description: Specifies which status the token should be updated to. enum: - active - deleted - suspended type: string required: - status type: object required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/issuing.token' description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. /v1/issuing/transactions: get: description: >-

Returns a list of Issuing Transaction objects. The objects are sorted in descending order by creation date, with the most recently created object appearing first.

operationId: GetIssuingTransactions parameters: - description: Only return transactions that belong to the given card. in: query name: card required: false schema: maxLength: 5000 type: string style: form - description: Only return transactions that belong to the given cardholder. in: query name: cardholder required: false schema: maxLength: 5000 type: string style: form - description: >- Only return transactions that were created during the given date interval. explode: true in: query name: created required: false schema: anyOf: - properties: gt: type: integer gte: type: integer lt: type: integer lte: type: integer title: range_query_specs type: object - type: integer style: deepObject - description: >- A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. in: query name: ending_before required: false schema: maxLength: 5000 type: string style: form - description: Specifies which fields in the response should be expanded. explode: true in: query name: expand required: false schema: items: maxLength: 5000 type: string type: array style: deepObject - description: >- A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. in: query name: limit required: false schema: type: integer style: form - description: >- A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. in: query name: starting_after required: false schema: maxLength: 5000 type: string style: form - description: >- Only return transactions that have the given type. One of `capture` or `refund`. in: query name: type required: false schema: enum: - capture - refund type: string style: form requestBody: content: application/x-www-form-urlencoded: encoding: {} schema: additionalProperties: false properties: {} type: object required: false responses: '200': content: application/json: schema: description: '' properties: data: items: $ref: '#/components/schemas/issuing.transaction' type: array has_more: description: >- True if this list has another page of items after this one that can be fetched. type: boolean object: description: >- String representing the object's type. Objects of the same type share the same value. Always has the value `list`. enum: - list type: string url: description: The URL where this list can be accessed. maxLength: 5000 pattern: ^/v1/issuing/transactions type: string required: - data - has_more - object - url title: IssuingTransactionList type: object x-expandableFields: - data description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. '/v1/issuing/transactions/{transaction}': get: description:

Retrieves an Issuing Transaction object.

operationId: GetIssuingTransactionsTransaction parameters: - description: Specifies which fields in the response should be expanded. explode: true in: query name: expand required: false schema: items: maxLength: 5000 type: string type: array style: deepObject - in: path name: transaction required: true schema: maxLength: 5000 type: string style: simple requestBody: content: application/x-www-form-urlencoded: encoding: {} schema: additionalProperties: false properties: {} type: object required: false responses: '200': content: application/json: schema: $ref: '#/components/schemas/issuing.transaction' description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. post: description: >-

Updates the specified Issuing Transaction object by setting the values of the parameters passed. Any parameters not provided will be left unchanged.

operationId: PostIssuingTransactionsTransaction parameters: - in: path name: transaction required: true schema: maxLength: 5000 type: string style: simple requestBody: content: application/x-www-form-urlencoded: encoding: expand: explode: true style: deepObject metadata: explode: true style: deepObject schema: additionalProperties: false properties: expand: description: Specifies which fields in the response should be expanded. items: maxLength: 5000 type: string type: array metadata: anyOf: - additionalProperties: type: string type: object - enum: - '' type: string description: >- Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. type: object required: false responses: '200': content: application/json: schema: $ref: '#/components/schemas/issuing.transaction' description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. /v1/link_account_sessions: post: description: >-

To launch the Financial Connections authorization flow, create a Session. The session’s client_secret can be used to launch the flow using Stripe.js.

operationId: PostLinkAccountSessions requestBody: content: application/x-www-form-urlencoded: encoding: account_holder: explode: true style: deepObject expand: explode: true style: deepObject filters: explode: true style: deepObject permissions: explode: true style: deepObject prefetch: explode: true style: deepObject schema: additionalProperties: false properties: account_holder: description: The account holder to link accounts for. properties: account: maxLength: 5000 type: string customer: maxLength: 5000 type: string type: enum: - account - customer type: string required: - type title: accountholder_params type: object expand: description: Specifies which fields in the response should be expanded. items: maxLength: 5000 type: string type: array filters: description: Filters to restrict the kinds of accounts to collect. properties: countries: items: maxLength: 5000 type: string type: array required: - countries title: filters_params type: object permissions: description: >- List of data features that you would like to request access to. Possible values are `balances`, `transactions`, `ownership`, and `payment_method`. items: enum: - balances - ownership - payment_method - transactions maxLength: 5000 type: string x-stripeBypassValidation: true type: array prefetch: description: >- List of data features that you would like to retrieve upon account creation. items: enum: - balances - ownership - transactions type: string x-stripeBypassValidation: true type: array return_url: description: >- For webview integrations only. Upon completing OAuth login in the native browser, the user will be redirected to this URL to return to your app. maxLength: 5000 type: string required: - account_holder - permissions type: object required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/financial_connections.session' description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. '/v1/link_account_sessions/{session}': get: description: >-

Retrieves the details of a Financial Connections Session

operationId: GetLinkAccountSessionsSession parameters: - description: Specifies which fields in the response should be expanded. explode: true in: query name: expand required: false schema: items: maxLength: 5000 type: string type: array style: deepObject - in: path name: session required: true schema: maxLength: 5000 type: string style: simple requestBody: content: application/x-www-form-urlencoded: encoding: {} schema: additionalProperties: false properties: {} type: object required: false responses: '200': content: application/json: schema: $ref: '#/components/schemas/financial_connections.session' description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. /v1/linked_accounts: get: description: >-

Returns a list of Financial Connections Account objects.

operationId: GetLinkedAccounts parameters: - description: >- If present, only return accounts that belong to the specified account holder. `account_holder[customer]` and `account_holder[account]` are mutually exclusive. explode: true in: query name: account_holder required: false schema: properties: account: maxLength: 5000 type: string customer: maxLength: 5000 type: string title: accountholder_params type: object style: deepObject - description: >- A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. in: query name: ending_before required: false schema: maxLength: 5000 type: string style: form - description: Specifies which fields in the response should be expanded. explode: true in: query name: expand required: false schema: items: maxLength: 5000 type: string type: array style: deepObject - description: >- A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. in: query name: limit required: false schema: type: integer style: form - description: >- If present, only return accounts that were collected as part of the given session. in: query name: session required: false schema: maxLength: 5000 type: string style: form - description: >- A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. in: query name: starting_after required: false schema: maxLength: 5000 type: string style: form requestBody: content: application/x-www-form-urlencoded: encoding: {} schema: additionalProperties: false properties: {} type: object required: false responses: '200': content: application/json: schema: description: '' properties: data: description: Details about each object. items: $ref: '#/components/schemas/financial_connections.account' type: array has_more: description: >- True if this list has another page of items after this one that can be fetched. type: boolean object: description: >- String representing the object's type. Objects of the same type share the same value. Always has the value `list`. enum: - list type: string url: description: The URL where this list can be accessed. maxLength: 5000 pattern: ^/v1/financial_connections/accounts type: string required: - data - has_more - object - url title: BankConnectionsResourceLinkedAccountList type: object x-expandableFields: - data description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. '/v1/linked_accounts/{account}': get: description: >-

Retrieves the details of an Financial Connections Account.

operationId: GetLinkedAccountsAccount parameters: - in: path name: account required: true schema: maxLength: 5000 type: string style: simple - description: Specifies which fields in the response should be expanded. explode: true in: query name: expand required: false schema: items: maxLength: 5000 type: string type: array style: deepObject requestBody: content: application/x-www-form-urlencoded: encoding: {} schema: additionalProperties: false properties: {} type: object required: false responses: '200': content: application/json: schema: $ref: '#/components/schemas/financial_connections.account' description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. '/v1/linked_accounts/{account}/disconnect': post: description: >-

Disables your access to a Financial Connections Account. You will no longer be able to access data associated with the account (e.g. balances, transactions).

operationId: PostLinkedAccountsAccountDisconnect parameters: - in: path name: account required: true schema: maxLength: 5000 type: string style: simple requestBody: content: application/x-www-form-urlencoded: encoding: expand: explode: true style: deepObject schema: additionalProperties: false properties: expand: description: Specifies which fields in the response should be expanded. items: maxLength: 5000 type: string type: array type: object required: false responses: '200': content: application/json: schema: $ref: '#/components/schemas/financial_connections.account' description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. '/v1/linked_accounts/{account}/owners': get: description:

Lists all owners for a given Account

operationId: GetLinkedAccountsAccountOwners parameters: - in: path name: account required: true schema: maxLength: 5000 type: string style: simple - description: >- A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. in: query name: ending_before required: false schema: maxLength: 5000 type: string style: form - description: Specifies which fields in the response should be expanded. explode: true in: query name: expand required: false schema: items: maxLength: 5000 type: string type: array style: deepObject - description: >- A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. in: query name: limit required: false schema: type: integer style: form - description: The ID of the ownership object to fetch owners from. in: query name: ownership required: true schema: maxLength: 5000 type: string style: form - description: >- A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. in: query name: starting_after required: false schema: maxLength: 5000 type: string style: form requestBody: content: application/x-www-form-urlencoded: encoding: {} schema: additionalProperties: false properties: {} type: object required: false responses: '200': content: application/json: schema: description: '' properties: data: description: Details about each object. items: $ref: '#/components/schemas/financial_connections.account_owner' type: array has_more: description: >- True if this list has another page of items after this one that can be fetched. type: boolean object: description: >- String representing the object's type. Objects of the same type share the same value. Always has the value `list`. enum: - list type: string url: description: The URL where this list can be accessed. maxLength: 5000 type: string required: - data - has_more - object - url title: BankConnectionsResourceOwnerList type: object x-expandableFields: - data description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. '/v1/linked_accounts/{account}/refresh': post: description: >-

Refreshes the data associated with a Financial Connections Account.

operationId: PostLinkedAccountsAccountRefresh parameters: - in: path name: account required: true schema: maxLength: 5000 type: string style: simple requestBody: content: application/x-www-form-urlencoded: encoding: expand: explode: true style: deepObject features: explode: true style: deepObject schema: additionalProperties: false properties: expand: description: Specifies which fields in the response should be expanded. items: maxLength: 5000 type: string type: array features: description: The list of account features that you would like to refresh. items: enum: - balance - ownership - transactions type: string x-stripeBypassValidation: true type: array required: - features type: object required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/financial_connections.account' description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. '/v1/mandates/{mandate}': get: description:

Retrieves a Mandate object.

operationId: GetMandatesMandate parameters: - description: Specifies which fields in the response should be expanded. explode: true in: query name: expand required: false schema: items: maxLength: 5000 type: string type: array style: deepObject - in: path name: mandate required: true schema: type: string style: simple requestBody: content: application/x-www-form-urlencoded: encoding: {} schema: additionalProperties: false properties: {} type: object required: false responses: '200': content: application/json: schema: $ref: '#/components/schemas/mandate' description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. /v1/payment_intents: get: description:

Returns a list of PaymentIntents.

operationId: GetPaymentIntents parameters: - description: >- A filter on the list, based on the object `created` field. The value can be a string with an integer Unix timestamp or a dictionary with a number of different query options. explode: true in: query name: created required: false schema: anyOf: - properties: gt: type: integer gte: type: integer lt: type: integer lte: type: integer title: range_query_specs type: object - type: integer style: deepObject - description: >- Only return PaymentIntents for the customer that this customer ID specifies. in: query name: customer required: false schema: maxLength: 5000 type: string style: form - description: >- A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. in: query name: ending_before required: false schema: maxLength: 5000 type: string style: form - description: Specifies which fields in the response should be expanded. explode: true in: query name: expand required: false schema: items: maxLength: 5000 type: string type: array style: deepObject - description: >- A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. in: query name: limit required: false schema: type: integer style: form - description: >- A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. in: query name: starting_after required: false schema: maxLength: 5000 type: string style: form requestBody: content: application/x-www-form-urlencoded: encoding: {} schema: additionalProperties: false properties: {} type: object required: false responses: '200': content: application/json: schema: description: '' properties: data: items: $ref: '#/components/schemas/payment_intent' type: array has_more: description: >- True if this list has another page of items after this one that can be fetched. type: boolean object: description: >- String representing the object's type. Objects of the same type share the same value. Always has the value `list`. enum: - list type: string url: description: The URL where this list can be accessed. maxLength: 5000 pattern: ^/v1/payment_intents type: string required: - data - has_more - object - url title: PaymentFlowsPaymentIntentList type: object x-expandableFields: - data description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. post: description: >-

Creates a PaymentIntent object.

After the PaymentIntent is created, attach a payment method and confirm to continue the payment. Learn more about the available payment flows with the Payment Intents API.

When you use confirm=true during creation, it’s equivalent to creating and confirming the PaymentIntent in the same call. You can use any parameters available in the confirm API when you supply confirm=true.

operationId: PostPaymentIntents requestBody: content: application/x-www-form-urlencoded: encoding: automatic_payment_methods: explode: true style: deepObject expand: explode: true style: deepObject mandate_data: explode: true style: deepObject metadata: explode: true style: deepObject off_session: explode: true style: deepObject payment_method_data: explode: true style: deepObject payment_method_options: explode: true style: deepObject payment_method_types: explode: true style: deepObject radar_options: explode: true style: deepObject shipping: explode: true style: deepObject transfer_data: explode: true style: deepObject schema: additionalProperties: false properties: amount: description: >- 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). type: integer application_fee_amount: description: >- 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). type: integer automatic_payment_methods: description: >- When you enable this parameter, this PaymentIntent accepts payment methods that you enable in the Dashboard and that are compatible with this PaymentIntent's other parameters. properties: allow_redirects: enum: - always - never type: string enabled: type: boolean required: - enabled title: automatic_payment_methods_param type: object capture_method: description: >- Controls when the funds will be captured from the customer's account. enum: - automatic - automatic_async - manual type: string confirm: description: >- Set to `true` to attempt to [confirm this PaymentIntent](https://stripe.com/docs/api/payment_intents/confirm) immediately. This parameter defaults to `false`. When creating and confirming a PaymentIntent at the same time, you can also provide the parameters available in the [Confirm API](https://stripe.com/docs/api/payment_intents/confirm). type: boolean confirmation_method: description: >- Describes whether we can confirm this PaymentIntent automatically, or if it requires customer action to confirm the payment. enum: - automatic - manual type: string confirmation_token: description: >- ID of the ConfirmationToken used to confirm this PaymentIntent. If the provided ConfirmationToken contains properties that are also being provided in this request, such as `payment_method`, then the values in this request will take precedence. maxLength: 5000 type: string currency: description: >- 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). type: string customer: description: >- ID of the Customer this PaymentIntent belongs to, if one exists. Payment methods attached to other Customers cannot be used with this PaymentIntent. If present in combination with [setup_future_usage](https://stripe.com/docs/api#payment_intent_object-setup_future_usage), this PaymentIntent's payment method will be attached to the Customer after the PaymentIntent has been confirmed and any required actions from the user are complete. maxLength: 5000 type: string description: description: >- An arbitrary string attached to the object. Often useful for displaying to users. maxLength: 1000 type: string error_on_requires_action: description: >- Set to `true` to fail the payment attempt if the PaymentIntent transitions into `requires_action`. Use this parameter for simpler integrations that don't handle customer actions, such as [saving cards without authentication](https://stripe.com/docs/payments/save-card-without-authentication). This parameter can only be used with [`confirm=true`](https://stripe.com/docs/api/payment_intents/create#create_payment_intent-confirm). type: boolean expand: description: Specifies which fields in the response should be expanded. items: maxLength: 5000 type: string type: array mandate: description: >- ID of the mandate that's used for this payment. This parameter can only be used with [`confirm=true`](https://stripe.com/docs/api/payment_intents/create#create_payment_intent-confirm). maxLength: 5000 type: string mandate_data: anyOf: - properties: customer_acceptance: properties: accepted_at: format: unix-time type: integer offline: properties: {} title: offline_param type: object online: properties: ip_address: type: string user_agent: maxLength: 5000 type: string required: - ip_address - user_agent title: online_param type: object type: enum: - offline - online maxLength: 5000 type: string required: - type title: customer_acceptance_param type: object required: - customer_acceptance title: secret_key_param type: object - enum: - '' type: string description: >- This hash contains details about the Mandate to create. This parameter can only be used with [`confirm=true`](https://stripe.com/docs/api/payment_intents/create#create_payment_intent-confirm). metadata: additionalProperties: type: string description: >- Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. type: object off_session: anyOf: - type: boolean - enum: - one_off - recurring maxLength: 5000 type: string description: >- Set to `true` to indicate that the customer isn't in your checkout flow during this payment attempt and can't authenticate. Use this parameter in scenarios where you collect card details and [charge them later](https://stripe.com/docs/payments/cards/charging-saved-cards). This parameter can only be used with [`confirm=true`](https://stripe.com/docs/api/payment_intents/create#create_payment_intent-confirm). on_behalf_of: description: >- The Stripe account ID that these funds are intended for. Learn more about the [use case for connected accounts](https://stripe.com/docs/payments/connected-accounts). type: string payment_method: description: >- ID of the payment method (a PaymentMethod, Card, or [compatible Source](https://stripe.com/docs/payments/payment-methods/transitioning#compatibility) object) to attach to this PaymentIntent. If you omit this parameter with `confirm=true`, `customer.default_source` attaches as this PaymentIntent's payment instrument to improve migration for users of the Charges API. We recommend that you explicitly provide the `payment_method` moving forward. maxLength: 5000 type: string payment_method_configuration: description: >- The ID of the payment method configuration to use with this PaymentIntent. maxLength: 100 type: string payment_method_data: description: >- If provided, this hash will be used to create a PaymentMethod. The new PaymentMethod will appear in the [payment_method](https://stripe.com/docs/api/payment_intents/object#payment_intent_object-payment_method) property on the PaymentIntent. properties: acss_debit: properties: account_number: maxLength: 5000 type: string institution_number: maxLength: 5000 type: string transit_number: maxLength: 5000 type: string required: - account_number - institution_number - transit_number title: payment_method_param type: object affirm: properties: {} title: param type: object afterpay_clearpay: properties: {} title: param type: object alipay: properties: {} title: param type: object allow_redisplay: enum: - always - limited - unspecified type: string amazon_pay: properties: {} title: param type: object au_becs_debit: properties: account_number: maxLength: 5000 type: string bsb_number: maxLength: 5000 type: string required: - account_number - bsb_number title: param type: object bacs_debit: properties: account_number: maxLength: 5000 type: string sort_code: maxLength: 5000 type: string title: param type: object bancontact: properties: {} title: param type: object billing_details: properties: address: anyOf: - properties: city: maxLength: 5000 type: string country: maxLength: 5000 type: string line1: maxLength: 5000 type: string line2: maxLength: 5000 type: string postal_code: maxLength: 5000 type: string state: maxLength: 5000 type: string title: billing_details_address type: object - enum: - '' type: string email: anyOf: - type: string - enum: - '' type: string name: anyOf: - maxLength: 5000 type: string - enum: - '' type: string phone: anyOf: - maxLength: 5000 type: string - enum: - '' type: string title: billing_details_inner_params type: object blik: properties: {} title: param type: object boleto: properties: tax_id: maxLength: 5000 type: string required: - tax_id title: param type: object cashapp: properties: {} title: param type: object customer_balance: properties: {} title: param type: object eps: properties: bank: enum: - 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 maxLength: 5000 type: string title: param type: object fpx: properties: bank: enum: - 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 maxLength: 5000 type: string x-stripeBypassValidation: true required: - bank title: param type: object giropay: properties: {} title: param type: object grabpay: properties: {} title: param type: object ideal: properties: bank: enum: - abn_amro - asn_bank - bunq - handelsbanken - ing - knab - moneyou - n26 - nn - rabobank - regiobank - revolut - sns_bank - triodos_bank - van_lanschot - yoursafe maxLength: 5000 type: string title: param type: object interac_present: properties: {} title: param type: object klarna: properties: dob: properties: day: type: integer month: type: integer year: type: integer required: - day - month - year title: date_of_birth type: object title: param type: object konbini: properties: {} title: param type: object link: properties: {} title: param type: object metadata: additionalProperties: type: string type: object mobilepay: properties: {} title: param type: object oxxo: properties: {} title: param type: object p24: properties: bank: enum: - 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 type: string x-stripeBypassValidation: true title: param type: object paynow: properties: {} title: param type: object paypal: properties: {} title: param type: object pix: properties: {} title: param type: object promptpay: properties: {} title: param type: object radar_options: properties: session: maxLength: 5000 type: string title: radar_options_with_hidden_options type: object revolut_pay: properties: {} title: param type: object sepa_debit: properties: iban: maxLength: 5000 type: string required: - iban title: param type: object sofort: properties: country: enum: - AT - BE - DE - ES - IT - NL type: string required: - country title: param type: object swish: properties: {} title: param type: object type: enum: - acss_debit - affirm - afterpay_clearpay - alipay - amazon_pay - au_becs_debit - bacs_debit - bancontact - blik - boleto - cashapp - customer_balance - eps - fpx - giropay - grabpay - ideal - klarna - konbini - link - mobilepay - oxxo - p24 - paynow - paypal - pix - promptpay - revolut_pay - sepa_debit - sofort - swish - us_bank_account - wechat_pay - zip type: string x-stripeBypassValidation: true us_bank_account: properties: account_holder_type: enum: - company - individual type: string account_number: maxLength: 5000 type: string account_type: enum: - checking - savings type: string financial_connections_account: maxLength: 5000 type: string routing_number: maxLength: 5000 type: string title: payment_method_param type: object wechat_pay: properties: {} title: param type: object zip: properties: {} title: param type: object required: - type title: payment_method_data_params type: object payment_method_options: description: >- Payment method-specific configuration for this PaymentIntent. properties: acss_debit: anyOf: - properties: mandate_options: properties: custom_mandate_url: anyOf: - type: string - enum: - '' type: string interval_description: maxLength: 500 type: string payment_schedule: enum: - combined - interval - sporadic type: string transaction_type: enum: - business - personal type: string title: >- payment_intent_payment_method_options_mandate_options_param type: object setup_future_usage: enum: - '' - none - off_session - on_session type: string verification_method: enum: - automatic - instant - microdeposits type: string x-stripeBypassValidation: true title: payment_intent_payment_method_options_param type: object - enum: - '' type: string affirm: anyOf: - properties: capture_method: enum: - '' - manual type: string preferred_locale: maxLength: 30 type: string setup_future_usage: enum: - none type: string title: payment_method_options_param type: object - enum: - '' type: string afterpay_clearpay: anyOf: - properties: capture_method: enum: - '' - manual type: string reference: maxLength: 128 type: string setup_future_usage: enum: - none type: string x-stripeBypassValidation: true title: payment_method_options_param type: object - enum: - '' type: string alipay: anyOf: - properties: setup_future_usage: enum: - '' - none - off_session type: string title: payment_method_options_param type: object - enum: - '' type: string amazon_pay: anyOf: - properties: capture_method: enum: - '' - manual type: string setup_future_usage: enum: - '' - none - off_session type: string title: payment_method_options_param type: object - enum: - '' type: string au_becs_debit: anyOf: - properties: setup_future_usage: enum: - '' - none - off_session - on_session type: string title: payment_intent_payment_method_options_param type: object - enum: - '' type: string bacs_debit: anyOf: - properties: setup_future_usage: enum: - '' - none - off_session - on_session type: string title: payment_method_options_param type: object - enum: - '' type: string bancontact: anyOf: - properties: preferred_language: enum: - de - en - fr - nl type: string setup_future_usage: enum: - '' - none - off_session type: string title: payment_method_options_param type: object - enum: - '' type: string blik: anyOf: - properties: code: maxLength: 5000 type: string setup_future_usage: enum: - '' - none type: string x-stripeBypassValidation: true title: payment_intent_payment_method_options_param type: object - enum: - '' type: string boleto: anyOf: - properties: expires_after_days: type: integer setup_future_usage: enum: - '' - none - off_session - on_session type: string title: payment_method_options_param type: object - enum: - '' type: string card: anyOf: - properties: capture_method: enum: - '' - manual type: string cvc_token: maxLength: 5000 type: string installments: properties: enabled: type: boolean plan: anyOf: - properties: count: type: integer interval: enum: - month type: string type: enum: - fixed_count type: string required: - count - interval - type title: installment_plan type: object - enum: - '' type: string title: installments_param type: object mandate_options: properties: amount: type: integer amount_type: enum: - fixed - maximum type: string description: maxLength: 200 type: string end_date: format: unix-time type: integer interval: enum: - day - month - sporadic - week - year type: string interval_count: type: integer reference: maxLength: 80 type: string start_date: format: unix-time type: integer supported_types: items: enum: - india type: string type: array required: - amount - amount_type - interval - reference - start_date title: mandate_options_param type: object network: enum: - amex - cartes_bancaires - diners - discover - eftpos_au - interac - jcb - mastercard - unionpay - unknown - visa maxLength: 5000 type: string x-stripeBypassValidation: true request_extended_authorization: enum: - if_available - never type: string request_incremental_authorization: enum: - if_available - never type: string request_multicapture: enum: - if_available - never type: string request_overcapture: enum: - if_available - never type: string request_three_d_secure: enum: - any - automatic - challenge type: string x-stripeBypassValidation: true require_cvc_recollection: type: boolean setup_future_usage: enum: - '' - none - off_session - on_session type: string statement_descriptor_suffix_kana: anyOf: - maxLength: 22 type: string - enum: - '' type: string statement_descriptor_suffix_kanji: anyOf: - maxLength: 17 type: string - enum: - '' type: string three_d_secure: properties: ares_trans_status: enum: - A - C - I - 'N' - R - U - 'Y' type: string cryptogram: maxLength: 5000 type: string electronic_commerce_indicator: enum: - '01' - '02' - '05' - '06' - '07' type: string x-stripeBypassValidation: true exemption_indicator: enum: - low_risk - none type: string network_options: properties: cartes_bancaires: properties: cb_avalgo: enum: - '0' - '1' - '2' - '3' - '4' - A type: string cb_exemption: maxLength: 4 type: string cb_score: type: integer required: - cb_avalgo title: cartes_bancaires_network_options_param type: object title: network_options_param type: object requestor_challenge_indicator: maxLength: 2 type: string transaction_id: maxLength: 5000 type: string version: enum: - 1.0.2 - 2.1.0 - 2.2.0 type: string x-stripeBypassValidation: true required: - cryptogram - transaction_id - version title: payment_method_options_param type: object title: payment_intent_param type: object - enum: - '' type: string card_present: anyOf: - properties: request_extended_authorization: type: boolean request_incremental_authorization_support: type: boolean title: payment_method_options_param type: object - enum: - '' type: string cashapp: anyOf: - properties: capture_method: enum: - '' - manual type: string setup_future_usage: enum: - '' - none - off_session - on_session type: string title: payment_intent_payment_method_options_param type: object - enum: - '' type: string customer_balance: anyOf: - properties: bank_transfer: properties: eu_bank_transfer: properties: country: maxLength: 5000 type: string required: - country title: eu_bank_transfer_params type: object requested_address_types: items: enum: - aba - iban - sepa - sort_code - spei - swift - zengin type: string x-stripeBypassValidation: true type: array type: enum: - eu_bank_transfer - gb_bank_transfer - jp_bank_transfer - mx_bank_transfer - us_bank_transfer type: string x-stripeBypassValidation: true required: - type title: bank_transfer_param type: object funding_type: enum: - bank_transfer type: string setup_future_usage: enum: - none type: string title: payment_intent_payment_method_options_param type: object - enum: - '' type: string eps: anyOf: - properties: setup_future_usage: enum: - none type: string title: payment_intent_payment_method_options_param type: object - enum: - '' type: string fpx: anyOf: - properties: setup_future_usage: enum: - none type: string title: payment_method_options_param type: object - enum: - '' type: string giropay: anyOf: - properties: setup_future_usage: enum: - none type: string title: payment_method_options_param type: object - enum: - '' type: string grabpay: anyOf: - properties: setup_future_usage: enum: - none type: string title: payment_method_options_param type: object - enum: - '' type: string ideal: anyOf: - properties: setup_future_usage: enum: - '' - none - off_session type: string title: payment_method_options_param type: object - enum: - '' type: string interac_present: anyOf: - properties: {} title: payment_method_options_param type: object - enum: - '' type: string klarna: anyOf: - properties: capture_method: enum: - '' - manual type: string preferred_locale: enum: - cs-CZ - da-DK - de-AT - de-CH - de-DE - el-GR - en-AT - en-AU - en-BE - en-CA - en-CH - en-CZ - en-DE - en-DK - en-ES - en-FI - en-FR - en-GB - en-GR - en-IE - en-IT - en-NL - en-NO - en-NZ - en-PL - en-PT - en-SE - en-US - es-ES - es-US - fi-FI - fr-BE - fr-CA - fr-CH - fr-FR - it-CH - it-IT - nb-NO - nl-BE - nl-NL - pl-PL - pt-PT - sv-FI - sv-SE type: string x-stripeBypassValidation: true setup_future_usage: enum: - none type: string x-stripeBypassValidation: true title: payment_method_options_param type: object - enum: - '' type: string konbini: anyOf: - properties: confirmation_number: anyOf: - maxLength: 11 type: string - enum: - '' type: string expires_after_days: anyOf: - type: integer - enum: - '' type: string expires_at: anyOf: - format: unix-time type: integer - enum: - '' type: string product_description: anyOf: - maxLength: 22 type: string - enum: - '' type: string setup_future_usage: enum: - none type: string title: payment_method_options_param type: object - enum: - '' type: string link: anyOf: - properties: capture_method: enum: - '' - manual type: string setup_future_usage: enum: - '' - none - off_session type: string title: payment_intent_payment_method_options_param type: object - enum: - '' type: string mobilepay: anyOf: - properties: capture_method: enum: - '' - manual type: string setup_future_usage: enum: - none type: string title: payment_method_options_param type: object - enum: - '' type: string oxxo: anyOf: - properties: expires_after_days: type: integer setup_future_usage: enum: - none type: string title: payment_method_options_param type: object - enum: - '' type: string p24: anyOf: - properties: setup_future_usage: enum: - none type: string tos_shown_and_accepted: type: boolean title: payment_method_options_param type: object - enum: - '' type: string paynow: anyOf: - properties: setup_future_usage: enum: - none type: string title: payment_method_options_param type: object - enum: - '' type: string paypal: anyOf: - properties: capture_method: enum: - '' - manual type: string preferred_locale: enum: - cs-CZ - da-DK - de-AT - de-DE - de-LU - el-GR - en-GB - en-US - es-ES - fi-FI - fr-BE - fr-FR - fr-LU - hu-HU - it-IT - nl-BE - nl-NL - pl-PL - pt-PT - sk-SK - sv-SE type: string x-stripeBypassValidation: true reference: maxLength: 127 type: string risk_correlation_id: maxLength: 32 type: string setup_future_usage: enum: - '' - none - off_session type: string title: payment_method_options_param type: object - enum: - '' type: string pix: anyOf: - properties: expires_after_seconds: type: integer expires_at: format: unix-time type: integer setup_future_usage: enum: - none type: string title: payment_method_options_param type: object - enum: - '' type: string promptpay: anyOf: - properties: setup_future_usage: enum: - none type: string title: payment_method_options_param type: object - enum: - '' type: string revolut_pay: anyOf: - properties: capture_method: enum: - '' - manual type: string setup_future_usage: enum: - '' - none - off_session type: string title: payment_method_options_param type: object - enum: - '' type: string sepa_debit: anyOf: - properties: mandate_options: properties: {} title: payment_method_options_mandate_options_param type: object setup_future_usage: enum: - '' - none - off_session - on_session type: string title: payment_intent_payment_method_options_param type: object - enum: - '' type: string sofort: anyOf: - properties: preferred_language: enum: - '' - de - en - es - fr - it - nl - pl type: string setup_future_usage: enum: - '' - none - off_session type: string title: payment_method_options_param type: object - enum: - '' type: string swish: anyOf: - properties: reference: anyOf: - maxLength: 5000 type: string - enum: - '' type: string setup_future_usage: enum: - none type: string title: payment_intent_payment_method_options_param type: object - enum: - '' type: string us_bank_account: anyOf: - properties: financial_connections: properties: permissions: items: enum: - balances - ownership - payment_method - transactions maxLength: 5000 type: string x-stripeBypassValidation: true type: array prefetch: items: enum: - balances - ownership - transactions type: string x-stripeBypassValidation: true type: array return_url: maxLength: 5000 type: string title: linked_account_options_param type: object mandate_options: properties: collection_method: enum: - '' - paper type: string x-stripeBypassValidation: true title: mandate_options_param type: object networks: properties: requested: items: enum: - ach - us_domestic_wire type: string type: array title: networks_options_param type: object preferred_settlement_speed: enum: - '' - fastest - standard type: string setup_future_usage: enum: - '' - none - off_session - on_session type: string verification_method: enum: - automatic - instant - microdeposits type: string x-stripeBypassValidation: true title: payment_intent_payment_method_options_param type: object - enum: - '' type: string wechat_pay: anyOf: - properties: app_id: maxLength: 5000 type: string client: enum: - android - ios - web type: string x-stripeBypassValidation: true setup_future_usage: enum: - none type: string required: - client title: payment_method_options_param type: object - enum: - '' type: string zip: anyOf: - properties: setup_future_usage: enum: - none type: string title: payment_method_options_param type: object - enum: - '' type: string title: payment_method_options_param type: object payment_method_types: description: >- The list of payment method types (for example, a card) that this PaymentIntent can use. If you don't provide this, it defaults to ["card"]. Use `automatic_payment_methods` to manage payment methods from the [Stripe Dashboard](https://dashboard.stripe.com/settings/payment_methods). items: maxLength: 5000 type: string type: array radar_options: description: >- Options to configure Radar. Learn more about [Radar Sessions](https://stripe.com/docs/radar/radar-session). properties: session: maxLength: 5000 type: string title: radar_options_with_hidden_options type: object receipt_email: description: >- Email address to send the receipt to. If you specify `receipt_email` for a payment in live mode, you send a receipt regardless of your [email settings](https://dashboard.stripe.com/account/emails). type: string return_url: description: >- The URL to redirect your customer back to after they authenticate or cancel their payment on the payment method's app or site. If you'd prefer to redirect to a mobile application, you can alternatively supply an application URI scheme. This parameter can only be used with [`confirm=true`](https://stripe.com/docs/api/payment_intents/create#create_payment_intent-confirm). type: string setup_future_usage: description: >- Indicates that you intend to make future payments with this PaymentIntent's payment method. Providing this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes. When processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication). enum: - off_session - on_session type: string shipping: description: Shipping information for this PaymentIntent. properties: address: properties: city: maxLength: 5000 type: string country: maxLength: 5000 type: string line1: maxLength: 5000 type: string line2: maxLength: 5000 type: string postal_code: maxLength: 5000 type: string state: maxLength: 5000 type: string title: optional_fields_address type: object carrier: maxLength: 5000 type: string name: maxLength: 5000 type: string phone: maxLength: 5000 type: string tracking_number: maxLength: 5000 type: string required: - address - name title: optional_fields_shipping type: object statement_descriptor: description: >- For card charges, use [statement_descriptor_suffix](https://stripe.com/docs/payments/account/statement-descriptors#dynamic). Otherwise, you can use this value as the complete description of a charge on your customers' statements. It must contain at least one letter and be 1–22 characters long. maxLength: 22 type: string statement_descriptor_suffix: description: >- Provides information about a card payment that customers see on their statements. Concatenated with the prefix (shortened descriptor) or statement descriptor that’s set on the account to form the complete statement descriptor. The concatenated descriptor must contain 1-22 characters. maxLength: 22 type: string transfer_data: description: >- The parameters that you can use to automatically create a Transfer. Learn more about the [use case for connected accounts](https://stripe.com/docs/payments/connected-accounts). properties: amount: type: integer destination: type: string required: - destination title: transfer_data_creation_params type: object transfer_group: description: >- A string that identifies the resulting payment as part of a group. Learn more about the [use case for connected accounts](https://stripe.com/docs/connect/separate-charges-and-transfers). type: string use_stripe_sdk: description: >- Set to `true` when confirming server-side and using Stripe.js, iOS, or Android client-side SDKs to handle the next actions. type: boolean required: - amount - currency type: object required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/payment_intent' description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. /v1/payment_intents/search: get: description: >-

Search for PaymentIntents you’ve previously created using Stripe’s Search Query Language. Don’t use search in read-after-write flows where strict consistency is necessary. Under normal operating conditions, data is searchable in less than a minute. Occasionally, propagation of new or updated data can be up to an hour behind during outages. Search functionality is not available to merchants in India.

operationId: GetPaymentIntentsSearch parameters: - description: Specifies which fields in the response should be expanded. explode: true in: query name: expand required: false schema: items: maxLength: 5000 type: string type: array style: deepObject - description: >- A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. in: query name: limit required: false schema: type: integer style: form - description: >- A cursor for pagination across multiple pages of results. Don't include this parameter on the first call. Use the next_page value returned in a previous response to request subsequent results. in: query name: page required: false schema: maxLength: 5000 type: string style: form - description: >- The search query string. See [search query language](https://stripe.com/docs/search#search-query-language) and the list of supported [query fields for payment intents](https://stripe.com/docs/search#query-fields-for-payment-intents). in: query name: query required: true schema: maxLength: 5000 type: string style: form requestBody: content: application/x-www-form-urlencoded: encoding: {} schema: additionalProperties: false properties: {} type: object required: false responses: '200': content: application/json: schema: description: '' properties: data: items: $ref: '#/components/schemas/payment_intent' type: array has_more: type: boolean next_page: maxLength: 5000 nullable: true type: string object: description: >- String representing the object's type. Objects of the same type share the same value. enum: - search_result type: string total_count: description: >- The total number of objects that match the query, only accurate up to 10,000. type: integer url: maxLength: 5000 type: string required: - data - has_more - object - url title: SearchResult type: object x-expandableFields: - data description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. '/v1/payment_intents/{intent}': get: description: >-

Retrieves the details of a PaymentIntent that has previously been created.

You can retrieve a PaymentIntent client-side using a publishable key when the client_secret is in the query string.

If you retrieve a PaymentIntent with a publishable key, it only returns a subset of properties. Refer to the payment intent object reference for more details.

operationId: GetPaymentIntentsIntent parameters: - description: >- The client secret of the PaymentIntent. We require it if you use a publishable key to retrieve the source. in: query name: client_secret required: false schema: maxLength: 5000 type: string style: form - description: Specifies which fields in the response should be expanded. explode: true in: query name: expand required: false schema: items: maxLength: 5000 type: string type: array style: deepObject - in: path name: intent required: true schema: maxLength: 5000 type: string style: simple requestBody: content: application/x-www-form-urlencoded: encoding: {} schema: additionalProperties: false properties: {} type: object required: false responses: '200': content: application/json: schema: $ref: '#/components/schemas/payment_intent' description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. post: description: >-

Updates properties on a PaymentIntent object without confirming.

Depending on which properties you update, you might need to confirm the PaymentIntent again. For example, updating the payment_method always requires you to confirm the PaymentIntent again. If you prefer to update and confirm at the same time, we recommend updating properties through the confirm API instead.

operationId: PostPaymentIntentsIntent parameters: - in: path name: intent required: true schema: maxLength: 5000 type: string style: simple requestBody: content: application/x-www-form-urlencoded: encoding: application_fee_amount: explode: true style: deepObject expand: explode: true style: deepObject metadata: explode: true style: deepObject payment_method_data: explode: true style: deepObject payment_method_options: explode: true style: deepObject payment_method_types: explode: true style: deepObject receipt_email: explode: true style: deepObject shipping: explode: true style: deepObject transfer_data: explode: true style: deepObject schema: additionalProperties: false properties: amount: description: >- 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). type: integer application_fee_amount: anyOf: - type: integer - enum: - '' type: string description: >- 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). capture_method: description: >- Controls when the funds will be captured from the customer's account. enum: - automatic - automatic_async - manual type: string currency: description: >- 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). type: string customer: description: >- ID of the Customer this PaymentIntent belongs to, if one exists. Payment methods attached to other Customers cannot be used with this PaymentIntent. If present in combination with [setup_future_usage](https://stripe.com/docs/api#payment_intent_object-setup_future_usage), this PaymentIntent's payment method will be attached to the Customer after the PaymentIntent has been confirmed and any required actions from the user are complete. maxLength: 5000 type: string description: description: >- An arbitrary string attached to the object. Often useful for displaying to users. maxLength: 1000 type: string expand: description: Specifies which fields in the response should be expanded. items: maxLength: 5000 type: string type: array metadata: anyOf: - additionalProperties: type: string type: object - enum: - '' type: string description: >- Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. payment_method: description: >- ID of the payment method (a PaymentMethod, Card, or [compatible Source](https://stripe.com/docs/payments/payment-methods/transitioning#compatibility) object) to attach to this PaymentIntent. maxLength: 5000 type: string payment_method_configuration: description: >- The ID of the payment method configuration to use with this PaymentIntent. maxLength: 100 type: string payment_method_data: description: >- If provided, this hash will be used to create a PaymentMethod. The new PaymentMethod will appear in the [payment_method](https://stripe.com/docs/api/payment_intents/object#payment_intent_object-payment_method) property on the PaymentIntent. properties: acss_debit: properties: account_number: maxLength: 5000 type: string institution_number: maxLength: 5000 type: string transit_number: maxLength: 5000 type: string required: - account_number - institution_number - transit_number title: payment_method_param type: object affirm: properties: {} title: param type: object afterpay_clearpay: properties: {} title: param type: object alipay: properties: {} title: param type: object allow_redisplay: enum: - always - limited - unspecified type: string amazon_pay: properties: {} title: param type: object au_becs_debit: properties: account_number: maxLength: 5000 type: string bsb_number: maxLength: 5000 type: string required: - account_number - bsb_number title: param type: object bacs_debit: properties: account_number: maxLength: 5000 type: string sort_code: maxLength: 5000 type: string title: param type: object bancontact: properties: {} title: param type: object billing_details: properties: address: anyOf: - properties: city: maxLength: 5000 type: string country: maxLength: 5000 type: string line1: maxLength: 5000 type: string line2: maxLength: 5000 type: string postal_code: maxLength: 5000 type: string state: maxLength: 5000 type: string title: billing_details_address type: object - enum: - '' type: string email: anyOf: - type: string - enum: - '' type: string name: anyOf: - maxLength: 5000 type: string - enum: - '' type: string phone: anyOf: - maxLength: 5000 type: string - enum: - '' type: string title: billing_details_inner_params type: object blik: properties: {} title: param type: object boleto: properties: tax_id: maxLength: 5000 type: string required: - tax_id title: param type: object cashapp: properties: {} title: param type: object customer_balance: properties: {} title: param type: object eps: properties: bank: enum: - 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 maxLength: 5000 type: string title: param type: object fpx: properties: bank: enum: - 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 maxLength: 5000 type: string x-stripeBypassValidation: true required: - bank title: param type: object giropay: properties: {} title: param type: object grabpay: properties: {} title: param type: object ideal: properties: bank: enum: - abn_amro - asn_bank - bunq - handelsbanken - ing - knab - moneyou - n26 - nn - rabobank - regiobank - revolut - sns_bank - triodos_bank - van_lanschot - yoursafe maxLength: 5000 type: string title: param type: object interac_present: properties: {} title: param type: object klarna: properties: dob: properties: day: type: integer month: type: integer year: type: integer required: - day - month - year title: date_of_birth type: object title: param type: object konbini: properties: {} title: param type: object link: properties: {} title: param type: object metadata: additionalProperties: type: string type: object mobilepay: properties: {} title: param type: object oxxo: properties: {} title: param type: object p24: properties: bank: enum: - 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 type: string x-stripeBypassValidation: true title: param type: object paynow: properties: {} title: param type: object paypal: properties: {} title: param type: object pix: properties: {} title: param type: object promptpay: properties: {} title: param type: object radar_options: properties: session: maxLength: 5000 type: string title: radar_options_with_hidden_options type: object revolut_pay: properties: {} title: param type: object sepa_debit: properties: iban: maxLength: 5000 type: string required: - iban title: param type: object sofort: properties: country: enum: - AT - BE - DE - ES - IT - NL type: string required: - country title: param type: object swish: properties: {} title: param type: object type: enum: - acss_debit - affirm - afterpay_clearpay - alipay - amazon_pay - au_becs_debit - bacs_debit - bancontact - blik - boleto - cashapp - customer_balance - eps - fpx - giropay - grabpay - ideal - klarna - konbini - link - mobilepay - oxxo - p24 - paynow - paypal - pix - promptpay - revolut_pay - sepa_debit - sofort - swish - us_bank_account - wechat_pay - zip type: string x-stripeBypassValidation: true us_bank_account: properties: account_holder_type: enum: - company - individual type: string account_number: maxLength: 5000 type: string account_type: enum: - checking - savings type: string financial_connections_account: maxLength: 5000 type: string routing_number: maxLength: 5000 type: string title: payment_method_param type: object wechat_pay: properties: {} title: param type: object zip: properties: {} title: param type: object required: - type title: payment_method_data_params type: object payment_method_options: description: >- Payment-method-specific configuration for this PaymentIntent. properties: acss_debit: anyOf: - properties: mandate_options: properties: custom_mandate_url: anyOf: - type: string - enum: - '' type: string interval_description: maxLength: 500 type: string payment_schedule: enum: - combined - interval - sporadic type: string transaction_type: enum: - business - personal type: string title: >- payment_intent_payment_method_options_mandate_options_param type: object setup_future_usage: enum: - '' - none - off_session - on_session type: string verification_method: enum: - automatic - instant - microdeposits type: string x-stripeBypassValidation: true title: payment_intent_payment_method_options_param type: object - enum: - '' type: string affirm: anyOf: - properties: capture_method: enum: - '' - manual type: string preferred_locale: maxLength: 30 type: string setup_future_usage: enum: - none type: string title: payment_method_options_param type: object - enum: - '' type: string afterpay_clearpay: anyOf: - properties: capture_method: enum: - '' - manual type: string reference: maxLength: 128 type: string setup_future_usage: enum: - none type: string x-stripeBypassValidation: true title: payment_method_options_param type: object - enum: - '' type: string alipay: anyOf: - properties: setup_future_usage: enum: - '' - none - off_session type: string title: payment_method_options_param type: object - enum: - '' type: string amazon_pay: anyOf: - properties: capture_method: enum: - '' - manual type: string setup_future_usage: enum: - '' - none - off_session type: string title: payment_method_options_param type: object - enum: - '' type: string au_becs_debit: anyOf: - properties: setup_future_usage: enum: - '' - none - off_session - on_session type: string title: payment_intent_payment_method_options_param type: object - enum: - '' type: string bacs_debit: anyOf: - properties: setup_future_usage: enum: - '' - none - off_session - on_session type: string title: payment_method_options_param type: object - enum: - '' type: string bancontact: anyOf: - properties: preferred_language: enum: - de - en - fr - nl type: string setup_future_usage: enum: - '' - none - off_session type: string title: payment_method_options_param type: object - enum: - '' type: string blik: anyOf: - properties: code: maxLength: 5000 type: string setup_future_usage: enum: - '' - none type: string x-stripeBypassValidation: true title: payment_intent_payment_method_options_param type: object - enum: - '' type: string boleto: anyOf: - properties: expires_after_days: type: integer setup_future_usage: enum: - '' - none - off_session - on_session type: string title: payment_method_options_param type: object - enum: - '' type: string card: anyOf: - properties: capture_method: enum: - '' - manual type: string cvc_token: maxLength: 5000 type: string installments: properties: enabled: type: boolean plan: anyOf: - properties: count: type: integer interval: enum: - month type: string type: enum: - fixed_count type: string required: - count - interval - type title: installment_plan type: object - enum: - '' type: string title: installments_param type: object mandate_options: properties: amount: type: integer amount_type: enum: - fixed - maximum type: string description: maxLength: 200 type: string end_date: format: unix-time type: integer interval: enum: - day - month - sporadic - week - year type: string interval_count: type: integer reference: maxLength: 80 type: string start_date: format: unix-time type: integer supported_types: items: enum: - india type: string type: array required: - amount - amount_type - interval - reference - start_date title: mandate_options_param type: object network: enum: - amex - cartes_bancaires - diners - discover - eftpos_au - interac - jcb - mastercard - unionpay - unknown - visa maxLength: 5000 type: string x-stripeBypassValidation: true request_extended_authorization: enum: - if_available - never type: string request_incremental_authorization: enum: - if_available - never type: string request_multicapture: enum: - if_available - never type: string request_overcapture: enum: - if_available - never type: string request_three_d_secure: enum: - any - automatic - challenge type: string x-stripeBypassValidation: true require_cvc_recollection: type: boolean setup_future_usage: enum: - '' - none - off_session - on_session type: string statement_descriptor_suffix_kana: anyOf: - maxLength: 22 type: string - enum: - '' type: string statement_descriptor_suffix_kanji: anyOf: - maxLength: 17 type: string - enum: - '' type: string three_d_secure: properties: ares_trans_status: enum: - A - C - I - 'N' - R - U - 'Y' type: string cryptogram: maxLength: 5000 type: string electronic_commerce_indicator: enum: - '01' - '02' - '05' - '06' - '07' type: string x-stripeBypassValidation: true exemption_indicator: enum: - low_risk - none type: string network_options: properties: cartes_bancaires: properties: cb_avalgo: enum: - '0' - '1' - '2' - '3' - '4' - A type: string cb_exemption: maxLength: 4 type: string cb_score: type: integer required: - cb_avalgo title: cartes_bancaires_network_options_param type: object title: network_options_param type: object requestor_challenge_indicator: maxLength: 2 type: string transaction_id: maxLength: 5000 type: string version: enum: - 1.0.2 - 2.1.0 - 2.2.0 type: string x-stripeBypassValidation: true required: - cryptogram - transaction_id - version title: payment_method_options_param type: object title: payment_intent_param type: object - enum: - '' type: string card_present: anyOf: - properties: request_extended_authorization: type: boolean request_incremental_authorization_support: type: boolean title: payment_method_options_param type: object - enum: - '' type: string cashapp: anyOf: - properties: capture_method: enum: - '' - manual type: string setup_future_usage: enum: - '' - none - off_session - on_session type: string title: payment_intent_payment_method_options_param type: object - enum: - '' type: string customer_balance: anyOf: - properties: bank_transfer: properties: eu_bank_transfer: properties: country: maxLength: 5000 type: string required: - country title: eu_bank_transfer_params type: object requested_address_types: items: enum: - aba - iban - sepa - sort_code - spei - swift - zengin type: string x-stripeBypassValidation: true type: array type: enum: - eu_bank_transfer - gb_bank_transfer - jp_bank_transfer - mx_bank_transfer - us_bank_transfer type: string x-stripeBypassValidation: true required: - type title: bank_transfer_param type: object funding_type: enum: - bank_transfer type: string setup_future_usage: enum: - none type: string title: payment_intent_payment_method_options_param type: object - enum: - '' type: string eps: anyOf: - properties: setup_future_usage: enum: - none type: string title: payment_intent_payment_method_options_param type: object - enum: - '' type: string fpx: anyOf: - properties: setup_future_usage: enum: - none type: string title: payment_method_options_param type: object - enum: - '' type: string giropay: anyOf: - properties: setup_future_usage: enum: - none type: string title: payment_method_options_param type: object - enum: - '' type: string grabpay: anyOf: - properties: setup_future_usage: enum: - none type: string title: payment_method_options_param type: object - enum: - '' type: string ideal: anyOf: - properties: setup_future_usage: enum: - '' - none - off_session type: string title: payment_method_options_param type: object - enum: - '' type: string interac_present: anyOf: - properties: {} title: payment_method_options_param type: object - enum: - '' type: string klarna: anyOf: - properties: capture_method: enum: - '' - manual type: string preferred_locale: enum: - cs-CZ - da-DK - de-AT - de-CH - de-DE - el-GR - en-AT - en-AU - en-BE - en-CA - en-CH - en-CZ - en-DE - en-DK - en-ES - en-FI - en-FR - en-GB - en-GR - en-IE - en-IT - en-NL - en-NO - en-NZ - en-PL - en-PT - en-SE - en-US - es-ES - es-US - fi-FI - fr-BE - fr-CA - fr-CH - fr-FR - it-CH - it-IT - nb-NO - nl-BE - nl-NL - pl-PL - pt-PT - sv-FI - sv-SE type: string x-stripeBypassValidation: true setup_future_usage: enum: - none type: string x-stripeBypassValidation: true title: payment_method_options_param type: object - enum: - '' type: string konbini: anyOf: - properties: confirmation_number: anyOf: - maxLength: 11 type: string - enum: - '' type: string expires_after_days: anyOf: - type: integer - enum: - '' type: string expires_at: anyOf: - format: unix-time type: integer - enum: - '' type: string product_description: anyOf: - maxLength: 22 type: string - enum: - '' type: string setup_future_usage: enum: - none type: string title: payment_method_options_param type: object - enum: - '' type: string link: anyOf: - properties: capture_method: enum: - '' - manual type: string setup_future_usage: enum: - '' - none - off_session type: string title: payment_intent_payment_method_options_param type: object - enum: - '' type: string mobilepay: anyOf: - properties: capture_method: enum: - '' - manual type: string setup_future_usage: enum: - none type: string title: payment_method_options_param type: object - enum: - '' type: string oxxo: anyOf: - properties: expires_after_days: type: integer setup_future_usage: enum: - none type: string title: payment_method_options_param type: object - enum: - '' type: string p24: anyOf: - properties: setup_future_usage: enum: - none type: string tos_shown_and_accepted: type: boolean title: payment_method_options_param type: object - enum: - '' type: string paynow: anyOf: - properties: setup_future_usage: enum: - none type: string title: payment_method_options_param type: object - enum: - '' type: string paypal: anyOf: - properties: capture_method: enum: - '' - manual type: string preferred_locale: enum: - cs-CZ - da-DK - de-AT - de-DE - de-LU - el-GR - en-GB - en-US - es-ES - fi-FI - fr-BE - fr-FR - fr-LU - hu-HU - it-IT - nl-BE - nl-NL - pl-PL - pt-PT - sk-SK - sv-SE type: string x-stripeBypassValidation: true reference: maxLength: 127 type: string risk_correlation_id: maxLength: 32 type: string setup_future_usage: enum: - '' - none - off_session type: string title: payment_method_options_param type: object - enum: - '' type: string pix: anyOf: - properties: expires_after_seconds: type: integer expires_at: format: unix-time type: integer setup_future_usage: enum: - none type: string title: payment_method_options_param type: object - enum: - '' type: string promptpay: anyOf: - properties: setup_future_usage: enum: - none type: string title: payment_method_options_param type: object - enum: - '' type: string revolut_pay: anyOf: - properties: capture_method: enum: - '' - manual type: string setup_future_usage: enum: - '' - none - off_session type: string title: payment_method_options_param type: object - enum: - '' type: string sepa_debit: anyOf: - properties: mandate_options: properties: {} title: payment_method_options_mandate_options_param type: object setup_future_usage: enum: - '' - none - off_session - on_session type: string title: payment_intent_payment_method_options_param type: object - enum: - '' type: string sofort: anyOf: - properties: preferred_language: enum: - '' - de - en - es - fr - it - nl - pl type: string setup_future_usage: enum: - '' - none - off_session type: string title: payment_method_options_param type: object - enum: - '' type: string swish: anyOf: - properties: reference: anyOf: - maxLength: 5000 type: string - enum: - '' type: string setup_future_usage: enum: - none type: string title: payment_intent_payment_method_options_param type: object - enum: - '' type: string us_bank_account: anyOf: - properties: financial_connections: properties: permissions: items: enum: - balances - ownership - payment_method - transactions maxLength: 5000 type: string x-stripeBypassValidation: true type: array prefetch: items: enum: - balances - ownership - transactions type: string x-stripeBypassValidation: true type: array return_url: maxLength: 5000 type: string title: linked_account_options_param type: object mandate_options: properties: collection_method: enum: - '' - paper type: string x-stripeBypassValidation: true title: mandate_options_param type: object networks: properties: requested: items: enum: - ach - us_domestic_wire type: string type: array title: networks_options_param type: object preferred_settlement_speed: enum: - '' - fastest - standard type: string setup_future_usage: enum: - '' - none - off_session - on_session type: string verification_method: enum: - automatic - instant - microdeposits type: string x-stripeBypassValidation: true title: payment_intent_payment_method_options_param type: object - enum: - '' type: string wechat_pay: anyOf: - properties: app_id: maxLength: 5000 type: string client: enum: - android - ios - web type: string x-stripeBypassValidation: true setup_future_usage: enum: - none type: string required: - client title: payment_method_options_param type: object - enum: - '' type: string zip: anyOf: - properties: setup_future_usage: enum: - none type: string title: payment_method_options_param type: object - enum: - '' type: string title: payment_method_options_param type: object payment_method_types: description: >- The list of payment method types (for example, card) that this PaymentIntent can use. Use `automatic_payment_methods` to manage payment methods from the [Stripe Dashboard](https://dashboard.stripe.com/settings/payment_methods). items: maxLength: 5000 type: string type: array receipt_email: anyOf: - type: string - enum: - '' type: string description: >- Email address that the receipt for the resulting payment will be sent to. If `receipt_email` is specified for a payment in live mode, a receipt will be sent regardless of your [email settings](https://dashboard.stripe.com/account/emails). setup_future_usage: description: >- Indicates that you intend to make future payments with this PaymentIntent's payment method. Providing this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes. When processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication). If `setup_future_usage` is already set and you are performing a request using a publishable key, you may only update the value from `on_session` to `off_session`. enum: - '' - off_session - on_session type: string shipping: anyOf: - properties: address: properties: city: maxLength: 5000 type: string country: maxLength: 5000 type: string line1: maxLength: 5000 type: string line2: maxLength: 5000 type: string postal_code: maxLength: 5000 type: string state: maxLength: 5000 type: string title: optional_fields_address type: object carrier: maxLength: 5000 type: string name: maxLength: 5000 type: string phone: maxLength: 5000 type: string tracking_number: maxLength: 5000 type: string required: - address - name title: optional_fields_shipping type: object - enum: - '' type: string description: Shipping information for this PaymentIntent. statement_descriptor: description: >- For card charges, use [statement_descriptor_suffix](https://stripe.com/docs/payments/account/statement-descriptors#dynamic). Otherwise, you can use this value as the complete description of a charge on your customers' statements. It must contain at least one letter and be 1–22 characters long. maxLength: 22 type: string statement_descriptor_suffix: description: >- Provides information about a card payment that customers see on their statements. Concatenated with the prefix (shortened descriptor) or statement descriptor that’s set on the account to form the complete statement descriptor. Maximum 22 characters for the concatenated descriptor. maxLength: 22 type: string transfer_data: description: >- Use this parameter to automatically create a Transfer when the payment succeeds. Learn more about the [use case for connected accounts](https://stripe.com/docs/payments/connected-accounts). properties: amount: type: integer title: transfer_data_update_params type: object transfer_group: description: >- A string that identifies the resulting payment as part of a group. You can only provide `transfer_group` if it hasn't been set. Learn more about the [use case for connected accounts](https://stripe.com/docs/payments/connected-accounts). type: string type: object required: false responses: '200': content: application/json: schema: $ref: '#/components/schemas/payment_intent' description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. '/v1/payment_intents/{intent}/apply_customer_balance': post: description: >-

Manually reconcile the remaining amount for a customer_balance PaymentIntent.

operationId: PostPaymentIntentsIntentApplyCustomerBalance parameters: - in: path name: intent required: true schema: maxLength: 5000 type: string style: simple requestBody: content: application/x-www-form-urlencoded: encoding: expand: explode: true style: deepObject schema: additionalProperties: false properties: amount: description: >- Amount that you intend to apply to this PaymentIntent from the customer’s cash balance. A positive integer representing how much to charge in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal) (for example, 100 cents to charge 1 USD or 100 to charge 100 JPY, a zero-decimal currency). The maximum amount is the amount of the PaymentIntent. When you omit the amount, it defaults to the remaining amount requested on the PaymentIntent. type: integer currency: description: >- 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). type: string expand: description: Specifies which fields in the response should be expanded. items: maxLength: 5000 type: string type: array type: object required: false responses: '200': content: application/json: schema: $ref: '#/components/schemas/payment_intent' description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. '/v1/payment_intents/{intent}/cancel': post: description: >-

You can cancel a PaymentIntent object when it’s in one of these statuses: requires_payment_method, requires_capture, requires_confirmation, requires_action or, in rare cases, processing.

After it’s canceled, no additional charges are made by the PaymentIntent and any operations on the PaymentIntent fail with an error. For PaymentIntents with a status of requires_capture, the remaining amount_capturable is automatically refunded.

You can’t cancel the PaymentIntent for a Checkout Session. Expire the Checkout Session instead.

operationId: PostPaymentIntentsIntentCancel parameters: - in: path name: intent required: true schema: maxLength: 5000 type: string style: simple requestBody: content: application/x-www-form-urlencoded: encoding: expand: explode: true style: deepObject schema: additionalProperties: false properties: cancellation_reason: description: >- Reason for canceling this PaymentIntent. Possible values are: `duplicate`, `fraudulent`, `requested_by_customer`, or `abandoned` enum: - abandoned - duplicate - fraudulent - requested_by_customer maxLength: 5000 type: string x-stripeBypassValidation: true expand: description: Specifies which fields in the response should be expanded. items: maxLength: 5000 type: string type: array type: object required: false responses: '200': content: application/json: schema: $ref: '#/components/schemas/payment_intent' description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. '/v1/payment_intents/{intent}/capture': post: description: >-

Capture the funds of an existing uncaptured PaymentIntent when its status is requires_capture.

Uncaptured PaymentIntents are cancelled a set number of days (7 by default) after their creation.

Learn more about separate authorization and capture.

operationId: PostPaymentIntentsIntentCapture parameters: - in: path name: intent required: true schema: maxLength: 5000 type: string style: simple requestBody: content: application/x-www-form-urlencoded: encoding: expand: explode: true style: deepObject metadata: explode: true style: deepObject transfer_data: explode: true style: deepObject schema: additionalProperties: false properties: amount_to_capture: description: >- The amount to capture from the PaymentIntent, which must be less than or equal to the original amount. Any additional amount is automatically refunded. Defaults to the full `amount_capturable` if it's not provided. type: integer application_fee_amount: description: >- 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). type: integer expand: description: Specifies which fields in the response should be expanded. items: maxLength: 5000 type: string type: array final_capture: description: >- Defaults to `true`. When capturing a PaymentIntent, setting `final_capture` to `false` notifies Stripe to not release the remaining uncaptured funds to make sure that they're captured in future requests. You can only use this setting when [multicapture](https://stripe.com/docs/payments/multicapture) is available for PaymentIntents. type: boolean metadata: anyOf: - additionalProperties: type: string type: object - enum: - '' type: string description: >- Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. statement_descriptor: description: >- For card charges, use [statement_descriptor_suffix](https://stripe.com/docs/payments/account/statement-descriptors#dynamic). Otherwise, you can use this value as the complete description of a charge on your customers' statements. It must contain at least one letter and be 1–22 characters long. maxLength: 22 type: string statement_descriptor_suffix: description: >- Provides information about a card payment that customers see on their statements. Concatenated with the prefix (shortened descriptor) or statement descriptor that’s set on the account to form the complete statement descriptor. The concatenated descriptor must be 1-22 characters long. maxLength: 22 type: string transfer_data: description: >- The parameters that you can use to automatically create a transfer after the payment is captured. Learn more about the [use case for connected accounts](https://stripe.com/docs/payments/connected-accounts). properties: amount: type: integer title: transfer_data_update_params type: object type: object required: false responses: '200': content: application/json: schema: $ref: '#/components/schemas/payment_intent' description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. '/v1/payment_intents/{intent}/confirm': post: description: >-

Confirm that your customer intends to pay with current or provided payment method. Upon confirmation, the PaymentIntent will attempt to initiate a payment. If the selected payment method requires additional authentication steps, the PaymentIntent will transition to the requires_action status and suggest additional actions via next_action. If payment fails, the PaymentIntent transitions to the requires_payment_method status or the canceled status if the confirmation limit is reached. If payment succeeds, the PaymentIntent will transition to the succeeded status (or requires_capture, if capture_method is set to manual). If the confirmation_method is automatic, payment may be attempted using our client SDKs and the PaymentIntent’s client_secret. After next_actions are handled by the client, no additional confirmation is required to complete the payment. If the confirmation_method is manual, all payment attempts must be initiated using a secret key. If any actions are required for the payment, the PaymentIntent will return to the requires_confirmation state after those actions are completed. Your server needs to then explicitly re-confirm the PaymentIntent to initiate the next payment attempt.

operationId: PostPaymentIntentsIntentConfirm parameters: - in: path name: intent required: true schema: maxLength: 5000 type: string style: simple requestBody: content: application/x-www-form-urlencoded: encoding: expand: explode: true style: deepObject mandate_data: explode: true style: deepObject off_session: explode: true style: deepObject payment_method_data: explode: true style: deepObject payment_method_options: explode: true style: deepObject payment_method_types: explode: true style: deepObject radar_options: explode: true style: deepObject receipt_email: explode: true style: deepObject shipping: explode: true style: deepObject schema: additionalProperties: false properties: capture_method: description: >- Controls when the funds will be captured from the customer's account. enum: - automatic - automatic_async - manual type: string client_secret: description: The client secret of the PaymentIntent. maxLength: 5000 type: string confirmation_token: description: >- ID of the ConfirmationToken used to confirm this PaymentIntent. If the provided ConfirmationToken contains properties that are also being provided in this request, such as `payment_method`, then the values in this request will take precedence. maxLength: 5000 type: string error_on_requires_action: description: >- Set to `true` to fail the payment attempt if the PaymentIntent transitions into `requires_action`. This parameter is intended for simpler integrations that do not handle customer actions, like [saving cards without authentication](https://stripe.com/docs/payments/save-card-without-authentication). type: boolean expand: description: Specifies which fields in the response should be expanded. items: maxLength: 5000 type: string type: array mandate: description: ID of the mandate that's used for this payment. maxLength: 5000 type: string mandate_data: anyOf: - properties: customer_acceptance: properties: accepted_at: format: unix-time type: integer offline: properties: {} title: offline_param type: object online: properties: ip_address: type: string user_agent: maxLength: 5000 type: string required: - ip_address - user_agent title: online_param type: object type: enum: - offline - online maxLength: 5000 type: string required: - type title: customer_acceptance_param type: object required: - customer_acceptance title: secret_key_param type: object - enum: - '' type: string - description: This hash contains details about the Mandate to create properties: customer_acceptance: properties: online: properties: ip_address: type: string user_agent: maxLength: 5000 type: string title: online_param type: object type: enum: - online maxLength: 5000 type: string required: - online - type title: customer_acceptance_param type: object required: - customer_acceptance title: client_key_param type: object off_session: anyOf: - type: boolean - enum: - one_off - recurring maxLength: 5000 type: string description: >- Set to `true` to indicate that the customer isn't in your checkout flow during this payment attempt and can't authenticate. Use this parameter in scenarios where you collect card details and [charge them later](https://stripe.com/docs/payments/cards/charging-saved-cards). payment_method: description: >- ID of the payment method (a PaymentMethod, Card, or [compatible Source](https://stripe.com/docs/payments/payment-methods/transitioning#compatibility) object) to attach to this PaymentIntent. maxLength: 5000 type: string payment_method_data: description: >- If provided, this hash will be used to create a PaymentMethod. The new PaymentMethod will appear in the [payment_method](https://stripe.com/docs/api/payment_intents/object#payment_intent_object-payment_method) property on the PaymentIntent. properties: acss_debit: properties: account_number: maxLength: 5000 type: string institution_number: maxLength: 5000 type: string transit_number: maxLength: 5000 type: string required: - account_number - institution_number - transit_number title: payment_method_param type: object affirm: properties: {} title: param type: object afterpay_clearpay: properties: {} title: param type: object alipay: properties: {} title: param type: object allow_redisplay: enum: - always - limited - unspecified type: string amazon_pay: properties: {} title: param type: object au_becs_debit: properties: account_number: maxLength: 5000 type: string bsb_number: maxLength: 5000 type: string required: - account_number - bsb_number title: param type: object bacs_debit: properties: account_number: maxLength: 5000 type: string sort_code: maxLength: 5000 type: string title: param type: object bancontact: properties: {} title: param type: object billing_details: properties: address: anyOf: - properties: city: maxLength: 5000 type: string country: maxLength: 5000 type: string line1: maxLength: 5000 type: string line2: maxLength: 5000 type: string postal_code: maxLength: 5000 type: string state: maxLength: 5000 type: string title: billing_details_address type: object - enum: - '' type: string email: anyOf: - type: string - enum: - '' type: string name: anyOf: - maxLength: 5000 type: string - enum: - '' type: string phone: anyOf: - maxLength: 5000 type: string - enum: - '' type: string title: billing_details_inner_params type: object blik: properties: {} title: param type: object boleto: properties: tax_id: maxLength: 5000 type: string required: - tax_id title: param type: object cashapp: properties: {} title: param type: object customer_balance: properties: {} title: param type: object eps: properties: bank: enum: - 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 maxLength: 5000 type: string title: param type: object fpx: properties: bank: enum: - 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 maxLength: 5000 type: string x-stripeBypassValidation: true required: - bank title: param type: object giropay: properties: {} title: param type: object grabpay: properties: {} title: param type: object ideal: properties: bank: enum: - abn_amro - asn_bank - bunq - handelsbanken - ing - knab - moneyou - n26 - nn - rabobank - regiobank - revolut - sns_bank - triodos_bank - van_lanschot - yoursafe maxLength: 5000 type: string title: param type: object interac_present: properties: {} title: param type: object klarna: properties: dob: properties: day: type: integer month: type: integer year: type: integer required: - day - month - year title: date_of_birth type: object title: param type: object konbini: properties: {} title: param type: object link: properties: {} title: param type: object metadata: additionalProperties: type: string type: object mobilepay: properties: {} title: param type: object oxxo: properties: {} title: param type: object p24: properties: bank: enum: - 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 type: string x-stripeBypassValidation: true title: param type: object paynow: properties: {} title: param type: object paypal: properties: {} title: param type: object pix: properties: {} title: param type: object promptpay: properties: {} title: param type: object radar_options: properties: session: maxLength: 5000 type: string title: radar_options_with_hidden_options type: object revolut_pay: properties: {} title: param type: object sepa_debit: properties: iban: maxLength: 5000 type: string required: - iban title: param type: object sofort: properties: country: enum: - AT - BE - DE - ES - IT - NL type: string required: - country title: param type: object swish: properties: {} title: param type: object type: enum: - acss_debit - affirm - afterpay_clearpay - alipay - amazon_pay - au_becs_debit - bacs_debit - bancontact - blik - boleto - cashapp - customer_balance - eps - fpx - giropay - grabpay - ideal - klarna - konbini - link - mobilepay - oxxo - p24 - paynow - paypal - pix - promptpay - revolut_pay - sepa_debit - sofort - swish - us_bank_account - wechat_pay - zip type: string x-stripeBypassValidation: true us_bank_account: properties: account_holder_type: enum: - company - individual type: string account_number: maxLength: 5000 type: string account_type: enum: - checking - savings type: string financial_connections_account: maxLength: 5000 type: string routing_number: maxLength: 5000 type: string title: payment_method_param type: object wechat_pay: properties: {} title: param type: object zip: properties: {} title: param type: object required: - type title: payment_method_data_params type: object payment_method_options: description: >- Payment method-specific configuration for this PaymentIntent. properties: acss_debit: anyOf: - properties: mandate_options: properties: custom_mandate_url: anyOf: - type: string - enum: - '' type: string interval_description: maxLength: 500 type: string payment_schedule: enum: - combined - interval - sporadic type: string transaction_type: enum: - business - personal type: string title: >- payment_intent_payment_method_options_mandate_options_param type: object setup_future_usage: enum: - '' - none - off_session - on_session type: string verification_method: enum: - automatic - instant - microdeposits type: string x-stripeBypassValidation: true title: payment_intent_payment_method_options_param type: object - enum: - '' type: string affirm: anyOf: - properties: capture_method: enum: - '' - manual type: string preferred_locale: maxLength: 30 type: string setup_future_usage: enum: - none type: string title: payment_method_options_param type: object - enum: - '' type: string afterpay_clearpay: anyOf: - properties: capture_method: enum: - '' - manual type: string reference: maxLength: 128 type: string setup_future_usage: enum: - none type: string x-stripeBypassValidation: true title: payment_method_options_param type: object - enum: - '' type: string alipay: anyOf: - properties: setup_future_usage: enum: - '' - none - off_session type: string title: payment_method_options_param type: object - enum: - '' type: string amazon_pay: anyOf: - properties: capture_method: enum: - '' - manual type: string setup_future_usage: enum: - '' - none - off_session type: string title: payment_method_options_param type: object - enum: - '' type: string au_becs_debit: anyOf: - properties: setup_future_usage: enum: - '' - none - off_session - on_session type: string title: payment_intent_payment_method_options_param type: object - enum: - '' type: string bacs_debit: anyOf: - properties: setup_future_usage: enum: - '' - none - off_session - on_session type: string title: payment_method_options_param type: object - enum: - '' type: string bancontact: anyOf: - properties: preferred_language: enum: - de - en - fr - nl type: string setup_future_usage: enum: - '' - none - off_session type: string title: payment_method_options_param type: object - enum: - '' type: string blik: anyOf: - properties: code: maxLength: 5000 type: string setup_future_usage: enum: - '' - none type: string x-stripeBypassValidation: true title: payment_intent_payment_method_options_param type: object - enum: - '' type: string boleto: anyOf: - properties: expires_after_days: type: integer setup_future_usage: enum: - '' - none - off_session - on_session type: string title: payment_method_options_param type: object - enum: - '' type: string card: anyOf: - properties: capture_method: enum: - '' - manual type: string cvc_token: maxLength: 5000 type: string installments: properties: enabled: type: boolean plan: anyOf: - properties: count: type: integer interval: enum: - month type: string type: enum: - fixed_count type: string required: - count - interval - type title: installment_plan type: object - enum: - '' type: string title: installments_param type: object mandate_options: properties: amount: type: integer amount_type: enum: - fixed - maximum type: string description: maxLength: 200 type: string end_date: format: unix-time type: integer interval: enum: - day - month - sporadic - week - year type: string interval_count: type: integer reference: maxLength: 80 type: string start_date: format: unix-time type: integer supported_types: items: enum: - india type: string type: array required: - amount - amount_type - interval - reference - start_date title: mandate_options_param type: object network: enum: - amex - cartes_bancaires - diners - discover - eftpos_au - interac - jcb - mastercard - unionpay - unknown - visa maxLength: 5000 type: string x-stripeBypassValidation: true request_extended_authorization: enum: - if_available - never type: string request_incremental_authorization: enum: - if_available - never type: string request_multicapture: enum: - if_available - never type: string request_overcapture: enum: - if_available - never type: string request_three_d_secure: enum: - any - automatic - challenge type: string x-stripeBypassValidation: true require_cvc_recollection: type: boolean setup_future_usage: enum: - '' - none - off_session - on_session type: string statement_descriptor_suffix_kana: anyOf: - maxLength: 22 type: string - enum: - '' type: string statement_descriptor_suffix_kanji: anyOf: - maxLength: 17 type: string - enum: - '' type: string three_d_secure: properties: ares_trans_status: enum: - A - C - I - 'N' - R - U - 'Y' type: string cryptogram: maxLength: 5000 type: string electronic_commerce_indicator: enum: - '01' - '02' - '05' - '06' - '07' type: string x-stripeBypassValidation: true exemption_indicator: enum: - low_risk - none type: string network_options: properties: cartes_bancaires: properties: cb_avalgo: enum: - '0' - '1' - '2' - '3' - '4' - A type: string cb_exemption: maxLength: 4 type: string cb_score: type: integer required: - cb_avalgo title: cartes_bancaires_network_options_param type: object title: network_options_param type: object requestor_challenge_indicator: maxLength: 2 type: string transaction_id: maxLength: 5000 type: string version: enum: - 1.0.2 - 2.1.0 - 2.2.0 type: string x-stripeBypassValidation: true required: - cryptogram - transaction_id - version title: payment_method_options_param type: object title: payment_intent_param type: object - enum: - '' type: string card_present: anyOf: - properties: request_extended_authorization: type: boolean request_incremental_authorization_support: type: boolean title: payment_method_options_param type: object - enum: - '' type: string cashapp: anyOf: - properties: capture_method: enum: - '' - manual type: string setup_future_usage: enum: - '' - none - off_session - on_session type: string title: payment_intent_payment_method_options_param type: object - enum: - '' type: string customer_balance: anyOf: - properties: bank_transfer: properties: eu_bank_transfer: properties: country: maxLength: 5000 type: string required: - country title: eu_bank_transfer_params type: object requested_address_types: items: enum: - aba - iban - sepa - sort_code - spei - swift - zengin type: string x-stripeBypassValidation: true type: array type: enum: - eu_bank_transfer - gb_bank_transfer - jp_bank_transfer - mx_bank_transfer - us_bank_transfer type: string x-stripeBypassValidation: true required: - type title: bank_transfer_param type: object funding_type: enum: - bank_transfer type: string setup_future_usage: enum: - none type: string title: payment_intent_payment_method_options_param type: object - enum: - '' type: string eps: anyOf: - properties: setup_future_usage: enum: - none type: string title: payment_intent_payment_method_options_param type: object - enum: - '' type: string fpx: anyOf: - properties: setup_future_usage: enum: - none type: string title: payment_method_options_param type: object - enum: - '' type: string giropay: anyOf: - properties: setup_future_usage: enum: - none type: string title: payment_method_options_param type: object - enum: - '' type: string grabpay: anyOf: - properties: setup_future_usage: enum: - none type: string title: payment_method_options_param type: object - enum: - '' type: string ideal: anyOf: - properties: setup_future_usage: enum: - '' - none - off_session type: string title: payment_method_options_param type: object - enum: - '' type: string interac_present: anyOf: - properties: {} title: payment_method_options_param type: object - enum: - '' type: string klarna: anyOf: - properties: capture_method: enum: - '' - manual type: string preferred_locale: enum: - cs-CZ - da-DK - de-AT - de-CH - de-DE - el-GR - en-AT - en-AU - en-BE - en-CA - en-CH - en-CZ - en-DE - en-DK - en-ES - en-FI - en-FR - en-GB - en-GR - en-IE - en-IT - en-NL - en-NO - en-NZ - en-PL - en-PT - en-SE - en-US - es-ES - es-US - fi-FI - fr-BE - fr-CA - fr-CH - fr-FR - it-CH - it-IT - nb-NO - nl-BE - nl-NL - pl-PL - pt-PT - sv-FI - sv-SE type: string x-stripeBypassValidation: true setup_future_usage: enum: - none type: string x-stripeBypassValidation: true title: payment_method_options_param type: object - enum: - '' type: string konbini: anyOf: - properties: confirmation_number: anyOf: - maxLength: 11 type: string - enum: - '' type: string expires_after_days: anyOf: - type: integer - enum: - '' type: string expires_at: anyOf: - format: unix-time type: integer - enum: - '' type: string product_description: anyOf: - maxLength: 22 type: string - enum: - '' type: string setup_future_usage: enum: - none type: string title: payment_method_options_param type: object - enum: - '' type: string link: anyOf: - properties: capture_method: enum: - '' - manual type: string setup_future_usage: enum: - '' - none - off_session type: string title: payment_intent_payment_method_options_param type: object - enum: - '' type: string mobilepay: anyOf: - properties: capture_method: enum: - '' - manual type: string setup_future_usage: enum: - none type: string title: payment_method_options_param type: object - enum: - '' type: string oxxo: anyOf: - properties: expires_after_days: type: integer setup_future_usage: enum: - none type: string title: payment_method_options_param type: object - enum: - '' type: string p24: anyOf: - properties: setup_future_usage: enum: - none type: string tos_shown_and_accepted: type: boolean title: payment_method_options_param type: object - enum: - '' type: string paynow: anyOf: - properties: setup_future_usage: enum: - none type: string title: payment_method_options_param type: object - enum: - '' type: string paypal: anyOf: - properties: capture_method: enum: - '' - manual type: string preferred_locale: enum: - cs-CZ - da-DK - de-AT - de-DE - de-LU - el-GR - en-GB - en-US - es-ES - fi-FI - fr-BE - fr-FR - fr-LU - hu-HU - it-IT - nl-BE - nl-NL - pl-PL - pt-PT - sk-SK - sv-SE type: string x-stripeBypassValidation: true reference: maxLength: 127 type: string risk_correlation_id: maxLength: 32 type: string setup_future_usage: enum: - '' - none - off_session type: string title: payment_method_options_param type: object - enum: - '' type: string pix: anyOf: - properties: expires_after_seconds: type: integer expires_at: format: unix-time type: integer setup_future_usage: enum: - none type: string title: payment_method_options_param type: object - enum: - '' type: string promptpay: anyOf: - properties: setup_future_usage: enum: - none type: string title: payment_method_options_param type: object - enum: - '' type: string revolut_pay: anyOf: - properties: capture_method: enum: - '' - manual type: string setup_future_usage: enum: - '' - none - off_session type: string title: payment_method_options_param type: object - enum: - '' type: string sepa_debit: anyOf: - properties: mandate_options: properties: {} title: payment_method_options_mandate_options_param type: object setup_future_usage: enum: - '' - none - off_session - on_session type: string title: payment_intent_payment_method_options_param type: object - enum: - '' type: string sofort: anyOf: - properties: preferred_language: enum: - '' - de - en - es - fr - it - nl - pl type: string setup_future_usage: enum: - '' - none - off_session type: string title: payment_method_options_param type: object - enum: - '' type: string swish: anyOf: - properties: reference: anyOf: - maxLength: 5000 type: string - enum: - '' type: string setup_future_usage: enum: - none type: string title: payment_intent_payment_method_options_param type: object - enum: - '' type: string us_bank_account: anyOf: - properties: financial_connections: properties: permissions: items: enum: - balances - ownership - payment_method - transactions maxLength: 5000 type: string x-stripeBypassValidation: true type: array prefetch: items: enum: - balances - ownership - transactions type: string x-stripeBypassValidation: true type: array return_url: maxLength: 5000 type: string title: linked_account_options_param type: object mandate_options: properties: collection_method: enum: - '' - paper type: string x-stripeBypassValidation: true title: mandate_options_param type: object networks: properties: requested: items: enum: - ach - us_domestic_wire type: string type: array title: networks_options_param type: object preferred_settlement_speed: enum: - '' - fastest - standard type: string setup_future_usage: enum: - '' - none - off_session - on_session type: string verification_method: enum: - automatic - instant - microdeposits type: string x-stripeBypassValidation: true title: payment_intent_payment_method_options_param type: object - enum: - '' type: string wechat_pay: anyOf: - properties: app_id: maxLength: 5000 type: string client: enum: - android - ios - web type: string x-stripeBypassValidation: true setup_future_usage: enum: - none type: string required: - client title: payment_method_options_param type: object - enum: - '' type: string zip: anyOf: - properties: setup_future_usage: enum: - none type: string title: payment_method_options_param type: object - enum: - '' type: string title: payment_method_options_param type: object payment_method_types: description: >- The list of payment method types (for example, a card) that this PaymentIntent can use. Use `automatic_payment_methods` to manage payment methods from the [Stripe Dashboard](https://dashboard.stripe.com/settings/payment_methods). items: maxLength: 5000 type: string type: array radar_options: description: >- Options to configure Radar. Learn more about [Radar Sessions](https://stripe.com/docs/radar/radar-session). properties: session: maxLength: 5000 type: string title: radar_options_with_hidden_options type: object receipt_email: anyOf: - type: string - enum: - '' type: string description: >- Email address that the receipt for the resulting payment will be sent to. If `receipt_email` is specified for a payment in live mode, a receipt will be sent regardless of your [email settings](https://dashboard.stripe.com/account/emails). return_url: description: >- The URL to redirect your customer back to after they authenticate or cancel their payment on the payment method's app or site. If you'd prefer to redirect to a mobile application, you can alternatively supply an application URI scheme. This parameter is only used for cards and other redirect-based payment methods. type: string setup_future_usage: description: >- Indicates that you intend to make future payments with this PaymentIntent's payment method. Providing this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes. When processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication). If `setup_future_usage` is already set and you are performing a request using a publishable key, you may only update the value from `on_session` to `off_session`. enum: - '' - off_session - on_session type: string shipping: anyOf: - properties: address: properties: city: maxLength: 5000 type: string country: maxLength: 5000 type: string line1: maxLength: 5000 type: string line2: maxLength: 5000 type: string postal_code: maxLength: 5000 type: string state: maxLength: 5000 type: string title: optional_fields_address type: object carrier: maxLength: 5000 type: string name: maxLength: 5000 type: string phone: maxLength: 5000 type: string tracking_number: maxLength: 5000 type: string required: - address - name title: optional_fields_shipping type: object - enum: - '' type: string description: Shipping information for this PaymentIntent. use_stripe_sdk: description: >- Set to `true` when confirming server-side and using Stripe.js, iOS, or Android client-side SDKs to handle the next actions. type: boolean type: object required: false responses: '200': content: application/json: schema: $ref: '#/components/schemas/payment_intent' description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. '/v1/payment_intents/{intent}/increment_authorization': post: description: >-

Perform an incremental authorization on an eligible PaymentIntent. To be eligible, the PaymentIntent’s status must be requires_capture and incremental_authorization_supported must be true.

Incremental authorizations attempt to increase the authorized amount on your customer’s card to the new, higher amount provided. Similar to the initial authorization, incremental authorizations can be declined. A single PaymentIntent can call this endpoint multiple times to further increase the authorized amount.

If the incremental authorization succeeds, the PaymentIntent object returns with the updated amount. If the incremental authorization fails, a card_declined error returns, and no other fields on the PaymentIntent or Charge update. The PaymentIntent object remains capturable for the previously authorized amount.

Each PaymentIntent can have a maximum of 10 incremental authorization attempts, including declines. After it’s captured, a PaymentIntent can no longer be incremented.

Learn more about incremental authorizations.

operationId: PostPaymentIntentsIntentIncrementAuthorization parameters: - in: path name: intent required: true schema: maxLength: 5000 type: string style: simple requestBody: content: application/x-www-form-urlencoded: encoding: expand: explode: true style: deepObject metadata: explode: true style: deepObject transfer_data: explode: true style: deepObject schema: additionalProperties: false properties: amount: description: >- The updated total amount that you intend to collect from the cardholder. This amount must be greater than the currently authorized amount. type: integer application_fee_amount: description: >- 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). type: integer description: description: >- An arbitrary string attached to the object. Often useful for displaying to users. maxLength: 1000 type: string expand: description: Specifies which fields in the response should be expanded. items: maxLength: 5000 type: string type: array metadata: additionalProperties: type: string description: >- Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. type: object statement_descriptor: description: >- For card charges, use [statement_descriptor_suffix](https://stripe.com/docs/payments/account/statement-descriptors#dynamic). Otherwise, you can use this value as the complete description of a charge on your customers' statements. It must contain at least one letter and be 1–22 characters long. maxLength: 22 type: string transfer_data: description: >- The parameters used to automatically create a transfer after the payment is captured. Learn more about the [use case for connected accounts](https://stripe.com/docs/payments/connected-accounts). properties: amount: type: integer title: transfer_data_update_params type: object required: - amount type: object required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/payment_intent' description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. '/v1/payment_intents/{intent}/verify_microdeposits': post: description:

Verifies microdeposits on a PaymentIntent object.

operationId: PostPaymentIntentsIntentVerifyMicrodeposits parameters: - in: path name: intent required: true schema: maxLength: 5000 type: string style: simple requestBody: content: application/x-www-form-urlencoded: encoding: amounts: explode: true style: deepObject expand: explode: true style: deepObject schema: additionalProperties: false properties: amounts: description: >- Two positive integers, in *cents*, equal to the values of the microdeposits sent to the bank account. items: type: integer type: array client_secret: description: The client secret of the PaymentIntent. maxLength: 5000 type: string descriptor_code: description: >- A six-character code starting with SM present in the microdeposit sent to the bank account. maxLength: 5000 type: string expand: description: Specifies which fields in the response should be expanded. items: maxLength: 5000 type: string type: array type: object required: false responses: '200': content: application/json: schema: $ref: '#/components/schemas/payment_intent' description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. /v1/payment_links: get: description:

Returns a list of your payment links.

operationId: GetPaymentLinks parameters: - description: >- Only return payment links that are active or inactive (e.g., pass `false` to list all inactive payment links). in: query name: active required: false schema: type: boolean style: form - description: >- A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. in: query name: ending_before required: false schema: maxLength: 5000 type: string style: form - description: Specifies which fields in the response should be expanded. explode: true in: query name: expand required: false schema: items: maxLength: 5000 type: string type: array style: deepObject - description: >- A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. in: query name: limit required: false schema: type: integer style: form - description: >- A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. in: query name: starting_after required: false schema: maxLength: 5000 type: string style: form requestBody: content: application/x-www-form-urlencoded: encoding: {} schema: additionalProperties: false properties: {} type: object required: false responses: '200': content: application/json: schema: description: '' properties: data: items: $ref: '#/components/schemas/payment_link' type: array has_more: description: >- True if this list has another page of items after this one that can be fetched. type: boolean object: description: >- String representing the object's type. Objects of the same type share the same value. Always has the value `list`. enum: - list type: string url: description: The URL where this list can be accessed. maxLength: 5000 pattern: ^/v1/payment_links type: string required: - data - has_more - object - url title: PaymentLinksResourcePaymentLinkList type: object x-expandableFields: - data description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. post: description:

Creates a payment link.

operationId: PostPaymentLinks requestBody: content: application/x-www-form-urlencoded: encoding: after_completion: explode: true style: deepObject automatic_tax: explode: true style: deepObject consent_collection: explode: true style: deepObject custom_fields: explode: true style: deepObject custom_text: explode: true style: deepObject expand: explode: true style: deepObject invoice_creation: explode: true style: deepObject line_items: explode: true style: deepObject metadata: explode: true style: deepObject payment_intent_data: explode: true style: deepObject payment_method_types: explode: true style: deepObject phone_number_collection: explode: true style: deepObject restrictions: explode: true style: deepObject shipping_address_collection: explode: true style: deepObject shipping_options: explode: true style: deepObject subscription_data: explode: true style: deepObject tax_id_collection: explode: true style: deepObject transfer_data: explode: true style: deepObject schema: additionalProperties: false properties: after_completion: description: Behavior after the purchase is complete. properties: hosted_confirmation: properties: custom_message: maxLength: 500 type: string title: after_completion_confirmation_page_params type: object redirect: properties: url: maxLength: 2048 type: string required: - url title: after_completion_redirect_params type: object type: enum: - hosted_confirmation - redirect type: string required: - type title: after_completion_params type: object allow_promotion_codes: description: Enables user redeemable promotion codes. type: boolean application_fee_amount: description: >- 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. Can only be applied when there are no line items with recurring prices. type: integer application_fee_percent: description: >- 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. There must be at least 1 line item with a recurring price to use this field. type: number automatic_tax: description: Configuration for automatic tax collection. properties: enabled: type: boolean liability: properties: account: type: string type: enum: - account - self type: string required: - type title: param type: object required: - enabled title: automatic_tax_params type: object billing_address_collection: description: >- Configuration for collecting the customer's billing address. Defaults to `auto`. enum: - auto - required type: string consent_collection: description: Configure fields to gather active consent from customers. properties: payment_method_reuse_agreement: properties: position: enum: - auto - hidden type: string required: - position title: payment_method_reuse_agreement_params type: object promotions: enum: - auto - none type: string terms_of_service: enum: - none - required type: string title: consent_collection_params type: object currency: description: >- 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) and supported by each line item's price. type: string custom_fields: description: >- Collect additional information from your customer using custom fields. Up to 3 fields are supported. items: properties: dropdown: properties: options: items: properties: label: maxLength: 100 type: string value: maxLength: 100 type: string required: - label - value title: custom_field_option_param type: object type: array required: - options title: custom_field_dropdown_param type: object key: maxLength: 200 type: string label: properties: custom: maxLength: 50 type: string type: enum: - custom type: string required: - custom - type title: custom_field_label_param type: object numeric: properties: maximum_length: type: integer minimum_length: type: integer title: custom_field_numeric_param type: object optional: type: boolean text: properties: maximum_length: type: integer minimum_length: type: integer title: custom_field_text_param type: object type: enum: - dropdown - numeric - text type: string required: - key - label - type title: custom_field_param type: object type: array custom_text: description: >- Display additional text for your customers using custom text. properties: after_submit: anyOf: - properties: message: maxLength: 1200 type: string required: - message title: custom_text_position_param type: object - enum: - '' type: string shipping_address: anyOf: - properties: message: maxLength: 1200 type: string required: - message title: custom_text_position_param type: object - enum: - '' type: string submit: anyOf: - properties: message: maxLength: 1200 type: string required: - message title: custom_text_position_param type: object - enum: - '' type: string terms_of_service_acceptance: anyOf: - properties: message: maxLength: 1200 type: string required: - message title: custom_text_position_param type: object - enum: - '' type: string title: custom_text_param type: object customer_creation: description: >- Configures whether [checkout sessions](https://stripe.com/docs/api/checkout/sessions) created by this payment link create a [Customer](https://stripe.com/docs/api/customers). enum: - always - if_required type: string expand: description: Specifies which fields in the response should be expanded. items: maxLength: 5000 type: string type: array inactive_message: description: >- The custom message to be displayed to a customer when a payment link is no longer active. maxLength: 500 type: string invoice_creation: description: Generate a post-purchase Invoice for one-time payments. properties: enabled: type: boolean invoice_data: properties: account_tax_ids: anyOf: - items: maxLength: 5000 type: string type: array - enum: - '' type: string custom_fields: anyOf: - items: properties: name: maxLength: 40 type: string value: maxLength: 140 type: string required: - name - value title: custom_field_params type: object type: array - enum: - '' type: string description: maxLength: 1500 type: string footer: maxLength: 5000 type: string issuer: properties: account: type: string type: enum: - account - self type: string required: - type title: param type: object metadata: anyOf: - additionalProperties: type: string type: object - enum: - '' type: string rendering_options: anyOf: - properties: amount_tax_display: enum: - '' - exclude_tax - include_inclusive_tax type: string title: rendering_options_param type: object - enum: - '' type: string title: invoice_settings_params type: object required: - enabled title: invoice_creation_create_params type: object line_items: description: >- The line items representing what is being sold. Each line item represents an item being sold. Up to 20 line items are supported. items: properties: adjustable_quantity: properties: enabled: type: boolean maximum: type: integer minimum: type: integer required: - enabled title: adjustable_quantity_params type: object price: maxLength: 5000 type: string quantity: type: integer required: - price - quantity title: line_items_create_params type: object type: array metadata: additionalProperties: type: string description: >- Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. Metadata associated with this Payment Link will automatically be copied to [checkout sessions](https://stripe.com/docs/api/checkout/sessions) created by this payment link. type: object on_behalf_of: description: The account on behalf of which to charge. type: string payment_intent_data: description: >- A subset of parameters to be passed to PaymentIntent creation for Checkout Sessions in `payment` mode. properties: capture_method: enum: - automatic - automatic_async - manual type: string description: maxLength: 1000 type: string metadata: additionalProperties: type: string type: object setup_future_usage: enum: - off_session - on_session type: string statement_descriptor: maxLength: 22 type: string statement_descriptor_suffix: maxLength: 22 type: string transfer_group: maxLength: 5000 type: string title: payment_intent_data_params type: object payment_method_collection: description: >- Specify whether Checkout should collect a payment method. When set to `if_required`, Checkout will not collect a payment method when the total due for the session is 0.This may occur if the Checkout Session includes a free trial or a discount. Can only be set in `subscription` mode. Defaults to `always`. If you'd like information on how to collect a payment method outside of Checkout, read the guide on [configuring subscriptions with a free trial](https://stripe.com/docs/payments/checkout/free-trials). enum: - always - if_required type: string payment_method_types: description: >- The list of payment method types that customers can use. If no value is passed, Stripe will dynamically show relevant payment methods from your [payment method settings](https://dashboard.stripe.com/settings/payment_methods) (20+ payment methods [supported](https://stripe.com/docs/payments/payment-methods/integration-options#payment-method-product-support)). items: enum: - affirm - afterpay_clearpay - alipay - au_becs_debit - bacs_debit - bancontact - blik - boleto - card - cashapp - eps - fpx - giropay - grabpay - ideal - klarna - konbini - link - oxxo - p24 - paynow - paypal - pix - promptpay - sepa_debit - sofort - swish - us_bank_account - wechat_pay type: string x-stripeBypassValidation: true type: array phone_number_collection: description: >- Controls phone number collection settings during checkout. We recommend that you review your privacy policy and check with your legal contacts. properties: enabled: type: boolean required: - enabled title: phone_number_collection_params type: object restrictions: description: Settings that restrict the usage of a payment link. properties: completed_sessions: properties: limit: type: integer required: - limit title: completed_sessions_params type: object required: - completed_sessions title: restrictions_params type: object shipping_address_collection: description: >- Configuration for collecting the customer's shipping address. properties: allowed_countries: items: enum: - AC - AD - AE - AF - AG - AI - AL - AM - AO - AQ - AR - AT - AU - AW - AX - AZ - BA - BB - BD - BE - BF - BG - BH - BI - BJ - BL - BM - BN - BO - BQ - BR - BS - BT - BV - BW - BY - BZ - CA - CD - CF - CG - CH - CI - CK - CL - CM - CN - CO - CR - CV - CW - CY - CZ - DE - DJ - DK - DM - DO - DZ - EC - EE - EG - EH - ER - ES - ET - FI - FJ - FK - FO - FR - GA - GB - GD - GE - GF - GG - GH - GI - GL - GM - GN - GP - GQ - GR - GS - GT - GU - GW - GY - HK - HN - HR - HT - HU - ID - IE - IL - IM - IN - IO - IQ - IS - IT - JE - JM - JO - JP - KE - KG - KH - KI - KM - KN - KR - KW - KY - KZ - LA - LB - LC - LI - LK - LR - LS - LT - LU - LV - LY - MA - MC - MD - ME - MF - MG - MK - ML - MM - MN - MO - MQ - MR - MS - MT - MU - MV - MW - MX - MY - MZ - NA - NC - NE - NG - NI - NL - 'NO' - NP - NR - NU - NZ - OM - PA - PE - PF - PG - PH - PK - PL - PM - PN - PR - PS - PT - PY - QA - RE - RO - RS - RU - RW - SA - SB - SC - SE - SG - SH - SI - SJ - SK - SL - SM - SN - SO - SR - SS - ST - SV - SX - SZ - TA - TC - TD - TF - TG - TH - TJ - TK - TL - TM - TN - TO - TR - TT - TV - TW - TZ - UA - UG - US - UY - UZ - VA - VC - VE - VG - VN - VU - WF - WS - XK - YE - YT - ZA - ZM - ZW - ZZ type: string type: array required: - allowed_countries title: shipping_address_collection_params type: object shipping_options: description: >- The shipping rate options to apply to [checkout sessions](https://stripe.com/docs/api/checkout/sessions) created by this payment link. items: properties: shipping_rate: maxLength: 5000 type: string title: shipping_option_params type: object type: array submit_type: description: >- Describes the type of transaction being performed in order to customize relevant text on the page, such as the submit button. Changing this value will also affect the hostname in the [url](https://stripe.com/docs/api/payment_links/payment_links/object#url) property (example: `donate.stripe.com`). enum: - auto - book - donate - pay type: string subscription_data: description: >- When creating a subscription, the specified configuration data will be used. There must be at least one line item with a recurring price to use `subscription_data`. properties: description: maxLength: 500 type: string invoice_settings: properties: issuer: properties: account: type: string type: enum: - account - self type: string required: - type title: param type: object title: subscription_data_invoice_settings_params type: object metadata: additionalProperties: type: string type: object trial_period_days: type: integer trial_settings: properties: end_behavior: properties: missing_payment_method: enum: - cancel - create_invoice - pause type: string required: - missing_payment_method title: end_behavior type: object required: - end_behavior title: trial_settings_config type: object title: subscription_data_params type: object tax_id_collection: description: Controls tax ID collection during checkout. properties: enabled: type: boolean required: - enabled title: tax_id_collection_params type: object transfer_data: description: >- The account (if any) the payments will be attributed to for tax reporting, and where funds from each payment will be transferred to. properties: amount: type: integer destination: type: string required: - destination title: transfer_data_params type: object required: - line_items type: object required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/payment_link' description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. '/v1/payment_links/{payment_link}': get: description:

Retrieve a payment link.

operationId: GetPaymentLinksPaymentLink parameters: - description: Specifies which fields in the response should be expanded. explode: true in: query name: expand required: false schema: items: maxLength: 5000 type: string type: array style: deepObject - in: path name: payment_link required: true schema: maxLength: 5000 type: string style: simple requestBody: content: application/x-www-form-urlencoded: encoding: {} schema: additionalProperties: false properties: {} type: object required: false responses: '200': content: application/json: schema: $ref: '#/components/schemas/payment_link' description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. post: description:

Updates a payment link.

operationId: PostPaymentLinksPaymentLink parameters: - in: path name: payment_link required: true schema: maxLength: 5000 type: string style: simple requestBody: content: application/x-www-form-urlencoded: encoding: after_completion: explode: true style: deepObject automatic_tax: explode: true style: deepObject custom_fields: explode: true style: deepObject custom_text: explode: true style: deepObject expand: explode: true style: deepObject inactive_message: explode: true style: deepObject invoice_creation: explode: true style: deepObject line_items: explode: true style: deepObject metadata: explode: true style: deepObject payment_intent_data: explode: true style: deepObject payment_method_types: explode: true style: deepObject restrictions: explode: true style: deepObject shipping_address_collection: explode: true style: deepObject subscription_data: explode: true style: deepObject schema: additionalProperties: false properties: active: description: >- Whether the payment link's `url` is active. If `false`, customers visiting the URL will be shown a page saying that the link has been deactivated. type: boolean after_completion: description: Behavior after the purchase is complete. properties: hosted_confirmation: properties: custom_message: maxLength: 500 type: string title: after_completion_confirmation_page_params type: object redirect: properties: url: maxLength: 2048 type: string required: - url title: after_completion_redirect_params type: object type: enum: - hosted_confirmation - redirect type: string required: - type title: after_completion_params type: object allow_promotion_codes: description: Enables user redeemable promotion codes. type: boolean automatic_tax: description: Configuration for automatic tax collection. properties: enabled: type: boolean liability: properties: account: type: string type: enum: - account - self type: string required: - type title: param type: object required: - enabled title: automatic_tax_params type: object billing_address_collection: description: >- Configuration for collecting the customer's billing address. Defaults to `auto`. enum: - auto - required type: string custom_fields: anyOf: - items: properties: dropdown: properties: options: items: properties: label: maxLength: 100 type: string value: maxLength: 100 type: string required: - label - value title: custom_field_option_param type: object type: array required: - options title: custom_field_dropdown_param type: object key: maxLength: 200 type: string label: properties: custom: maxLength: 50 type: string type: enum: - custom type: string required: - custom - type title: custom_field_label_param type: object numeric: properties: maximum_length: type: integer minimum_length: type: integer title: custom_field_numeric_param type: object optional: type: boolean text: properties: maximum_length: type: integer minimum_length: type: integer title: custom_field_text_param type: object type: enum: - dropdown - numeric - text type: string required: - key - label - type title: custom_field_param type: object type: array - enum: - '' type: string description: >- Collect additional information from your customer using custom fields. Up to 3 fields are supported. custom_text: description: >- Display additional text for your customers using custom text. properties: after_submit: anyOf: - properties: message: maxLength: 1200 type: string required: - message title: custom_text_position_param type: object - enum: - '' type: string shipping_address: anyOf: - properties: message: maxLength: 1200 type: string required: - message title: custom_text_position_param type: object - enum: - '' type: string submit: anyOf: - properties: message: maxLength: 1200 type: string required: - message title: custom_text_position_param type: object - enum: - '' type: string terms_of_service_acceptance: anyOf: - properties: message: maxLength: 1200 type: string required: - message title: custom_text_position_param type: object - enum: - '' type: string title: custom_text_param type: object customer_creation: description: >- Configures whether [checkout sessions](https://stripe.com/docs/api/checkout/sessions) created by this payment link create a [Customer](https://stripe.com/docs/api/customers). enum: - always - if_required type: string expand: description: Specifies which fields in the response should be expanded. items: maxLength: 5000 type: string type: array inactive_message: anyOf: - maxLength: 500 type: string - enum: - '' type: string description: >- The custom message to be displayed to a customer when a payment link is no longer active. invoice_creation: description: Generate a post-purchase Invoice for one-time payments. properties: enabled: type: boolean invoice_data: properties: account_tax_ids: anyOf: - items: maxLength: 5000 type: string type: array - enum: - '' type: string custom_fields: anyOf: - items: properties: name: maxLength: 40 type: string value: maxLength: 140 type: string required: - name - value title: custom_field_params type: object type: array - enum: - '' type: string description: maxLength: 1500 type: string footer: maxLength: 5000 type: string issuer: properties: account: type: string type: enum: - account - self type: string required: - type title: param type: object metadata: anyOf: - additionalProperties: type: string type: object - enum: - '' type: string rendering_options: anyOf: - properties: amount_tax_display: enum: - '' - exclude_tax - include_inclusive_tax type: string title: rendering_options_param type: object - enum: - '' type: string title: invoice_settings_params type: object required: - enabled title: invoice_creation_update_params type: object line_items: description: >- The line items representing what is being sold. Each line item represents an item being sold. Up to 20 line items are supported. items: properties: adjustable_quantity: properties: enabled: type: boolean maximum: type: integer minimum: type: integer required: - enabled title: adjustable_quantity_params type: object id: maxLength: 5000 type: string quantity: type: integer required: - id title: line_items_update_params type: object type: array metadata: additionalProperties: type: string description: >- Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. Metadata associated with this Payment Link will automatically be copied to [checkout sessions](https://stripe.com/docs/api/checkout/sessions) created by this payment link. type: object payment_intent_data: description: >- A subset of parameters to be passed to PaymentIntent creation for Checkout Sessions in `payment` mode. properties: description: anyOf: - maxLength: 1000 type: string - enum: - '' type: string metadata: anyOf: - additionalProperties: type: string type: object - enum: - '' type: string statement_descriptor: anyOf: - maxLength: 22 type: string - enum: - '' type: string statement_descriptor_suffix: anyOf: - maxLength: 22 type: string - enum: - '' type: string transfer_group: anyOf: - maxLength: 5000 type: string - enum: - '' type: string title: payment_intent_data_update_params type: object payment_method_collection: description: >- Specify whether Checkout should collect a payment method. When set to `if_required`, Checkout will not collect a payment method when the total due for the session is 0.This may occur if the Checkout Session includes a free trial or a discount. Can only be set in `subscription` mode. Defaults to `always`. If you'd like information on how to collect a payment method outside of Checkout, read the guide on [configuring subscriptions with a free trial](https://stripe.com/docs/payments/checkout/free-trials). enum: - always - if_required type: string payment_method_types: anyOf: - items: enum: - affirm - afterpay_clearpay - alipay - au_becs_debit - bacs_debit - bancontact - blik - boleto - card - cashapp - eps - fpx - giropay - grabpay - ideal - klarna - konbini - link - oxxo - p24 - paynow - paypal - pix - promptpay - sepa_debit - sofort - swish - us_bank_account - wechat_pay type: string x-stripeBypassValidation: true type: array - enum: - '' type: string description: >- The list of payment method types that customers can use. Pass an empty string to enable dynamic payment methods that use your [payment method settings](https://dashboard.stripe.com/settings/payment_methods). restrictions: anyOf: - properties: completed_sessions: properties: limit: type: integer required: - limit title: completed_sessions_params type: object required: - completed_sessions title: restrictions_params type: object - enum: - '' type: string description: Settings that restrict the usage of a payment link. shipping_address_collection: anyOf: - properties: allowed_countries: items: enum: - AC - AD - AE - AF - AG - AI - AL - AM - AO - AQ - AR - AT - AU - AW - AX - AZ - BA - BB - BD - BE - BF - BG - BH - BI - BJ - BL - BM - BN - BO - BQ - BR - BS - BT - BV - BW - BY - BZ - CA - CD - CF - CG - CH - CI - CK - CL - CM - CN - CO - CR - CV - CW - CY - CZ - DE - DJ - DK - DM - DO - DZ - EC - EE - EG - EH - ER - ES - ET - FI - FJ - FK - FO - FR - GA - GB - GD - GE - GF - GG - GH - GI - GL - GM - GN - GP - GQ - GR - GS - GT - GU - GW - GY - HK - HN - HR - HT - HU - ID - IE - IL - IM - IN - IO - IQ - IS - IT - JE - JM - JO - JP - KE - KG - KH - KI - KM - KN - KR - KW - KY - KZ - LA - LB - LC - LI - LK - LR - LS - LT - LU - LV - LY - MA - MC - MD - ME - MF - MG - MK - ML - MM - MN - MO - MQ - MR - MS - MT - MU - MV - MW - MX - MY - MZ - NA - NC - NE - NG - NI - NL - 'NO' - NP - NR - NU - NZ - OM - PA - PE - PF - PG - PH - PK - PL - PM - PN - PR - PS - PT - PY - QA - RE - RO - RS - RU - RW - SA - SB - SC - SE - SG - SH - SI - SJ - SK - SL - SM - SN - SO - SR - SS - ST - SV - SX - SZ - TA - TC - TD - TF - TG - TH - TJ - TK - TL - TM - TN - TO - TR - TT - TV - TW - TZ - UA - UG - US - UY - UZ - VA - VC - VE - VG - VN - VU - WF - WS - XK - YE - YT - ZA - ZM - ZW - ZZ type: string type: array required: - allowed_countries title: shipping_address_collection_params type: object - enum: - '' type: string description: >- Configuration for collecting the customer's shipping address. subscription_data: description: >- When creating a subscription, the specified configuration data will be used. There must be at least one line item with a recurring price to use `subscription_data`. properties: invoice_settings: properties: issuer: properties: account: type: string type: enum: - account - self type: string required: - type title: param type: object title: subscription_data_invoice_settings_params type: object metadata: anyOf: - additionalProperties: type: string type: object - enum: - '' type: string trial_settings: anyOf: - properties: end_behavior: properties: missing_payment_method: enum: - cancel - create_invoice - pause type: string required: - missing_payment_method title: end_behavior type: object required: - end_behavior title: trial_settings_config type: object - enum: - '' type: string title: subscription_data_update_params type: object type: object required: false responses: '200': content: application/json: schema: $ref: '#/components/schemas/payment_link' description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. '/v1/payment_links/{payment_link}/line_items': get: description: >-

When retrieving a payment link, there is an includable line_items property containing the first handful of those items. There is also a URL where you can retrieve the full (paginated) list of line items.

operationId: GetPaymentLinksPaymentLinkLineItems parameters: - description: >- A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. in: query name: ending_before required: false schema: maxLength: 5000 type: string style: form - description: Specifies which fields in the response should be expanded. explode: true in: query name: expand required: false schema: items: maxLength: 5000 type: string type: array style: deepObject - description: >- A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. in: query name: limit required: false schema: type: integer style: form - in: path name: payment_link required: true schema: maxLength: 5000 type: string style: simple - description: >- A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. in: query name: starting_after required: false schema: maxLength: 5000 type: string style: form requestBody: content: application/x-www-form-urlencoded: encoding: {} schema: additionalProperties: false properties: {} type: object required: false responses: '200': content: application/json: schema: description: '' properties: data: description: Details about each object. items: $ref: '#/components/schemas/item' type: array has_more: description: >- True if this list has another page of items after this one that can be fetched. type: boolean object: description: >- String representing the object's type. Objects of the same type share the same value. Always has the value `list`. enum: - list type: string url: description: The URL where this list can be accessed. maxLength: 5000 type: string required: - data - has_more - object - url title: PaymentLinksResourceListLineItems type: object x-expandableFields: - data description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. /v1/payment_method_configurations: get: description:

List payment method configurations

operationId: GetPaymentMethodConfigurations parameters: - description: The Connect application to filter by. explode: true in: query name: application required: false schema: anyOf: - maxLength: 100 type: string - enum: - '' type: string style: deepObject - description: Specifies which fields in the response should be expanded. explode: true in: query name: expand required: false schema: items: maxLength: 5000 type: string type: array style: deepObject requestBody: content: application/x-www-form-urlencoded: encoding: {} schema: additionalProperties: false properties: {} type: object required: false responses: '200': content: application/json: schema: description: '' properties: data: items: $ref: '#/components/schemas/payment_method_configuration' type: array has_more: description: >- True if this list has another page of items after this one that can be fetched. type: boolean object: description: >- String representing the object's type. Objects of the same type share the same value. Always has the value `list`. enum: - list type: string url: description: The URL where this list can be accessed. maxLength: 5000 type: string required: - data - has_more - object - url title: PaymentMethodConfigResourcePaymentMethodConfigurationsList type: object x-expandableFields: - data description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. post: description:

Creates a payment method configuration

operationId: PostPaymentMethodConfigurations requestBody: content: application/x-www-form-urlencoded: encoding: acss_debit: explode: true style: deepObject affirm: explode: true style: deepObject afterpay_clearpay: explode: true style: deepObject alipay: explode: true style: deepObject amazon_pay: explode: true style: deepObject apple_pay: explode: true style: deepObject apple_pay_later: explode: true style: deepObject au_becs_debit: explode: true style: deepObject bacs_debit: explode: true style: deepObject bancontact: explode: true style: deepObject blik: explode: true style: deepObject boleto: explode: true style: deepObject card: explode: true style: deepObject cartes_bancaires: explode: true style: deepObject cashapp: explode: true style: deepObject customer_balance: explode: true style: deepObject eps: explode: true style: deepObject expand: explode: true style: deepObject fpx: explode: true style: deepObject giropay: explode: true style: deepObject google_pay: explode: true style: deepObject grabpay: explode: true style: deepObject ideal: explode: true style: deepObject jcb: explode: true style: deepObject klarna: explode: true style: deepObject konbini: explode: true style: deepObject link: explode: true style: deepObject oxxo: explode: true style: deepObject p24: explode: true style: deepObject paynow: explode: true style: deepObject paypal: explode: true style: deepObject promptpay: explode: true style: deepObject revolut_pay: explode: true style: deepObject sepa_debit: explode: true style: deepObject sofort: explode: true style: deepObject swish: explode: true style: deepObject us_bank_account: explode: true style: deepObject wechat_pay: explode: true style: deepObject zip: explode: true style: deepObject schema: additionalProperties: false properties: acss_debit: description: >- Canadian pre-authorized debit payments, check this [page](https://stripe.com/docs/payments/acss-debit) for more details like country availability. properties: display_preference: properties: preference: enum: - none - 'off' - 'on' type: string title: display_preference_param type: object title: payment_method_param type: object affirm: description: >- [Affirm](https://www.affirm.com/) gives your customers a way to split purchases over a series of payments. Depending on the purchase, they can pay with four interest-free payments (Split Pay) or pay over a longer term (Installments), which might include interest. Check this [page](https://stripe.com/docs/payments/affirm) for more details like country availability. properties: display_preference: properties: preference: enum: - none - 'off' - 'on' type: string title: display_preference_param type: object title: payment_method_param type: object afterpay_clearpay: description: >- Afterpay gives your customers a way to pay for purchases in installments, check this [page](https://stripe.com/docs/payments/afterpay-clearpay) for more details like country availability. Afterpay is particularly popular among businesses selling fashion, beauty, and sports products. properties: display_preference: properties: preference: enum: - none - 'off' - 'on' type: string title: display_preference_param type: object title: payment_method_param type: object alipay: description: >- Alipay is a digital wallet in China that has more than a billion active users worldwide. Alipay users can pay on the web or on a mobile device using login credentials or their Alipay app. Alipay has a low dispute rate and reduces fraud by authenticating payments using the customer's login credentials. Check this [page](https://stripe.com/docs/payments/alipay) for more details. properties: display_preference: properties: preference: enum: - none - 'off' - 'on' type: string title: display_preference_param type: object title: payment_method_param type: object amazon_pay: description: >- Amazon Pay is a wallet payment method that lets your customers check out the same way as on Amazon. properties: display_preference: properties: preference: enum: - none - 'off' - 'on' type: string title: display_preference_param type: object title: payment_method_param type: object apple_pay: description: >- Stripe users can accept [Apple Pay](/payments/apple-pay) in iOS applications in iOS 9 and later, and on the web in Safari starting with iOS 10 or macOS Sierra. There are no additional fees to process Apple Pay payments, and the [pricing](/pricing) is the same as other card transactions. Check this [page](https://stripe.com/docs/apple-pay) for more details. properties: display_preference: properties: preference: enum: - none - 'off' - 'on' type: string title: display_preference_param type: object title: payment_method_param type: object apple_pay_later: description: >- Apple Pay Later, a payment method for customers to buy now and pay later, gives your customers a way to split purchases into four installments across six weeks. properties: display_preference: properties: preference: enum: - none - 'off' - 'on' type: string title: display_preference_param type: object title: payment_method_param type: object au_becs_debit: description: >- Stripe users in Australia can accept Bulk Electronic Clearing System (BECS) direct debit payments from customers with an Australian bank account. Check this [page](https://stripe.com/docs/payments/au-becs-debit) for more details. properties: display_preference: properties: preference: enum: - none - 'off' - 'on' type: string title: display_preference_param type: object title: payment_method_param type: object bacs_debit: description: >- Stripe users in the UK can accept Bacs Direct Debit payments from customers with a UK bank account, check this [page](https://stripe.com/docs/payments/payment-methods/bacs-debit) for more details. properties: display_preference: properties: preference: enum: - none - 'off' - 'on' type: string title: display_preference_param type: object title: payment_method_param type: object bancontact: description: >- Bancontact is the most popular online payment method in Belgium, with over 15 million cards in circulation. [Customers](https://stripe.com/docs/api/customers) use a Bancontact card or mobile app linked to a Belgian bank account to make online payments that are secure, guaranteed, and confirmed immediately. Check this [page](https://stripe.com/docs/payments/bancontact) for more details. properties: display_preference: properties: preference: enum: - none - 'off' - 'on' type: string title: display_preference_param type: object title: payment_method_param type: object blik: description: >- BLIK is a [single use](https://stripe.com/docs/payments/payment-methods#usage) payment method that requires customers to authenticate their payments. When customers want to pay online using BLIK, they request a six-digit code from their banking application and enter it into the payment collection form. Check this [page](https://stripe.com/docs/payments/blik) for more details. properties: display_preference: properties: preference: enum: - none - 'off' - 'on' type: string title: display_preference_param type: object title: payment_method_param type: object boleto: description: >- Boleto is an official (regulated by the Central Bank of Brazil) payment method in Brazil. Check this [page](https://stripe.com/docs/payments/boleto) for more details. properties: display_preference: properties: preference: enum: - none - 'off' - 'on' type: string title: display_preference_param type: object title: payment_method_param type: object card: description: >- Cards are a popular way for consumers and businesses to pay online or in person. Stripe supports global and local card networks. properties: display_preference: properties: preference: enum: - none - 'off' - 'on' type: string title: display_preference_param type: object title: payment_method_param type: object cartes_bancaires: description: >- Cartes Bancaires is France's local card network. More than 95% of these cards are co-branded with either Visa or Mastercard, meaning you can process these cards over either Cartes Bancaires or the Visa or Mastercard networks. Check this [page](https://stripe.com/docs/payments/cartes-bancaires) for more details. properties: display_preference: properties: preference: enum: - none - 'off' - 'on' type: string title: display_preference_param type: object title: payment_method_param type: object cashapp: description: >- Cash App is a popular consumer app in the US that allows customers to bank, invest, send, and receive money using their digital wallet. Check this [page](https://stripe.com/docs/payments/cash-app-pay) for more details. properties: display_preference: properties: preference: enum: - none - 'off' - 'on' type: string title: display_preference_param type: object title: payment_method_param type: object customer_balance: description: >- Uses a customer’s [cash balance](https://stripe.com/docs/payments/customer-balance) for the payment. The cash balance can be funded via a bank transfer. Check this [page](https://stripe.com/docs/payments/bank-transfers) for more details. properties: display_preference: properties: preference: enum: - none - 'off' - 'on' type: string title: display_preference_param type: object title: payment_method_param type: object eps: description: >- EPS is an Austria-based payment method that allows customers to complete transactions online using their bank credentials. EPS is supported by all Austrian banks and is accepted by over 80% of Austrian online retailers. Check this [page](https://stripe.com/docs/payments/eps) for more details. properties: display_preference: properties: preference: enum: - none - 'off' - 'on' type: string title: display_preference_param type: object title: payment_method_param type: object expand: description: Specifies which fields in the response should be expanded. items: maxLength: 5000 type: string type: array fpx: description: >- Financial Process Exchange (FPX) is a Malaysia-based payment method that allows customers to complete transactions online using their bank credentials. Bank Negara Malaysia (BNM), the Central Bank of Malaysia, and eleven other major Malaysian financial institutions are members of the PayNet Group, which owns and operates FPX. It is one of the most popular online payment methods in Malaysia, with nearly 90 million transactions in 2018 according to BNM. Check this [page](https://stripe.com/docs/payments/fpx) for more details. properties: display_preference: properties: preference: enum: - none - 'off' - 'on' type: string title: display_preference_param type: object title: payment_method_param type: object giropay: description: >- giropay is a German payment method based on online banking, introduced in 2006. It allows customers to complete transactions online using their online banking environment, with funds debited from their bank account. Depending on their bank, customers confirm payments on giropay using a second factor of authentication or a PIN. giropay accounts for 10% of online checkouts in Germany. Check this [page](https://stripe.com/docs/payments/giropay) for more details. properties: display_preference: properties: preference: enum: - none - 'off' - 'on' type: string title: display_preference_param type: object title: payment_method_param type: object google_pay: description: >- Google Pay allows customers to make payments in your app or website using any credit or debit card saved to their Google Account, including those from Google Play, YouTube, Chrome, or an Android device. Use the Google Pay API to request any credit or debit card stored in your customer's Google account. Check this [page](https://stripe.com/docs/google-pay) for more details. properties: display_preference: properties: preference: enum: - none - 'off' - 'on' type: string title: display_preference_param type: object title: payment_method_param type: object grabpay: description: >- GrabPay is a payment method developed by [Grab](https://www.grab.com/sg/consumer/finance/pay/). GrabPay is a digital wallet - customers maintain a balance in their wallets that they pay out with. Check this [page](https://stripe.com/docs/payments/grabpay) for more details. properties: display_preference: properties: preference: enum: - none - 'off' - 'on' type: string title: display_preference_param type: object title: payment_method_param type: object ideal: description: >- iDEAL is a Netherlands-based payment method that allows customers to complete transactions online using their bank credentials. All major Dutch banks are members of Currence, the scheme that operates iDEAL, making it the most popular online payment method in the Netherlands with a share of online transactions close to 55%. Check this [page](https://stripe.com/docs/payments/ideal) for more details. properties: display_preference: properties: preference: enum: - none - 'off' - 'on' type: string title: display_preference_param type: object title: payment_method_param type: object jcb: description: >- JCB is a credit card company based in Japan. JCB is currently available in Japan to businesses approved by JCB, and available to all businesses in Australia, Canada, Hong Kong, Japan, New Zealand, Singapore, Switzerland, United Kingdom, United States, and all countries in the European Economic Area except Iceland. Check this [page](https://support.stripe.com/questions/accepting-japan-credit-bureau-%28jcb%29-payments) for more details. properties: display_preference: properties: preference: enum: - none - 'off' - 'on' type: string title: display_preference_param type: object title: payment_method_param type: object klarna: description: >- Klarna gives customers a range of [payment options](https://stripe.com/docs/payments/klarna#payment-options) during checkout. Available payment options vary depending on the customer's billing address and the transaction amount. These payment options make it convenient for customers to purchase items in all price ranges. Check this [page](https://stripe.com/docs/payments/klarna) for more details. properties: display_preference: properties: preference: enum: - none - 'off' - 'on' type: string title: display_preference_param type: object title: payment_method_param type: object konbini: description: >- Konbini allows customers in Japan to pay for bills and online purchases at convenience stores with cash. Check this [page](https://stripe.com/docs/payments/konbini) for more details. properties: display_preference: properties: preference: enum: - none - 'off' - 'on' type: string title: display_preference_param type: object title: payment_method_param type: object link: description: >- [Link](https://stripe.com/docs/payments/link) is a payment method network. With Link, users save their payment details once, then reuse that information to pay with one click for any business on the network. properties: display_preference: properties: preference: enum: - none - 'off' - 'on' type: string title: display_preference_param type: object title: payment_method_param type: object name: description: Configuration name. maxLength: 100 type: string oxxo: description: >- OXXO is a Mexican chain of convenience stores with thousands of locations across Latin America and represents nearly 20% of online transactions in Mexico. OXXO allows customers to pay bills and online purchases in-store with cash. Check this [page](https://stripe.com/docs/payments/oxxo) for more details. properties: display_preference: properties: preference: enum: - none - 'off' - 'on' type: string title: display_preference_param type: object title: payment_method_param type: object p24: description: >- Przelewy24 is a Poland-based payment method aggregator that allows customers to complete transactions online using bank transfers and other methods. Bank transfers account for 30% of online payments in Poland and Przelewy24 provides a way for customers to pay with over 165 banks. Check this [page](https://stripe.com/docs/payments/p24) for more details. properties: display_preference: properties: preference: enum: - none - 'off' - 'on' type: string title: display_preference_param type: object title: payment_method_param type: object parent: description: >- Configuration's parent configuration. Specify to create a child configuration. maxLength: 100 type: string paynow: description: >- PayNow is a Singapore-based payment method that allows customers to make a payment using their preferred app from participating banks and participating non-bank financial institutions. Check this [page](https://stripe.com/docs/payments/paynow) for more details. properties: display_preference: properties: preference: enum: - none - 'off' - 'on' type: string title: display_preference_param type: object title: payment_method_param type: object paypal: description: >- PayPal, a digital wallet popular with customers in Europe, allows your customers worldwide to pay using their PayPal account. Check this [page](https://stripe.com/docs/payments/paypal) for more details. properties: display_preference: properties: preference: enum: - none - 'off' - 'on' type: string title: display_preference_param type: object title: payment_method_param type: object promptpay: description: >- PromptPay is a Thailand-based payment method that allows customers to make a payment using their preferred app from participating banks. Check this [page](https://stripe.com/docs/payments/promptpay) for more details. properties: display_preference: properties: preference: enum: - none - 'off' - 'on' type: string title: display_preference_param type: object title: payment_method_param type: object revolut_pay: description: >- Revolut Pay, developed by Revolut, a global finance app, is a digital wallet payment method. Revolut Pay uses the customer’s stored balance or cards to fund the payment, and offers the option for non-Revolut customers to save their details after their first purchase. properties: display_preference: properties: preference: enum: - none - 'off' - 'on' type: string title: display_preference_param type: object title: payment_method_param type: object sepa_debit: description: >- The [Single Euro Payments Area (SEPA)](https://en.wikipedia.org/wiki/Single_Euro_Payments_Area) is an initiative of the European Union to simplify payments within and across member countries. SEPA established and enforced banking standards to allow for the direct debiting of every EUR-denominated bank account within the SEPA region, check this [page](https://stripe.com/docs/payments/sepa-debit) for more details. properties: display_preference: properties: preference: enum: - none - 'off' - 'on' type: string title: display_preference_param type: object title: payment_method_param type: object sofort: description: >- Stripe users in Europe and the United States can use the [Payment Intents API](https://stripe.com/docs/payments/payment-intents)—a single integration path for creating payments using any supported method—to accept [Sofort](https://www.sofort.com/) payments from customers. Check this [page](https://stripe.com/docs/payments/sofort) for more details. properties: display_preference: properties: preference: enum: - none - 'off' - 'on' type: string title: display_preference_param type: object title: payment_method_param type: object swish: description: >- Swish is a [real-time](https://stripe.com/docs/payments/real-time) payment method popular in Sweden. It allows customers to [authenticate and approve](https://stripe.com/docs/payments/payment-methods#customer-actions) payments using the Swish mobile app and the Swedish BankID mobile app. Check this [page](https://stripe.com/docs/payments/swish) for more details. properties: display_preference: properties: preference: enum: - none - 'off' - 'on' type: string title: display_preference_param type: object title: payment_method_param type: object us_bank_account: description: >- Stripe users in the United States can accept ACH direct debit payments from customers with a US bank account using the Automated Clearing House (ACH) payments system operated by Nacha. Check this [page](https://stripe.com/docs/payments/ach-debit) for more details. properties: display_preference: properties: preference: enum: - none - 'off' - 'on' type: string title: display_preference_param type: object title: payment_method_param type: object wechat_pay: description: >- WeChat, owned by Tencent, is China's leading mobile app with over 1 billion monthly active users. Chinese consumers can use WeChat Pay to pay for goods and services inside of businesses' apps and websites. WeChat Pay users buy most frequently in gaming, e-commerce, travel, online education, and food/nutrition. Check this [page](https://stripe.com/docs/payments/wechat-pay) for more details. properties: display_preference: properties: preference: enum: - none - 'off' - 'on' type: string title: display_preference_param type: object title: payment_method_param type: object zip: description: >- Zip gives your customers a way to split purchases over a series of payments. Check this [page](https://stripe.com/docs/payments/zip) for more details like country availability. properties: display_preference: properties: preference: enum: - none - 'off' - 'on' type: string title: display_preference_param type: object title: payment_method_param type: object type: object required: false responses: '200': content: application/json: schema: $ref: '#/components/schemas/payment_method_configuration' description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. '/v1/payment_method_configurations/{configuration}': get: description:

Retrieve payment method configuration

operationId: GetPaymentMethodConfigurationsConfiguration parameters: - in: path name: configuration required: true schema: maxLength: 5000 type: string style: simple - description: Specifies which fields in the response should be expanded. explode: true in: query name: expand required: false schema: items: maxLength: 5000 type: string type: array style: deepObject requestBody: content: application/x-www-form-urlencoded: encoding: {} schema: additionalProperties: false properties: {} type: object required: false responses: '200': content: application/json: schema: $ref: '#/components/schemas/payment_method_configuration' description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. post: description:

Update payment method configuration

operationId: PostPaymentMethodConfigurationsConfiguration parameters: - in: path name: configuration required: true schema: maxLength: 5000 type: string style: simple requestBody: content: application/x-www-form-urlencoded: encoding: acss_debit: explode: true style: deepObject affirm: explode: true style: deepObject afterpay_clearpay: explode: true style: deepObject alipay: explode: true style: deepObject amazon_pay: explode: true style: deepObject apple_pay: explode: true style: deepObject apple_pay_later: explode: true style: deepObject au_becs_debit: explode: true style: deepObject bacs_debit: explode: true style: deepObject bancontact: explode: true style: deepObject blik: explode: true style: deepObject boleto: explode: true style: deepObject card: explode: true style: deepObject cartes_bancaires: explode: true style: deepObject cashapp: explode: true style: deepObject customer_balance: explode: true style: deepObject eps: explode: true style: deepObject expand: explode: true style: deepObject fpx: explode: true style: deepObject giropay: explode: true style: deepObject google_pay: explode: true style: deepObject grabpay: explode: true style: deepObject ideal: explode: true style: deepObject jcb: explode: true style: deepObject klarna: explode: true style: deepObject konbini: explode: true style: deepObject link: explode: true style: deepObject oxxo: explode: true style: deepObject p24: explode: true style: deepObject paynow: explode: true style: deepObject paypal: explode: true style: deepObject promptpay: explode: true style: deepObject revolut_pay: explode: true style: deepObject sepa_debit: explode: true style: deepObject sofort: explode: true style: deepObject swish: explode: true style: deepObject us_bank_account: explode: true style: deepObject wechat_pay: explode: true style: deepObject zip: explode: true style: deepObject schema: additionalProperties: false properties: acss_debit: description: >- Canadian pre-authorized debit payments, check this [page](https://stripe.com/docs/payments/acss-debit) for more details like country availability. properties: display_preference: properties: preference: enum: - none - 'off' - 'on' type: string title: display_preference_param type: object title: payment_method_param type: object active: description: Whether the configuration can be used for new payments. type: boolean affirm: description: >- [Affirm](https://www.affirm.com/) gives your customers a way to split purchases over a series of payments. Depending on the purchase, they can pay with four interest-free payments (Split Pay) or pay over a longer term (Installments), which might include interest. Check this [page](https://stripe.com/docs/payments/affirm) for more details like country availability. properties: display_preference: properties: preference: enum: - none - 'off' - 'on' type: string title: display_preference_param type: object title: payment_method_param type: object afterpay_clearpay: description: >- Afterpay gives your customers a way to pay for purchases in installments, check this [page](https://stripe.com/docs/payments/afterpay-clearpay) for more details like country availability. Afterpay is particularly popular among businesses selling fashion, beauty, and sports products. properties: display_preference: properties: preference: enum: - none - 'off' - 'on' type: string title: display_preference_param type: object title: payment_method_param type: object alipay: description: >- Alipay is a digital wallet in China that has more than a billion active users worldwide. Alipay users can pay on the web or on a mobile device using login credentials or their Alipay app. Alipay has a low dispute rate and reduces fraud by authenticating payments using the customer's login credentials. Check this [page](https://stripe.com/docs/payments/alipay) for more details. properties: display_preference: properties: preference: enum: - none - 'off' - 'on' type: string title: display_preference_param type: object title: payment_method_param type: object amazon_pay: description: >- Amazon Pay is a wallet payment method that lets your customers check out the same way as on Amazon. properties: display_preference: properties: preference: enum: - none - 'off' - 'on' type: string title: display_preference_param type: object title: payment_method_param type: object apple_pay: description: >- Stripe users can accept [Apple Pay](/payments/apple-pay) in iOS applications in iOS 9 and later, and on the web in Safari starting with iOS 10 or macOS Sierra. There are no additional fees to process Apple Pay payments, and the [pricing](/pricing) is the same as other card transactions. Check this [page](https://stripe.com/docs/apple-pay) for more details. properties: display_preference: properties: preference: enum: - none - 'off' - 'on' type: string title: display_preference_param type: object title: payment_method_param type: object apple_pay_later: description: >- Apple Pay Later, a payment method for customers to buy now and pay later, gives your customers a way to split purchases into four installments across six weeks. properties: display_preference: properties: preference: enum: - none - 'off' - 'on' type: string title: display_preference_param type: object title: payment_method_param type: object au_becs_debit: description: >- Stripe users in Australia can accept Bulk Electronic Clearing System (BECS) direct debit payments from customers with an Australian bank account. Check this [page](https://stripe.com/docs/payments/au-becs-debit) for more details. properties: display_preference: properties: preference: enum: - none - 'off' - 'on' type: string title: display_preference_param type: object title: payment_method_param type: object bacs_debit: description: >- Stripe users in the UK can accept Bacs Direct Debit payments from customers with a UK bank account, check this [page](https://stripe.com/docs/payments/payment-methods/bacs-debit) for more details. properties: display_preference: properties: preference: enum: - none - 'off' - 'on' type: string title: display_preference_param type: object title: payment_method_param type: object bancontact: description: >- Bancontact is the most popular online payment method in Belgium, with over 15 million cards in circulation. [Customers](https://stripe.com/docs/api/customers) use a Bancontact card or mobile app linked to a Belgian bank account to make online payments that are secure, guaranteed, and confirmed immediately. Check this [page](https://stripe.com/docs/payments/bancontact) for more details. properties: display_preference: properties: preference: enum: - none - 'off' - 'on' type: string title: display_preference_param type: object title: payment_method_param type: object blik: description: >- BLIK is a [single use](https://stripe.com/docs/payments/payment-methods#usage) payment method that requires customers to authenticate their payments. When customers want to pay online using BLIK, they request a six-digit code from their banking application and enter it into the payment collection form. Check this [page](https://stripe.com/docs/payments/blik) for more details. properties: display_preference: properties: preference: enum: - none - 'off' - 'on' type: string title: display_preference_param type: object title: payment_method_param type: object boleto: description: >- Boleto is an official (regulated by the Central Bank of Brazil) payment method in Brazil. Check this [page](https://stripe.com/docs/payments/boleto) for more details. properties: display_preference: properties: preference: enum: - none - 'off' - 'on' type: string title: display_preference_param type: object title: payment_method_param type: object card: description: >- Cards are a popular way for consumers and businesses to pay online or in person. Stripe supports global and local card networks. properties: display_preference: properties: preference: enum: - none - 'off' - 'on' type: string title: display_preference_param type: object title: payment_method_param type: object cartes_bancaires: description: >- Cartes Bancaires is France's local card network. More than 95% of these cards are co-branded with either Visa or Mastercard, meaning you can process these cards over either Cartes Bancaires or the Visa or Mastercard networks. Check this [page](https://stripe.com/docs/payments/cartes-bancaires) for more details. properties: display_preference: properties: preference: enum: - none - 'off' - 'on' type: string title: display_preference_param type: object title: payment_method_param type: object cashapp: description: >- Cash App is a popular consumer app in the US that allows customers to bank, invest, send, and receive money using their digital wallet. Check this [page](https://stripe.com/docs/payments/cash-app-pay) for more details. properties: display_preference: properties: preference: enum: - none - 'off' - 'on' type: string title: display_preference_param type: object title: payment_method_param type: object customer_balance: description: >- Uses a customer’s [cash balance](https://stripe.com/docs/payments/customer-balance) for the payment. The cash balance can be funded via a bank transfer. Check this [page](https://stripe.com/docs/payments/bank-transfers) for more details. properties: display_preference: properties: preference: enum: - none - 'off' - 'on' type: string title: display_preference_param type: object title: payment_method_param type: object eps: description: >- EPS is an Austria-based payment method that allows customers to complete transactions online using their bank credentials. EPS is supported by all Austrian banks and is accepted by over 80% of Austrian online retailers. Check this [page](https://stripe.com/docs/payments/eps) for more details. properties: display_preference: properties: preference: enum: - none - 'off' - 'on' type: string title: display_preference_param type: object title: payment_method_param type: object expand: description: Specifies which fields in the response should be expanded. items: maxLength: 5000 type: string type: array fpx: description: >- Financial Process Exchange (FPX) is a Malaysia-based payment method that allows customers to complete transactions online using their bank credentials. Bank Negara Malaysia (BNM), the Central Bank of Malaysia, and eleven other major Malaysian financial institutions are members of the PayNet Group, which owns and operates FPX. It is one of the most popular online payment methods in Malaysia, with nearly 90 million transactions in 2018 according to BNM. Check this [page](https://stripe.com/docs/payments/fpx) for more details. properties: display_preference: properties: preference: enum: - none - 'off' - 'on' type: string title: display_preference_param type: object title: payment_method_param type: object giropay: description: >- giropay is a German payment method based on online banking, introduced in 2006. It allows customers to complete transactions online using their online banking environment, with funds debited from their bank account. Depending on their bank, customers confirm payments on giropay using a second factor of authentication or a PIN. giropay accounts for 10% of online checkouts in Germany. Check this [page](https://stripe.com/docs/payments/giropay) for more details. properties: display_preference: properties: preference: enum: - none - 'off' - 'on' type: string title: display_preference_param type: object title: payment_method_param type: object google_pay: description: >- Google Pay allows customers to make payments in your app or website using any credit or debit card saved to their Google Account, including those from Google Play, YouTube, Chrome, or an Android device. Use the Google Pay API to request any credit or debit card stored in your customer's Google account. Check this [page](https://stripe.com/docs/google-pay) for more details. properties: display_preference: properties: preference: enum: - none - 'off' - 'on' type: string title: display_preference_param type: object title: payment_method_param type: object grabpay: description: >- GrabPay is a payment method developed by [Grab](https://www.grab.com/sg/consumer/finance/pay/). GrabPay is a digital wallet - customers maintain a balance in their wallets that they pay out with. Check this [page](https://stripe.com/docs/payments/grabpay) for more details. properties: display_preference: properties: preference: enum: - none - 'off' - 'on' type: string title: display_preference_param type: object title: payment_method_param type: object ideal: description: >- iDEAL is a Netherlands-based payment method that allows customers to complete transactions online using their bank credentials. All major Dutch banks are members of Currence, the scheme that operates iDEAL, making it the most popular online payment method in the Netherlands with a share of online transactions close to 55%. Check this [page](https://stripe.com/docs/payments/ideal) for more details. properties: display_preference: properties: preference: enum: - none - 'off' - 'on' type: string title: display_preference_param type: object title: payment_method_param type: object jcb: description: >- JCB is a credit card company based in Japan. JCB is currently available in Japan to businesses approved by JCB, and available to all businesses in Australia, Canada, Hong Kong, Japan, New Zealand, Singapore, Switzerland, United Kingdom, United States, and all countries in the European Economic Area except Iceland. Check this [page](https://support.stripe.com/questions/accepting-japan-credit-bureau-%28jcb%29-payments) for more details. properties: display_preference: properties: preference: enum: - none - 'off' - 'on' type: string title: display_preference_param type: object title: payment_method_param type: object klarna: description: >- Klarna gives customers a range of [payment options](https://stripe.com/docs/payments/klarna#payment-options) during checkout. Available payment options vary depending on the customer's billing address and the transaction amount. These payment options make it convenient for customers to purchase items in all price ranges. Check this [page](https://stripe.com/docs/payments/klarna) for more details. properties: display_preference: properties: preference: enum: - none - 'off' - 'on' type: string title: display_preference_param type: object title: payment_method_param type: object konbini: description: >- Konbini allows customers in Japan to pay for bills and online purchases at convenience stores with cash. Check this [page](https://stripe.com/docs/payments/konbini) for more details. properties: display_preference: properties: preference: enum: - none - 'off' - 'on' type: string title: display_preference_param type: object title: payment_method_param type: object link: description: >- [Link](https://stripe.com/docs/payments/link) is a payment method network. With Link, users save their payment details once, then reuse that information to pay with one click for any business on the network. properties: display_preference: properties: preference: enum: - none - 'off' - 'on' type: string title: display_preference_param type: object title: payment_method_param type: object name: description: Configuration name. maxLength: 100 type: string oxxo: description: >- OXXO is a Mexican chain of convenience stores with thousands of locations across Latin America and represents nearly 20% of online transactions in Mexico. OXXO allows customers to pay bills and online purchases in-store with cash. Check this [page](https://stripe.com/docs/payments/oxxo) for more details. properties: display_preference: properties: preference: enum: - none - 'off' - 'on' type: string title: display_preference_param type: object title: payment_method_param type: object p24: description: >- Przelewy24 is a Poland-based payment method aggregator that allows customers to complete transactions online using bank transfers and other methods. Bank transfers account for 30% of online payments in Poland and Przelewy24 provides a way for customers to pay with over 165 banks. Check this [page](https://stripe.com/docs/payments/p24) for more details. properties: display_preference: properties: preference: enum: - none - 'off' - 'on' type: string title: display_preference_param type: object title: payment_method_param type: object paynow: description: >- PayNow is a Singapore-based payment method that allows customers to make a payment using their preferred app from participating banks and participating non-bank financial institutions. Check this [page](https://stripe.com/docs/payments/paynow) for more details. properties: display_preference: properties: preference: enum: - none - 'off' - 'on' type: string title: display_preference_param type: object title: payment_method_param type: object paypal: description: >- PayPal, a digital wallet popular with customers in Europe, allows your customers worldwide to pay using their PayPal account. Check this [page](https://stripe.com/docs/payments/paypal) for more details. properties: display_preference: properties: preference: enum: - none - 'off' - 'on' type: string title: display_preference_param type: object title: payment_method_param type: object promptpay: description: >- PromptPay is a Thailand-based payment method that allows customers to make a payment using their preferred app from participating banks. Check this [page](https://stripe.com/docs/payments/promptpay) for more details. properties: display_preference: properties: preference: enum: - none - 'off' - 'on' type: string title: display_preference_param type: object title: payment_method_param type: object revolut_pay: description: >- Revolut Pay, developed by Revolut, a global finance app, is a digital wallet payment method. Revolut Pay uses the customer’s stored balance or cards to fund the payment, and offers the option for non-Revolut customers to save their details after their first purchase. properties: display_preference: properties: preference: enum: - none - 'off' - 'on' type: string title: display_preference_param type: object title: payment_method_param type: object sepa_debit: description: >- The [Single Euro Payments Area (SEPA)](https://en.wikipedia.org/wiki/Single_Euro_Payments_Area) is an initiative of the European Union to simplify payments within and across member countries. SEPA established and enforced banking standards to allow for the direct debiting of every EUR-denominated bank account within the SEPA region, check this [page](https://stripe.com/docs/payments/sepa-debit) for more details. properties: display_preference: properties: preference: enum: - none - 'off' - 'on' type: string title: display_preference_param type: object title: payment_method_param type: object sofort: description: >- Stripe users in Europe and the United States can use the [Payment Intents API](https://stripe.com/docs/payments/payment-intents)—a single integration path for creating payments using any supported method—to accept [Sofort](https://www.sofort.com/) payments from customers. Check this [page](https://stripe.com/docs/payments/sofort) for more details. properties: display_preference: properties: preference: enum: - none - 'off' - 'on' type: string title: display_preference_param type: object title: payment_method_param type: object swish: description: >- Swish is a [real-time](https://stripe.com/docs/payments/real-time) payment method popular in Sweden. It allows customers to [authenticate and approve](https://stripe.com/docs/payments/payment-methods#customer-actions) payments using the Swish mobile app and the Swedish BankID mobile app. Check this [page](https://stripe.com/docs/payments/swish) for more details. properties: display_preference: properties: preference: enum: - none - 'off' - 'on' type: string title: display_preference_param type: object title: payment_method_param type: object us_bank_account: description: >- Stripe users in the United States can accept ACH direct debit payments from customers with a US bank account using the Automated Clearing House (ACH) payments system operated by Nacha. Check this [page](https://stripe.com/docs/payments/ach-debit) for more details. properties: display_preference: properties: preference: enum: - none - 'off' - 'on' type: string title: display_preference_param type: object title: payment_method_param type: object wechat_pay: description: >- WeChat, owned by Tencent, is China's leading mobile app with over 1 billion monthly active users. Chinese consumers can use WeChat Pay to pay for goods and services inside of businesses' apps and websites. WeChat Pay users buy most frequently in gaming, e-commerce, travel, online education, and food/nutrition. Check this [page](https://stripe.com/docs/payments/wechat-pay) for more details. properties: display_preference: properties: preference: enum: - none - 'off' - 'on' type: string title: display_preference_param type: object title: payment_method_param type: object zip: description: >- Zip gives your customers a way to split purchases over a series of payments. Check this [page](https://stripe.com/docs/payments/zip) for more details like country availability. properties: display_preference: properties: preference: enum: - none - 'off' - 'on' type: string title: display_preference_param type: object title: payment_method_param type: object type: object required: false responses: '200': content: application/json: schema: $ref: '#/components/schemas/payment_method_configuration' description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. /v1/payment_method_domains: get: description:

Lists the details of existing payment method domains.

operationId: GetPaymentMethodDomains parameters: - description: The domain name that this payment method domain object represents. in: query name: domain_name required: false schema: maxLength: 5000 type: string style: form - description: >- Whether this payment method domain is enabled. If the domain is not enabled, payment methods will not appear in Elements in: query name: enabled required: false schema: type: boolean style: form - description: >- A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. in: query name: ending_before required: false schema: maxLength: 5000 type: string style: form - description: Specifies which fields in the response should be expanded. explode: true in: query name: expand required: false schema: items: maxLength: 5000 type: string type: array style: deepObject - description: >- A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. in: query name: limit required: false schema: type: integer style: form - description: >- A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. in: query name: starting_after required: false schema: maxLength: 5000 type: string style: form requestBody: content: application/x-www-form-urlencoded: encoding: {} schema: additionalProperties: false properties: {} type: object required: false responses: '200': content: application/json: schema: description: '' properties: data: items: $ref: '#/components/schemas/payment_method_domain' type: array has_more: description: >- True if this list has another page of items after this one that can be fetched. type: boolean object: description: >- String representing the object's type. Objects of the same type share the same value. Always has the value `list`. enum: - list type: string url: description: The URL where this list can be accessed. maxLength: 5000 pattern: ^/v1/payment_method_domains type: string required: - data - has_more - object - url title: PaymentMethodDomainResourcePaymentMethodDomainList type: object x-expandableFields: - data description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. post: description:

Creates a payment method domain.

operationId: PostPaymentMethodDomains requestBody: content: application/x-www-form-urlencoded: encoding: expand: explode: true style: deepObject schema: additionalProperties: false properties: domain_name: description: >- The domain name that this payment method domain object represents. maxLength: 5000 type: string enabled: description: >- Whether this payment method domain is enabled. If the domain is not enabled, payment methods that require a payment method domain will not appear in Elements. type: boolean expand: description: Specifies which fields in the response should be expanded. items: maxLength: 5000 type: string type: array required: - domain_name type: object required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/payment_method_domain' description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. '/v1/payment_method_domains/{payment_method_domain}': get: description:

Retrieves the details of an existing payment method domain.

operationId: GetPaymentMethodDomainsPaymentMethodDomain parameters: - description: Specifies which fields in the response should be expanded. explode: true in: query name: expand required: false schema: items: maxLength: 5000 type: string type: array style: deepObject - in: path name: payment_method_domain required: true schema: maxLength: 5000 type: string style: simple requestBody: content: application/x-www-form-urlencoded: encoding: {} schema: additionalProperties: false properties: {} type: object required: false responses: '200': content: application/json: schema: $ref: '#/components/schemas/payment_method_domain' description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. post: description:

Updates an existing payment method domain.

operationId: PostPaymentMethodDomainsPaymentMethodDomain parameters: - in: path name: payment_method_domain required: true schema: maxLength: 5000 type: string style: simple requestBody: content: application/x-www-form-urlencoded: encoding: expand: explode: true style: deepObject schema: additionalProperties: false properties: enabled: description: >- Whether this payment method domain is enabled. If the domain is not enabled, payment methods that require a payment method domain will not appear in Elements. type: boolean expand: description: Specifies which fields in the response should be expanded. items: maxLength: 5000 type: string type: array type: object required: false responses: '200': content: application/json: schema: $ref: '#/components/schemas/payment_method_domain' description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. '/v1/payment_method_domains/{payment_method_domain}/validate': post: description: >-

Some payment methods such as Apple Pay require additional steps to verify a domain. If the requirements weren’t satisfied when the domain was created, the payment method will be inactive on the domain. The payment method doesn’t appear in Elements for this domain until it is active.

To activate a payment method on an existing payment method domain, complete the required validation steps specific to the payment method, and then validate the payment method domain with this endpoint.

Related guides: Payment method domains.

operationId: PostPaymentMethodDomainsPaymentMethodDomainValidate parameters: - in: path name: payment_method_domain required: true schema: maxLength: 5000 type: string style: simple requestBody: content: application/x-www-form-urlencoded: encoding: expand: explode: true style: deepObject schema: additionalProperties: false properties: expand: description: Specifies which fields in the response should be expanded. items: maxLength: 5000 type: string type: array type: object required: false responses: '200': content: application/json: schema: $ref: '#/components/schemas/payment_method_domain' description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. /v1/payment_methods: get: description: >-

Returns a list of PaymentMethods for Treasury flows. If you want to list the PaymentMethods attached to a Customer for payments, you should use the List a Customer’s PaymentMethods API instead.

operationId: GetPaymentMethods parameters: - description: The ID of the customer whose PaymentMethods will be retrieved. in: query name: customer required: false schema: maxLength: 5000 type: string style: form - description: >- A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. in: query name: ending_before required: false schema: type: string style: form - description: Specifies which fields in the response should be expanded. explode: true in: query name: expand required: false schema: items: maxLength: 5000 type: string type: array style: deepObject - description: >- A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. in: query name: limit required: false schema: type: integer style: form - description: >- A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. in: query name: starting_after required: false schema: type: string style: form - description: >- An optional filter on the list, based on the object `type` field. Without the filter, the list includes all current and future payment method types. If your integration expects only one type of payment method in the response, make sure to provide a type value in the request. in: query name: type required: false schema: enum: - acss_debit - affirm - afterpay_clearpay - alipay - amazon_pay - au_becs_debit - bacs_debit - bancontact - blik - boleto - card - cashapp - customer_balance - eps - fpx - giropay - grabpay - ideal - klarna - konbini - link - mobilepay - oxxo - p24 - paynow - paypal - pix - promptpay - revolut_pay - sepa_debit - sofort - swish - us_bank_account - wechat_pay - zip type: string x-stripeBypassValidation: true style: form requestBody: content: application/x-www-form-urlencoded: encoding: {} schema: additionalProperties: false properties: {} type: object required: false responses: '200': content: application/json: schema: description: '' properties: data: items: $ref: '#/components/schemas/payment_method' type: array has_more: description: >- True if this list has another page of items after this one that can be fetched. type: boolean object: description: >- String representing the object's type. Objects of the same type share the same value. Always has the value `list`. enum: - list type: string url: description: The URL where this list can be accessed. maxLength: 5000 pattern: ^/v1/payment_methods type: string required: - data - has_more - object - url title: PaymentFlowsPaymentMethodList type: object x-expandableFields: - data description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. post: description: >-

Creates a PaymentMethod object. Read the Stripe.js reference to learn how to create PaymentMethods via Stripe.js.

Instead of creating a PaymentMethod directly, we recommend using the PaymentIntents API to accept a payment immediately or the SetupIntent API to collect payment method details ahead of a future payment.

operationId: PostPaymentMethods requestBody: content: application/x-www-form-urlencoded: encoding: acss_debit: explode: true style: deepObject affirm: explode: true style: deepObject afterpay_clearpay: explode: true style: deepObject alipay: explode: true style: deepObject amazon_pay: explode: true style: deepObject au_becs_debit: explode: true style: deepObject bacs_debit: explode: true style: deepObject bancontact: explode: true style: deepObject billing_details: explode: true style: deepObject blik: explode: true style: deepObject boleto: explode: true style: deepObject card: explode: true style: deepObject cashapp: explode: true style: deepObject customer_balance: explode: true style: deepObject eps: explode: true style: deepObject expand: explode: true style: deepObject fpx: explode: true style: deepObject giropay: explode: true style: deepObject grabpay: explode: true style: deepObject ideal: explode: true style: deepObject interac_present: explode: true style: deepObject klarna: explode: true style: deepObject konbini: explode: true style: deepObject link: explode: true style: deepObject metadata: explode: true style: deepObject mobilepay: explode: true style: deepObject oxxo: explode: true style: deepObject p24: explode: true style: deepObject paynow: explode: true style: deepObject paypal: explode: true style: deepObject pix: explode: true style: deepObject promptpay: explode: true style: deepObject radar_options: explode: true style: deepObject revolut_pay: explode: true style: deepObject sepa_debit: explode: true style: deepObject sofort: explode: true style: deepObject swish: explode: true style: deepObject us_bank_account: explode: true style: deepObject wechat_pay: explode: true style: deepObject zip: explode: true style: deepObject schema: additionalProperties: false properties: acss_debit: description: >- If this is an `acss_debit` PaymentMethod, this hash contains details about the ACSS Debit payment method. properties: account_number: maxLength: 5000 type: string institution_number: maxLength: 5000 type: string transit_number: maxLength: 5000 type: string required: - account_number - institution_number - transit_number title: payment_method_param type: object affirm: description: >- If this is an `affirm` PaymentMethod, this hash contains details about the Affirm payment method. properties: {} title: param type: object afterpay_clearpay: description: >- If this is an `AfterpayClearpay` PaymentMethod, this hash contains details about the AfterpayClearpay payment method. properties: {} title: param type: object alipay: description: >- If this is an `Alipay` PaymentMethod, this hash contains details about the Alipay payment method. properties: {} title: param type: object allow_redisplay: description: >- 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`. enum: - always - limited - unspecified type: string amazon_pay: description: >- If this is a AmazonPay PaymentMethod, this hash contains details about the AmazonPay payment method. properties: {} title: param type: object au_becs_debit: description: >- If this is an `au_becs_debit` PaymentMethod, this hash contains details about the bank account. properties: account_number: maxLength: 5000 type: string bsb_number: maxLength: 5000 type: string required: - account_number - bsb_number title: param type: object bacs_debit: description: >- If this is a `bacs_debit` PaymentMethod, this hash contains details about the Bacs Direct Debit bank account. properties: account_number: maxLength: 5000 type: string sort_code: maxLength: 5000 type: string title: param type: object bancontact: description: >- If this is a `bancontact` PaymentMethod, this hash contains details about the Bancontact payment method. properties: {} title: param type: object billing_details: description: >- Billing information associated with the PaymentMethod that may be used or required by particular types of payment methods. properties: address: anyOf: - properties: city: maxLength: 5000 type: string country: maxLength: 5000 type: string line1: maxLength: 5000 type: string line2: maxLength: 5000 type: string postal_code: maxLength: 5000 type: string state: maxLength: 5000 type: string title: billing_details_address type: object - enum: - '' type: string email: anyOf: - type: string - enum: - '' type: string name: anyOf: - maxLength: 5000 type: string - enum: - '' type: string phone: anyOf: - maxLength: 5000 type: string - enum: - '' type: string title: billing_details_inner_params type: object blik: description: >- If this is a `blik` PaymentMethod, this hash contains details about the BLIK payment method. properties: {} title: param type: object boleto: description: >- If this is a `boleto` PaymentMethod, this hash contains details about the Boleto payment method. properties: tax_id: maxLength: 5000 type: string required: - tax_id title: param type: object card: anyOf: - properties: cvc: maxLength: 5000 type: string exp_month: type: integer exp_year: type: integer networks: properties: preferred: enum: - cartes_bancaires - mastercard - visa type: string title: networks_params type: object number: maxLength: 5000 type: string required: - exp_month - exp_year - number title: card_details_params type: object - properties: token: maxLength: 5000 type: string required: - token title: token_params type: object description: >- If this is a `card` PaymentMethod, this hash contains the user's card details. For backwards compatibility, you can alternatively provide a Stripe token (e.g., for Apple Pay, Amex Express Checkout, or legacy Checkout) into the card hash with format `card: {token: "tok_visa"}`. When providing a card number, you must meet the requirements for [PCI compliance](https://stripe.com/docs/security#validating-pci-compliance). We strongly recommend using Stripe.js instead of interacting with this API directly. x-stripeBypassValidation: true cashapp: description: >- If this is a `cashapp` PaymentMethod, this hash contains details about the Cash App Pay payment method. properties: {} title: param type: object customer: description: >- The `Customer` to whom the original PaymentMethod is attached. maxLength: 5000 type: string customer_balance: description: >- If this is a `customer_balance` PaymentMethod, this hash contains details about the CustomerBalance payment method. properties: {} title: param type: object eps: description: >- If this is an `eps` PaymentMethod, this hash contains details about the EPS payment method. properties: bank: enum: - 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 maxLength: 5000 type: string title: param type: object expand: description: Specifies which fields in the response should be expanded. items: maxLength: 5000 type: string type: array fpx: description: >- If this is an `fpx` PaymentMethod, this hash contains details about the FPX payment method. properties: bank: enum: - 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 maxLength: 5000 type: string x-stripeBypassValidation: true required: - bank title: param type: object giropay: description: >- If this is a `giropay` PaymentMethod, this hash contains details about the Giropay payment method. properties: {} title: param type: object grabpay: description: >- If this is a `grabpay` PaymentMethod, this hash contains details about the GrabPay payment method. properties: {} title: param type: object ideal: description: >- If this is an `ideal` PaymentMethod, this hash contains details about the iDEAL payment method. properties: bank: enum: - abn_amro - asn_bank - bunq - handelsbanken - ing - knab - moneyou - n26 - nn - rabobank - regiobank - revolut - sns_bank - triodos_bank - van_lanschot - yoursafe maxLength: 5000 type: string title: param type: object interac_present: description: >- If this is an `interac_present` PaymentMethod, this hash contains details about the Interac Present payment method. properties: {} title: param type: object klarna: description: >- If this is a `klarna` PaymentMethod, this hash contains details about the Klarna payment method. properties: dob: properties: day: type: integer month: type: integer year: type: integer required: - day - month - year title: date_of_birth type: object title: param type: object konbini: description: >- If this is a `konbini` PaymentMethod, this hash contains details about the Konbini payment method. properties: {} title: param type: object link: description: >- If this is an `Link` PaymentMethod, this hash contains details about the Link payment method. properties: {} title: param type: object metadata: additionalProperties: type: string description: >- Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. type: object mobilepay: description: >- If this is a `mobilepay` PaymentMethod, this hash contains details about the MobilePay payment method. properties: {} title: param type: object oxxo: description: >- If this is an `oxxo` PaymentMethod, this hash contains details about the OXXO payment method. properties: {} title: param type: object p24: description: >- If this is a `p24` PaymentMethod, this hash contains details about the P24 payment method. properties: bank: enum: - 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 type: string x-stripeBypassValidation: true title: param type: object payment_method: description: The PaymentMethod to share. maxLength: 5000 type: string paynow: description: >- If this is a `paynow` PaymentMethod, this hash contains details about the PayNow payment method. properties: {} title: param type: object paypal: description: >- If this is a `paypal` PaymentMethod, this hash contains details about the PayPal payment method. properties: {} title: param type: object pix: description: >- If this is a `pix` PaymentMethod, this hash contains details about the Pix payment method. properties: {} title: param type: object promptpay: description: >- If this is a `promptpay` PaymentMethod, this hash contains details about the PromptPay payment method. properties: {} title: param type: object radar_options: description: >- Options to configure Radar. See [Radar Session](https://stripe.com/docs/radar/radar-session) for more information. properties: session: maxLength: 5000 type: string title: radar_options_with_hidden_options type: object revolut_pay: description: >- If this is a `Revolut Pay` PaymentMethod, this hash contains details about the Revolut Pay payment method. properties: {} title: param type: object sepa_debit: description: >- If this is a `sepa_debit` PaymentMethod, this hash contains details about the SEPA debit bank account. properties: iban: maxLength: 5000 type: string required: - iban title: param type: object sofort: description: >- If this is a `sofort` PaymentMethod, this hash contains details about the SOFORT payment method. properties: country: enum: - AT - BE - DE - ES - IT - NL type: string required: - country title: param type: object swish: description: >- If this is a `swish` PaymentMethod, this hash contains details about the Swish payment method. properties: {} title: param type: object type: description: >- 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. enum: - acss_debit - affirm - afterpay_clearpay - alipay - amazon_pay - au_becs_debit - bacs_debit - bancontact - blik - boleto - card - cashapp - customer_balance - eps - fpx - giropay - grabpay - ideal - klarna - konbini - link - mobilepay - oxxo - p24 - paynow - paypal - pix - promptpay - revolut_pay - sepa_debit - sofort - swish - us_bank_account - wechat_pay - zip type: string x-stripeBypassValidation: true us_bank_account: description: >- If this is an `us_bank_account` PaymentMethod, this hash contains details about the US bank account payment method. properties: account_holder_type: enum: - company - individual type: string account_number: maxLength: 5000 type: string account_type: enum: - checking - savings type: string financial_connections_account: maxLength: 5000 type: string routing_number: maxLength: 5000 type: string title: payment_method_param type: object wechat_pay: description: >- If this is an `wechat_pay` PaymentMethod, this hash contains details about the wechat_pay payment method. properties: {} title: param type: object zip: description: >- If this is a `zip` PaymentMethod, this hash contains details about the Zip payment method. properties: {} title: param type: object type: object required: false responses: '200': content: application/json: schema: $ref: '#/components/schemas/payment_method' description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. '/v1/payment_methods/{payment_method}': get: description: >-

Retrieves a PaymentMethod object attached to the StripeAccount. To retrieve a payment method attached to a Customer, you should use Retrieve a Customer’s PaymentMethods

operationId: GetPaymentMethodsPaymentMethod parameters: - description: Specifies which fields in the response should be expanded. explode: true in: query name: expand required: false schema: items: maxLength: 5000 type: string type: array style: deepObject - in: path name: payment_method required: true schema: maxLength: 5000 type: string style: simple requestBody: content: application/x-www-form-urlencoded: encoding: {} schema: additionalProperties: false properties: {} type: object required: false responses: '200': content: application/json: schema: $ref: '#/components/schemas/payment_method' description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. post: description: >-

Updates a PaymentMethod object. A PaymentMethod must be attached a customer to be updated.

operationId: PostPaymentMethodsPaymentMethod parameters: - in: path name: payment_method required: true schema: maxLength: 5000 type: string style: simple requestBody: content: application/x-www-form-urlencoded: encoding: billing_details: explode: true style: deepObject card: explode: true style: deepObject expand: explode: true style: deepObject link: explode: true style: deepObject metadata: explode: true style: deepObject us_bank_account: explode: true style: deepObject schema: additionalProperties: false properties: allow_redisplay: description: >- 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`. enum: - always - limited - unspecified type: string billing_details: description: >- Billing information associated with the PaymentMethod that may be used or required by particular types of payment methods. properties: address: anyOf: - properties: city: maxLength: 5000 type: string country: maxLength: 5000 type: string line1: maxLength: 5000 type: string line2: maxLength: 5000 type: string postal_code: maxLength: 5000 type: string state: maxLength: 5000 type: string title: billing_details_address type: object - enum: - '' type: string email: anyOf: - type: string - enum: - '' type: string name: anyOf: - maxLength: 5000 type: string - enum: - '' type: string phone: anyOf: - maxLength: 5000 type: string - enum: - '' type: string title: billing_details_inner_params type: object card: description: >- If this is a `card` PaymentMethod, this hash contains the user's card details. properties: exp_month: type: integer exp_year: type: integer networks: properties: preferred: enum: - '' - cartes_bancaires - mastercard - visa type: string title: networks_update_api_param type: object title: update_api_param type: object expand: description: Specifies which fields in the response should be expanded. items: maxLength: 5000 type: string type: array link: description: >- If this is an `Link` PaymentMethod, this hash contains details about the Link payment method. properties: {} title: param type: object metadata: anyOf: - additionalProperties: type: string type: object - enum: - '' type: string description: >- Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. us_bank_account: description: >- If this is an `us_bank_account` PaymentMethod, this hash contains details about the US bank account payment method. properties: account_holder_type: enum: - company - individual type: string account_type: enum: - checking - savings type: string title: update_param type: object type: object required: false responses: '200': content: application/json: schema: $ref: '#/components/schemas/payment_method' description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. '/v1/payment_methods/{payment_method}/attach': post: description: >-

Attaches a PaymentMethod object to a Customer.

To attach a new PaymentMethod to a customer for future payments, we recommend you use a SetupIntent or a PaymentIntent with setup_future_usage. These approaches will perform any necessary steps to set up the PaymentMethod for future payments. Using the /v1/payment_methods/:id/attach endpoint without first using a SetupIntent or PaymentIntent with setup_future_usage does not optimize the PaymentMethod for future use, which makes later declines and payment friction more likely. See Optimizing cards for future payments for more information about setting up future payments.

To use this PaymentMethod as the default for invoice or subscription payments, set invoice_settings.default_payment_method, on the Customer to the PaymentMethod’s ID.

operationId: PostPaymentMethodsPaymentMethodAttach parameters: - in: path name: payment_method required: true schema: maxLength: 5000 type: string style: simple requestBody: content: application/x-www-form-urlencoded: encoding: expand: explode: true style: deepObject schema: additionalProperties: false properties: customer: description: The ID of the customer to which to attach the PaymentMethod. maxLength: 5000 type: string expand: description: Specifies which fields in the response should be expanded. items: maxLength: 5000 type: string type: array required: - customer type: object required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/payment_method' description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. '/v1/payment_methods/{payment_method}/detach': post: description: >-

Detaches a PaymentMethod object from a Customer. After a PaymentMethod is detached, it can no longer be used for a payment or re-attached to a Customer.

operationId: PostPaymentMethodsPaymentMethodDetach parameters: - in: path name: payment_method required: true schema: maxLength: 5000 type: string style: simple requestBody: content: application/x-www-form-urlencoded: encoding: expand: explode: true style: deepObject schema: additionalProperties: false properties: expand: description: Specifies which fields in the response should be expanded. items: maxLength: 5000 type: string type: array type: object required: false responses: '200': content: application/json: schema: $ref: '#/components/schemas/payment_method' description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. /v1/payouts: get: description: >-

Returns a list of existing payouts sent to third-party bank accounts or payouts that Stripe sent to you. The payouts return in sorted order, with the most recently created payouts appearing first.

operationId: GetPayouts parameters: - description: >- Only return payouts that are expected to arrive during the given date interval. explode: true in: query name: arrival_date required: false schema: anyOf: - properties: gt: type: integer gte: type: integer lt: type: integer lte: type: integer title: range_query_specs type: object - type: integer style: deepObject - description: >- Only return payouts that were created during the given date interval. explode: true in: query name: created required: false schema: anyOf: - properties: gt: type: integer gte: type: integer lt: type: integer lte: type: integer title: range_query_specs type: object - type: integer style: deepObject - description: >- The ID of an external account - only return payouts sent to this external account. in: query name: destination required: false schema: type: string style: form - description: >- A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. in: query name: ending_before required: false schema: maxLength: 5000 type: string style: form - description: Specifies which fields in the response should be expanded. explode: true in: query name: expand required: false schema: items: maxLength: 5000 type: string type: array style: deepObject - description: >- A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. in: query name: limit required: false schema: type: integer style: form - description: >- A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. in: query name: starting_after required: false schema: maxLength: 5000 type: string style: form - description: >- Only return payouts that have the given status: `pending`, `paid`, `failed`, or `canceled`. in: query name: status required: false schema: maxLength: 5000 type: string style: form requestBody: content: application/x-www-form-urlencoded: encoding: {} schema: additionalProperties: false properties: {} type: object required: false responses: '200': content: application/json: schema: description: '' properties: data: items: $ref: '#/components/schemas/payout' type: array has_more: description: >- True if this list has another page of items after this one that can be fetched. type: boolean object: description: >- String representing the object's type. Objects of the same type share the same value. Always has the value `list`. enum: - list type: string url: description: The URL where this list can be accessed. maxLength: 5000 pattern: ^/v1/payouts type: string required: - data - has_more - object - url title: PayoutList type: object x-expandableFields: - data description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. post: description: >-

To send funds to your own bank account, create a new payout object. Your Stripe balance must cover the payout amount. If it doesn’t, you receive an “Insufficient Funds” error.

If your API key is in test mode, money won’t actually be sent, though every other action occurs as if you’re in live mode.

If you create a manual payout on a Stripe account that uses multiple payment source types, you need to specify the source type balance that the payout draws from. The balance object details available and pending amounts by source type.

operationId: PostPayouts requestBody: content: application/x-www-form-urlencoded: encoding: expand: explode: true style: deepObject metadata: explode: true style: deepObject schema: additionalProperties: false properties: amount: description: A positive integer in cents representing how much to payout. type: integer currency: description: >- 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). type: string description: description: >- An arbitrary string attached to the object. Often useful for displaying to users. maxLength: 5000 type: string destination: description: >- The ID of a bank account or a card to send the payout to. If you don't provide a destination, we use the default external account for the specified currency. type: string expand: description: Specifies which fields in the response should be expanded. items: maxLength: 5000 type: string type: array metadata: additionalProperties: type: string description: >- Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. type: object method: description: >- The method used to send this payout, which is `standard` or `instant`. We support `instant` for payouts to debit cards and bank accounts in certain countries. Learn more about [bank support for Instant Payouts](https://stripe.com/docs/payouts/instant-payouts-banks). enum: - instant - standard maxLength: 5000 type: string x-stripeBypassValidation: true source_type: description: >- The balance type of your Stripe balance to draw this payout from. Balances for different payment sources are kept separately. You can find the amounts with the Balances API. One of `bank_account`, `card`, or `fpx`. enum: - bank_account - card - fpx maxLength: 5000 type: string x-stripeBypassValidation: true statement_descriptor: description: >- A string that displays on the recipient's bank or card statement (up to 22 characters). A `statement_descriptor` that's longer than 22 characters return an error. Most banks truncate this information and display it inconsistently. Some banks might not display it at all. maxLength: 22 type: string x-stripeBypassValidation: true required: - amount - currency type: object required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/payout' description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. '/v1/payouts/{payout}': get: description: >-

Retrieves the details of an existing payout. Supply the unique payout ID from either a payout creation request or the payout list. Stripe returns the corresponding payout information.

operationId: GetPayoutsPayout parameters: - description: Specifies which fields in the response should be expanded. explode: true in: query name: expand required: false schema: items: maxLength: 5000 type: string type: array style: deepObject - in: path name: payout required: true schema: maxLength: 5000 type: string style: simple requestBody: content: application/x-www-form-urlencoded: encoding: {} schema: additionalProperties: false properties: {} type: object required: false responses: '200': content: application/json: schema: $ref: '#/components/schemas/payout' description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. post: description: >-

Updates the specified payout by setting the values of the parameters you pass. We don’t change parameters that you don’t provide. This request only accepts the metadata as arguments.

operationId: PostPayoutsPayout parameters: - in: path name: payout required: true schema: maxLength: 5000 type: string style: simple requestBody: content: application/x-www-form-urlencoded: encoding: expand: explode: true style: deepObject metadata: explode: true style: deepObject schema: additionalProperties: false properties: expand: description: Specifies which fields in the response should be expanded. items: maxLength: 5000 type: string type: array metadata: anyOf: - additionalProperties: type: string type: object - enum: - '' type: string description: >- Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. type: object required: false responses: '200': content: application/json: schema: $ref: '#/components/schemas/payout' description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. '/v1/payouts/{payout}/cancel': post: description: >-

You can cancel a previously created payout if its status is pending. Stripe refunds the funds to your available balance. You can’t cancel automatic Stripe payouts.

operationId: PostPayoutsPayoutCancel parameters: - in: path name: payout required: true schema: maxLength: 5000 type: string style: simple requestBody: content: application/x-www-form-urlencoded: encoding: expand: explode: true style: deepObject schema: additionalProperties: false properties: expand: description: Specifies which fields in the response should be expanded. items: maxLength: 5000 type: string type: array type: object required: false responses: '200': content: application/json: schema: $ref: '#/components/schemas/payout' description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. '/v1/payouts/{payout}/reverse': post: description: >-

Reverses a payout by debiting the destination bank account. At this time, you can only reverse payouts for connected accounts to US bank accounts. If the payout is manual and in the pending status, use /v1/payouts/:id/cancel instead.

By requesting a reversal through /v1/payouts/:id/reverse, you confirm that the authorized signatory of the selected bank account authorizes the debit on the bank account and that no other authorization is required.

operationId: PostPayoutsPayoutReverse parameters: - in: path name: payout required: true schema: maxLength: 5000 type: string style: simple requestBody: content: application/x-www-form-urlencoded: encoding: expand: explode: true style: deepObject metadata: explode: true style: deepObject schema: additionalProperties: false properties: expand: description: Specifies which fields in the response should be expanded. items: maxLength: 5000 type: string type: array metadata: additionalProperties: type: string description: >- Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. type: object type: object required: false responses: '200': content: application/json: schema: $ref: '#/components/schemas/payout' description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. /v1/plans: get: description:

Returns a list of your plans.

operationId: GetPlans parameters: - description: >- Only return plans that are active or inactive (e.g., pass `false` to list all inactive plans). in: query name: active required: false schema: type: boolean style: form - description: >- A filter on the list, based on the object `created` field. The value can be a string with an integer Unix timestamp, or it can be a dictionary with a number of different query options. explode: true in: query name: created required: false schema: anyOf: - properties: gt: type: integer gte: type: integer lt: type: integer lte: type: integer title: range_query_specs type: object - type: integer style: deepObject - description: >- A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. in: query name: ending_before required: false schema: maxLength: 5000 type: string style: form - description: Specifies which fields in the response should be expanded. explode: true in: query name: expand required: false schema: items: maxLength: 5000 type: string type: array style: deepObject - description: >- A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. in: query name: limit required: false schema: type: integer style: form - description: Only return plans for the given product. in: query name: product required: false schema: maxLength: 5000 type: string style: form - description: >- A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. in: query name: starting_after required: false schema: maxLength: 5000 type: string style: form requestBody: content: application/x-www-form-urlencoded: encoding: {} schema: additionalProperties: false properties: {} type: object required: false responses: '200': content: application/json: schema: description: '' properties: data: description: Details about each object. items: $ref: '#/components/schemas/plan' type: array has_more: description: >- True if this list has another page of items after this one that can be fetched. type: boolean object: description: >- String representing the object's type. Objects of the same type share the same value. Always has the value `list`. enum: - list type: string url: description: The URL where this list can be accessed. maxLength: 5000 pattern: ^/v1/plans type: string required: - data - has_more - object - url title: PlanList type: object x-expandableFields: - data description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. post: description: >-

You can now model subscriptions more flexibly using the Prices API. It replaces the Plans API and is backwards compatible to simplify your migration.

operationId: PostPlans requestBody: content: application/x-www-form-urlencoded: encoding: expand: explode: true style: deepObject metadata: explode: true style: deepObject product: explode: true style: deepObject tiers: explode: true style: deepObject transform_usage: explode: true style: deepObject schema: additionalProperties: false properties: active: description: >- Whether the plan is currently available for new subscriptions. Defaults to `true`. type: boolean aggregate_usage: description: >- Specifies a usage aggregation strategy for plans of `usage_type=metered`. Allowed values are `sum` for summing up all usage during a period, `last_during_period` for using the last usage record reported within a period, `last_ever` for using the last usage record ever (across period bounds) or `max` which uses the usage record with the maximum reported usage during a period. Defaults to `sum`. enum: - last_during_period - last_ever - max - sum type: string amount: description: >- A positive integer in cents (or local equivalent) (or 0 for a free plan) representing how much to charge on a recurring basis. type: integer amount_decimal: description: >- Same as `amount`, but accepts a decimal value with at most 12 decimal places. Only one of `amount` and `amount_decimal` can be set. format: decimal type: string billing_scheme: description: >- Describes how to compute the price per period. Either `per_unit` or `tiered`. `per_unit` indicates that the fixed amount (specified in `amount`) will be charged per unit in `quantity` (for plans with `usage_type=licensed`), or per unit of total usage (for plans with `usage_type=metered`). `tiered` indicates that the unit pricing will be computed using a tiering strategy as defined using the `tiers` and `tiers_mode` attributes. enum: - per_unit - tiered type: string currency: description: >- 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). type: string expand: description: Specifies which fields in the response should be expanded. items: maxLength: 5000 type: string type: array id: description: >- An identifier randomly generated by Stripe. Used to identify this plan when subscribing a customer. You can optionally override this ID, but the ID must be unique across all plans in your Stripe account. You can, however, use the same plan ID in both live and test modes. maxLength: 5000 type: string interval: description: >- Specifies billing frequency. Either `day`, `week`, `month` or `year`. enum: - day - month - week - year type: string interval_count: description: >- The number of intervals between subscription billings. For example, `interval=month` and `interval_count=3` bills every 3 months. Maximum of three years interval allowed (3 years, 36 months, or 156 weeks). type: integer metadata: anyOf: - additionalProperties: type: string type: object - enum: - '' type: string description: >- Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. meter: description: The meter tracking the usage of a metered price maxLength: 5000 type: string nickname: description: 'A brief description of the plan, hidden from customers.' maxLength: 5000 type: string product: anyOf: - description: >- The product whose pricing the created plan will represent. This can either be the ID of an existing product, or a dictionary containing fields used to create a [service product](https://stripe.com/docs/api#product_object-type). properties: active: type: boolean id: maxLength: 5000 type: string metadata: additionalProperties: type: string type: object name: maxLength: 5000 type: string statement_descriptor: maxLength: 22 type: string tax_code: maxLength: 5000 type: string unit_label: maxLength: 12 type: string required: - name title: inline_product_params type: object - description: >- The ID of the product whose pricing the created plan will represent. maxLength: 5000 type: string tiers: description: >- Each element represents a pricing tier. This parameter requires `billing_scheme` to be set to `tiered`. See also the documentation for `billing_scheme`. items: properties: flat_amount: type: integer flat_amount_decimal: format: decimal type: string unit_amount: type: integer unit_amount_decimal: format: decimal type: string up_to: anyOf: - enum: - inf maxLength: 5000 type: string - type: integer required: - up_to title: tier type: object type: array tiers_mode: description: >- Defines if the tiering price should be `graduated` or `volume` based. In `volume`-based tiering, the maximum quantity within a period determines the per unit price, in `graduated` tiering pricing can successively change as the quantity grows. enum: - graduated - volume type: string transform_usage: description: >- Apply a transformation to the reported usage or set quantity before computing the billed price. Cannot be combined with `tiers`. properties: divide_by: type: integer round: enum: - down - up type: string required: - divide_by - round title: transform_usage_param type: object trial_period_days: description: >- Default number of trial days when subscribing a customer to this plan using [`trial_from_plan=true`](https://stripe.com/docs/api#create_subscription-trial_from_plan). type: integer usage_type: description: >- Configures how the quantity per period should be determined. Can be either `metered` or `licensed`. `licensed` automatically bills the `quantity` set when adding it to a subscription. `metered` aggregates the total usage based on usage records. Defaults to `licensed`. enum: - licensed - metered type: string required: - currency - interval type: object required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/plan' description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. '/v1/plans/{plan}': delete: description: >-

Deleting plans means new subscribers can’t be added. Existing subscribers aren’t affected.

operationId: DeletePlansPlan parameters: - in: path name: plan required: true schema: maxLength: 5000 type: string style: simple requestBody: content: application/x-www-form-urlencoded: encoding: {} schema: additionalProperties: false properties: {} type: object required: false responses: '200': content: application/json: schema: $ref: '#/components/schemas/deleted_plan' description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. get: description:

Retrieves the plan with the given ID.

operationId: GetPlansPlan parameters: - description: Specifies which fields in the response should be expanded. explode: true in: query name: expand required: false schema: items: maxLength: 5000 type: string type: array style: deepObject - in: path name: plan required: true schema: maxLength: 5000 type: string style: simple requestBody: content: application/x-www-form-urlencoded: encoding: {} schema: additionalProperties: false properties: {} type: object required: false responses: '200': content: application/json: schema: $ref: '#/components/schemas/plan' description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. post: description: >-

Updates the specified plan by setting the values of the parameters passed. Any parameters not provided are left unchanged. By design, you cannot change a plan’s ID, amount, currency, or billing cycle.

operationId: PostPlansPlan parameters: - in: path name: plan required: true schema: maxLength: 5000 type: string style: simple requestBody: content: application/x-www-form-urlencoded: encoding: expand: explode: true style: deepObject metadata: explode: true style: deepObject schema: additionalProperties: false properties: active: description: >- Whether the plan is currently available for new subscriptions. type: boolean expand: description: Specifies which fields in the response should be expanded. items: maxLength: 5000 type: string type: array metadata: anyOf: - additionalProperties: type: string type: object - enum: - '' type: string description: >- Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. nickname: description: 'A brief description of the plan, hidden from customers.' maxLength: 5000 type: string product: description: >- The product the plan belongs to. This cannot be changed once it has been used in a subscription or subscription schedule. maxLength: 5000 type: string trial_period_days: description: >- Default number of trial days when subscribing a customer to this plan using [`trial_from_plan=true`](https://stripe.com/docs/api#create_subscription-trial_from_plan). type: integer type: object required: false responses: '200': content: application/json: schema: $ref: '#/components/schemas/plan' description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. /v1/prices: get: description: >-

Returns a list of your active prices, excluding inline prices. For the list of inactive prices, set active to false.

operationId: GetPrices parameters: - description: >- Only return prices that are active or inactive (e.g., pass `false` to list all inactive prices). in: query name: active required: false schema: type: boolean style: form - description: >- A filter on the list, based on the object `created` field. The value can be a string with an integer Unix timestamp, or it can be a dictionary with a number of different query options. explode: true in: query name: created required: false schema: anyOf: - properties: gt: type: integer gte: type: integer lt: type: integer lte: type: integer title: range_query_specs type: object - type: integer style: deepObject - description: Only return prices for the given currency. in: query name: currency required: false schema: type: string style: form - description: >- A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. in: query name: ending_before required: false schema: maxLength: 5000 type: string style: form - description: Specifies which fields in the response should be expanded. explode: true in: query name: expand required: false schema: items: maxLength: 5000 type: string type: array style: deepObject - description: >- A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. in: query name: limit required: false schema: type: integer style: form - description: 'Only return the price with these lookup_keys, if any exist.' explode: true in: query name: lookup_keys required: false schema: items: maxLength: 5000 type: string type: array style: deepObject - description: Only return prices for the given product. in: query name: product required: false schema: maxLength: 5000 type: string style: form - description: Only return prices with these recurring fields. explode: true in: query name: recurring required: false schema: properties: interval: enum: - day - month - week - year type: string meter: maxLength: 5000 type: string usage_type: enum: - licensed - metered type: string title: all_prices_recurring_params type: object style: deepObject - description: >- A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. in: query name: starting_after required: false schema: maxLength: 5000 type: string style: form - description: Only return prices of type `recurring` or `one_time`. in: query name: type required: false schema: enum: - one_time - recurring type: string style: form requestBody: content: application/x-www-form-urlencoded: encoding: {} schema: additionalProperties: false properties: {} type: object required: false responses: '200': content: application/json: schema: description: '' properties: data: description: Details about each object. items: $ref: '#/components/schemas/price' type: array has_more: description: >- True if this list has another page of items after this one that can be fetched. type: boolean object: description: >- String representing the object's type. Objects of the same type share the same value. Always has the value `list`. enum: - list type: string url: description: The URL where this list can be accessed. maxLength: 5000 pattern: ^/v1/prices type: string required: - data - has_more - object - url title: PriceList type: object x-expandableFields: - data description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. post: description: >-

Creates a new price for an existing product. The price can be recurring or one-time.

operationId: PostPrices requestBody: content: application/x-www-form-urlencoded: encoding: currency_options: explode: true style: deepObject custom_unit_amount: explode: true style: deepObject expand: explode: true style: deepObject metadata: explode: true style: deepObject product_data: explode: true style: deepObject recurring: explode: true style: deepObject tiers: explode: true style: deepObject transform_quantity: explode: true style: deepObject schema: additionalProperties: false properties: active: description: >- Whether the price can be used for new purchases. Defaults to `true`. type: boolean billing_scheme: description: >- Describes how to compute the price per period. Either `per_unit` or `tiered`. `per_unit` indicates that the fixed amount (specified in `unit_amount` or `unit_amount_decimal`) will be charged per unit in `quantity` (for prices with `usage_type=licensed`), or per unit of total usage (for prices with `usage_type=metered`). `tiered` indicates that the unit pricing will be computed using a tiering strategy as defined using the `tiers` and `tiers_mode` attributes. enum: - per_unit - tiered type: string currency: description: >- 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). type: string currency_options: additionalProperties: properties: custom_unit_amount: properties: enabled: type: boolean maximum: type: integer minimum: type: integer preset: type: integer required: - enabled title: custom_unit_amount type: object tax_behavior: enum: - exclusive - inclusive - unspecified type: string tiers: items: properties: flat_amount: type: integer flat_amount_decimal: format: decimal type: string unit_amount: type: integer unit_amount_decimal: format: decimal type: string up_to: anyOf: - enum: - inf maxLength: 5000 type: string - type: integer required: - up_to title: tier type: object type: array unit_amount: type: integer unit_amount_decimal: format: decimal type: string title: currency_option type: object description: >- Prices defined in each available currency option. Each key must be a three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html) and a [supported currency](https://stripe.com/docs/currencies). type: object custom_unit_amount: description: >- When set, provides configuration for the amount to be adjusted by the customer during Checkout Sessions and Payment Links. properties: enabled: type: boolean maximum: type: integer minimum: type: integer preset: type: integer required: - enabled title: custom_unit_amount type: object expand: description: Specifies which fields in the response should be expanded. items: maxLength: 5000 type: string type: array lookup_key: description: >- A lookup key used to retrieve prices dynamically from a static string. This may be up to 200 characters. maxLength: 200 type: string metadata: additionalProperties: type: string description: >- Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. type: object nickname: description: 'A brief description of the price, hidden from customers.' maxLength: 5000 type: string product: description: The ID of the product that this price will belong to. maxLength: 5000 type: string product_data: description: >- These fields can be used to create a new product that this price will belong to. properties: active: type: boolean id: maxLength: 5000 type: string metadata: additionalProperties: type: string type: object name: maxLength: 5000 type: string statement_descriptor: maxLength: 22 type: string tax_code: maxLength: 5000 type: string unit_label: maxLength: 12 type: string required: - name title: inline_product_params type: object recurring: description: >- The recurring components of a price such as `interval` and `usage_type`. properties: aggregate_usage: enum: - last_during_period - last_ever - max - sum type: string interval: enum: - day - month - week - year type: string interval_count: type: integer meter: maxLength: 5000 type: string usage_type: enum: - licensed - metered type: string required: - interval title: recurring type: object tax_behavior: description: >- Only required if a [default tax behavior](https://stripe.com/docs/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)) was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. Once specified as either `inclusive` or `exclusive`, it cannot be changed. enum: - exclusive - inclusive - unspecified type: string tiers: description: >- Each element represents a pricing tier. This parameter requires `billing_scheme` to be set to `tiered`. See also the documentation for `billing_scheme`. items: properties: flat_amount: type: integer flat_amount_decimal: format: decimal type: string unit_amount: type: integer unit_amount_decimal: format: decimal type: string up_to: anyOf: - enum: - inf maxLength: 5000 type: string - type: integer required: - up_to title: tier type: object type: array tiers_mode: description: >- Defines if the tiering price should be `graduated` or `volume` based. In `volume`-based tiering, the maximum quantity within a period determines the per unit price, in `graduated` tiering pricing can successively change as the quantity grows. enum: - graduated - volume type: string transfer_lookup_key: description: >- If set to true, will atomically remove the lookup key from the existing price, and assign it to this price. type: boolean transform_quantity: description: >- Apply a transformation to the reported usage or set quantity before computing the billed price. Cannot be combined with `tiers`. properties: divide_by: type: integer round: enum: - down - up type: string required: - divide_by - round title: transform_usage_param type: object unit_amount: description: >- A positive integer in cents (or local equivalent) (or 0 for a free price) representing how much to charge. One of `unit_amount` or `custom_unit_amount` is required, unless `billing_scheme=tiered`. type: integer unit_amount_decimal: description: >- Same as `unit_amount`, but accepts a decimal value in cents (or local equivalent) with at most 12 decimal places. Only one of `unit_amount` and `unit_amount_decimal` can be set. format: decimal type: string required: - currency type: object required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/price' description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. /v1/prices/search: get: description: >-

Search for prices you’ve previously created using Stripe’s Search Query Language. Don’t use search in read-after-write flows where strict consistency is necessary. Under normal operating conditions, data is searchable in less than a minute. Occasionally, propagation of new or updated data can be up to an hour behind during outages. Search functionality is not available to merchants in India.

operationId: GetPricesSearch parameters: - description: Specifies which fields in the response should be expanded. explode: true in: query name: expand required: false schema: items: maxLength: 5000 type: string type: array style: deepObject - description: >- A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. in: query name: limit required: false schema: type: integer style: form - description: >- A cursor for pagination across multiple pages of results. Don't include this parameter on the first call. Use the next_page value returned in a previous response to request subsequent results. in: query name: page required: false schema: maxLength: 5000 type: string style: form - description: >- The search query string. See [search query language](https://stripe.com/docs/search#search-query-language) and the list of supported [query fields for prices](https://stripe.com/docs/search#query-fields-for-prices). in: query name: query required: true schema: maxLength: 5000 type: string style: form requestBody: content: application/x-www-form-urlencoded: encoding: {} schema: additionalProperties: false properties: {} type: object required: false responses: '200': content: application/json: schema: description: '' properties: data: items: $ref: '#/components/schemas/price' type: array has_more: type: boolean next_page: maxLength: 5000 nullable: true type: string object: description: >- String representing the object's type. Objects of the same type share the same value. enum: - search_result type: string total_count: description: >- The total number of objects that match the query, only accurate up to 10,000. type: integer url: maxLength: 5000 type: string required: - data - has_more - object - url title: SearchResult type: object x-expandableFields: - data description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. '/v1/prices/{price}': get: description:

Retrieves the price with the given ID.

operationId: GetPricesPrice parameters: - description: Specifies which fields in the response should be expanded. explode: true in: query name: expand required: false schema: items: maxLength: 5000 type: string type: array style: deepObject - in: path name: price required: true schema: maxLength: 5000 type: string style: simple requestBody: content: application/x-www-form-urlencoded: encoding: {} schema: additionalProperties: false properties: {} type: object required: false responses: '200': content: application/json: schema: $ref: '#/components/schemas/price' description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. post: description: >-

Updates the specified price by setting the values of the parameters passed. Any parameters not provided are left unchanged.

operationId: PostPricesPrice parameters: - in: path name: price required: true schema: maxLength: 5000 type: string style: simple requestBody: content: application/x-www-form-urlencoded: encoding: currency_options: explode: true style: deepObject expand: explode: true style: deepObject metadata: explode: true style: deepObject schema: additionalProperties: false properties: active: description: >- Whether the price can be used for new purchases. Defaults to `true`. type: boolean currency_options: anyOf: - additionalProperties: properties: custom_unit_amount: properties: enabled: type: boolean maximum: type: integer minimum: type: integer preset: type: integer required: - enabled title: custom_unit_amount type: object tax_behavior: enum: - exclusive - inclusive - unspecified type: string tiers: items: properties: flat_amount: type: integer flat_amount_decimal: format: decimal type: string unit_amount: type: integer unit_amount_decimal: format: decimal type: string up_to: anyOf: - enum: - inf maxLength: 5000 type: string - type: integer required: - up_to title: tier type: object type: array unit_amount: type: integer unit_amount_decimal: format: decimal type: string title: currency_option type: object type: object - enum: - '' type: string description: >- Prices defined in each available currency option. Each key must be a three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html) and a [supported currency](https://stripe.com/docs/currencies). expand: description: Specifies which fields in the response should be expanded. items: maxLength: 5000 type: string type: array lookup_key: description: >- A lookup key used to retrieve prices dynamically from a static string. This may be up to 200 characters. maxLength: 200 type: string metadata: anyOf: - additionalProperties: type: string type: object - enum: - '' type: string description: >- Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. nickname: description: 'A brief description of the price, hidden from customers.' maxLength: 5000 type: string tax_behavior: description: >- Only required if a [default tax behavior](https://stripe.com/docs/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)) was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. Once specified as either `inclusive` or `exclusive`, it cannot be changed. enum: - exclusive - inclusive - unspecified type: string transfer_lookup_key: description: >- If set to true, will atomically remove the lookup key from the existing price, and assign it to this price. type: boolean type: object required: false responses: '200': content: application/json: schema: $ref: '#/components/schemas/price' description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. /v1/products: get: description: >-

Returns a list of your products. The products are returned sorted by creation date, with the most recently created products appearing first.

operationId: GetProducts parameters: - description: >- Only return products that are active or inactive (e.g., pass `false` to list all inactive products). in: query name: active required: false schema: type: boolean style: form - description: >- Only return products that were created during the given date interval. explode: true in: query name: created required: false schema: anyOf: - properties: gt: type: integer gte: type: integer lt: type: integer lte: type: integer title: range_query_specs type: object - type: integer style: deepObject - description: >- A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. in: query name: ending_before required: false schema: maxLength: 5000 type: string style: form - description: Specifies which fields in the response should be expanded. explode: true in: query name: expand required: false schema: items: maxLength: 5000 type: string type: array style: deepObject - description: >- Only return products with the given IDs. Cannot be used with [starting_after](https://stripe.com/docs/api#list_products-starting_after) or [ending_before](https://stripe.com/docs/api#list_products-ending_before). explode: true in: query name: ids required: false schema: items: maxLength: 5000 type: string type: array style: deepObject - description: >- A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. in: query name: limit required: false schema: type: integer style: form - description: >- Only return products that can be shipped (i.e., physical, not digital products). in: query name: shippable required: false schema: type: boolean style: form - description: >- A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. in: query name: starting_after required: false schema: maxLength: 5000 type: string style: form - description: Only return products with the given url. in: query name: url required: false schema: maxLength: 5000 type: string style: form requestBody: content: application/x-www-form-urlencoded: encoding: {} schema: additionalProperties: false properties: {} type: object required: false responses: '200': content: application/json: schema: description: '' properties: data: description: Details about each object. items: $ref: '#/components/schemas/product' type: array has_more: description: >- True if this list has another page of items after this one that can be fetched. type: boolean object: description: >- String representing the object's type. Objects of the same type share the same value. Always has the value `list`. enum: - list type: string url: description: The URL where this list can be accessed. maxLength: 5000 pattern: ^/v1/products type: string required: - data - has_more - object - url title: ProductList type: object x-expandableFields: - data description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. post: description:

Creates a new product object.

operationId: PostProducts requestBody: content: application/x-www-form-urlencoded: encoding: default_price_data: explode: true style: deepObject expand: explode: true style: deepObject images: explode: true style: deepObject marketing_features: explode: true style: deepObject metadata: explode: true style: deepObject package_dimensions: explode: true style: deepObject schema: additionalProperties: false properties: active: description: >- Whether the product is currently available for purchase. Defaults to `true`. type: boolean default_price_data: description: >- Data used to generate a new [Price](https://stripe.com/docs/api/prices) object. This Price will be set as the default price for this product. properties: currency: type: string currency_options: additionalProperties: properties: custom_unit_amount: properties: enabled: type: boolean maximum: type: integer minimum: type: integer preset: type: integer required: - enabled title: custom_unit_amount type: object tax_behavior: enum: - exclusive - inclusive - unspecified type: string tiers: items: properties: flat_amount: type: integer flat_amount_decimal: format: decimal type: string unit_amount: type: integer unit_amount_decimal: format: decimal type: string up_to: anyOf: - enum: - inf maxLength: 5000 type: string - type: integer required: - up_to title: tier type: object type: array unit_amount: type: integer unit_amount_decimal: format: decimal type: string title: currency_option type: object type: object recurring: properties: interval: enum: - day - month - week - year type: string interval_count: type: integer required: - interval title: recurring_adhoc type: object tax_behavior: enum: - exclusive - inclusive - unspecified type: string unit_amount: type: integer unit_amount_decimal: format: decimal type: string required: - currency title: price_data_without_product type: object description: description: >- The product's description, meant to be displayable to the customer. Use this field to optionally store a long form explanation of the product being sold for your own rendering purposes. maxLength: 40000 type: string expand: description: Specifies which fields in the response should be expanded. items: maxLength: 5000 type: string type: array id: description: >- An identifier will be randomly generated by Stripe. You can optionally override this ID, but the ID must be unique across all products in your Stripe account. maxLength: 5000 type: string images: description: >- A list of up to 8 URLs of images for this product, meant to be displayable to the customer. items: type: string type: array marketing_features: description: >- A list of up to 15 marketing features for this product. These are displayed in [pricing tables](https://stripe.com/docs/payments/checkout/pricing-table). items: properties: name: maxLength: 5000 type: string required: - name title: features type: object type: array metadata: additionalProperties: type: string description: >- Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. type: object name: description: 'The product''s name, meant to be displayable to the customer.' maxLength: 5000 type: string package_dimensions: description: The dimensions of this product for shipping purposes. properties: height: type: number length: type: number weight: type: number width: type: number required: - height - length - weight - width title: package_dimensions_specs type: object shippable: description: 'Whether this product is shipped (i.e., physical goods).' type: boolean statement_descriptor: description: >- An arbitrary string to be displayed on your customer's credit card or bank statement. While most banks display this information consistently, some may display it incorrectly or not at all. This may be up to 22 characters. The statement description may not include `<`, `>`, `\`, `"`, `'` characters, and will appear on your customer's statement in capital letters. Non-ASCII characters are automatically stripped. It must contain at least one letter. maxLength: 22 type: string tax_code: description: 'A [tax code](https://stripe.com/docs/tax/tax-categories) ID.' type: string unit_label: description: >- A label that represents units of this product. When set, this will be included in customers' receipts, invoices, Checkout, and the customer portal. maxLength: 12 type: string url: description: A URL of a publicly-accessible webpage for this product. maxLength: 5000 type: string required: - name type: object required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/product' description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. /v1/products/search: get: description: >-

Search for products you’ve previously created using Stripe’s Search Query Language. Don’t use search in read-after-write flows where strict consistency is necessary. Under normal operating conditions, data is searchable in less than a minute. Occasionally, propagation of new or updated data can be up to an hour behind during outages. Search functionality is not available to merchants in India.

operationId: GetProductsSearch parameters: - description: Specifies which fields in the response should be expanded. explode: true in: query name: expand required: false schema: items: maxLength: 5000 type: string type: array style: deepObject - description: >- A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. in: query name: limit required: false schema: type: integer style: form - description: >- A cursor for pagination across multiple pages of results. Don't include this parameter on the first call. Use the next_page value returned in a previous response to request subsequent results. in: query name: page required: false schema: maxLength: 5000 type: string style: form - description: >- The search query string. See [search query language](https://stripe.com/docs/search#search-query-language) and the list of supported [query fields for products](https://stripe.com/docs/search#query-fields-for-products). in: query name: query required: true schema: maxLength: 5000 type: string style: form requestBody: content: application/x-www-form-urlencoded: encoding: {} schema: additionalProperties: false properties: {} type: object required: false responses: '200': content: application/json: schema: description: '' properties: data: items: $ref: '#/components/schemas/product' type: array has_more: type: boolean next_page: maxLength: 5000 nullable: true type: string object: description: >- String representing the object's type. Objects of the same type share the same value. enum: - search_result type: string total_count: description: >- The total number of objects that match the query, only accurate up to 10,000. type: integer url: maxLength: 5000 type: string required: - data - has_more - object - url title: SearchResult type: object x-expandableFields: - data description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. '/v1/products/{id}': delete: description: >-

Delete a product. Deleting a product is only possible if it has no prices associated with it. Additionally, deleting a product with type=good is only possible if it has no SKUs associated with it.

operationId: DeleteProductsId parameters: - in: path name: id required: true schema: maxLength: 5000 type: string style: simple requestBody: content: application/x-www-form-urlencoded: encoding: {} schema: additionalProperties: false properties: {} type: object required: false responses: '200': content: application/json: schema: $ref: '#/components/schemas/deleted_product' description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. get: description: >-

Retrieves the details of an existing product. Supply the unique product ID from either a product creation request or the product list, and Stripe will return the corresponding product information.

operationId: GetProductsId parameters: - description: Specifies which fields in the response should be expanded. explode: true in: query name: expand required: false schema: items: maxLength: 5000 type: string type: array style: deepObject - in: path name: id required: true schema: maxLength: 5000 type: string style: simple requestBody: content: application/x-www-form-urlencoded: encoding: {} schema: additionalProperties: false properties: {} type: object required: false responses: '200': content: application/json: schema: $ref: '#/components/schemas/product' description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. post: description: >-

Updates the specific product by setting the values of the parameters passed. Any parameters not provided will be left unchanged.

operationId: PostProductsId parameters: - in: path name: id required: true schema: maxLength: 5000 type: string style: simple requestBody: content: application/x-www-form-urlencoded: encoding: description: explode: true style: deepObject expand: explode: true style: deepObject images: explode: true style: deepObject marketing_features: explode: true style: deepObject metadata: explode: true style: deepObject package_dimensions: explode: true style: deepObject tax_code: explode: true style: deepObject unit_label: explode: true style: deepObject url: explode: true style: deepObject schema: additionalProperties: false properties: active: description: Whether the product is available for purchase. type: boolean default_price: description: >- The ID of the [Price](https://stripe.com/docs/api/prices) object that is the default price for this product. maxLength: 5000 type: string description: anyOf: - maxLength: 40000 type: string - enum: - '' type: string description: >- The product's description, meant to be displayable to the customer. Use this field to optionally store a long form explanation of the product being sold for your own rendering purposes. expand: description: Specifies which fields in the response should be expanded. items: maxLength: 5000 type: string type: array images: anyOf: - items: type: string type: array - enum: - '' type: string description: >- A list of up to 8 URLs of images for this product, meant to be displayable to the customer. marketing_features: anyOf: - items: properties: name: maxLength: 5000 type: string required: - name title: features type: object type: array - enum: - '' type: string description: >- A list of up to 15 marketing features for this product. These are displayed in [pricing tables](https://stripe.com/docs/payments/checkout/pricing-table). metadata: anyOf: - additionalProperties: type: string type: object - enum: - '' type: string description: >- Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. name: description: 'The product''s name, meant to be displayable to the customer.' maxLength: 5000 type: string package_dimensions: anyOf: - properties: height: type: number length: type: number weight: type: number width: type: number required: - height - length - weight - width title: package_dimensions_specs type: object - enum: - '' type: string description: The dimensions of this product for shipping purposes. shippable: description: 'Whether this product is shipped (i.e., physical goods).' type: boolean statement_descriptor: description: >- An arbitrary string to be displayed on your customer's credit card or bank statement. While most banks display this information consistently, some may display it incorrectly or not at all. This may be up to 22 characters. The statement description may not include `<`, `>`, `\`, `"`, `'` characters, and will appear on your customer's statement in capital letters. Non-ASCII characters are automatically stripped. It must contain at least one letter. May only be set if `type=service`. maxLength: 22 type: string tax_code: anyOf: - type: string - enum: - '' type: string description: 'A [tax code](https://stripe.com/docs/tax/tax-categories) ID.' unit_label: anyOf: - maxLength: 12 type: string - enum: - '' type: string description: >- A label that represents units of this product. When set, this will be included in customers' receipts, invoices, Checkout, and the customer portal. May only be set if `type=service`. url: anyOf: - type: string - enum: - '' type: string description: A URL of a publicly-accessible webpage for this product. type: object required: false responses: '200': content: application/json: schema: $ref: '#/components/schemas/product' description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. '/v1/products/{product}/features': get: description:

Retrieve a list of features for a product

operationId: GetProductsProductFeatures parameters: - description: >- A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. in: query name: ending_before required: false schema: maxLength: 5000 type: string style: form - description: Specifies which fields in the response should be expanded. explode: true in: query name: expand required: false schema: items: maxLength: 5000 type: string type: array style: deepObject - description: >- A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. in: query name: limit required: false schema: type: integer style: form - in: path name: product required: true schema: maxLength: 5000 type: string style: simple - description: >- A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. in: query name: starting_after required: false schema: maxLength: 5000 type: string style: form requestBody: content: application/x-www-form-urlencoded: encoding: {} schema: additionalProperties: false properties: {} type: object required: false responses: '200': content: application/json: schema: description: '' properties: data: items: $ref: '#/components/schemas/product_feature' type: array has_more: description: >- True if this list has another page of items after this one that can be fetched. type: boolean object: description: >- String representing the object's type. Objects of the same type share the same value. Always has the value `list`. enum: - list type: string url: description: The URL where this list can be accessed. maxLength: 5000 type: string required: - data - has_more - object - url title: EntitlementsResourceProductFeatureList type: object x-expandableFields: - data description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. post: description: >-

Creates a product_feature, which represents a feature attachment to a product

operationId: PostProductsProductFeatures parameters: - in: path name: product required: true schema: maxLength: 5000 type: string style: simple requestBody: content: application/x-www-form-urlencoded: encoding: expand: explode: true style: deepObject schema: additionalProperties: false properties: entitlement_feature: description: >- The ID of the [Feature](docs/api/entitlements/feature) object attached to this product. maxLength: 5000 type: string expand: description: Specifies which fields in the response should be expanded. items: maxLength: 5000 type: string type: array required: - entitlement_feature type: object required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/product_feature' description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. '/v1/products/{product}/features/{id}': delete: description:

Deletes the feature attachment to a product

operationId: DeleteProductsProductFeaturesId parameters: - in: path name: id required: true schema: maxLength: 5000 type: string style: simple - in: path name: product required: true schema: maxLength: 5000 type: string style: simple requestBody: content: application/x-www-form-urlencoded: encoding: {} schema: additionalProperties: false properties: {} type: object required: false responses: '200': content: application/json: schema: $ref: '#/components/schemas/deleted_product_feature' description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. get: description: >-

Retrieves a product_feature, which represents a feature attachment to a product

operationId: GetProductsProductFeaturesId parameters: - description: Specifies which fields in the response should be expanded. explode: true in: query name: expand required: false schema: items: maxLength: 5000 type: string type: array style: deepObject - description: The ID of the product_feature. in: path name: id required: true schema: maxLength: 5000 type: string style: simple - description: The ID of the product. in: path name: product required: true schema: maxLength: 5000 type: string style: simple requestBody: content: application/x-www-form-urlencoded: encoding: {} schema: additionalProperties: false properties: {} type: object required: false responses: '200': content: application/json: schema: $ref: '#/components/schemas/product_feature' description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. /v1/promotion_codes: get: description:

Returns a list of your promotion codes.

operationId: GetPromotionCodes parameters: - description: Filter promotion codes by whether they are active. in: query name: active required: false schema: type: boolean style: form - description: Only return promotion codes that have this case-insensitive code. in: query name: code required: false schema: maxLength: 5000 type: string style: form - description: Only return promotion codes for this coupon. in: query name: coupon required: false schema: maxLength: 5000 type: string style: form - description: >- A filter on the list, based on the object `created` field. The value can be a string with an integer Unix timestamp, or it can be a dictionary with a number of different query options. explode: true in: query name: created required: false schema: anyOf: - properties: gt: type: integer gte: type: integer lt: type: integer lte: type: integer title: range_query_specs type: object - type: integer style: deepObject - description: Only return promotion codes that are restricted to this customer. in: query name: customer required: false schema: maxLength: 5000 type: string style: form - description: >- A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. in: query name: ending_before required: false schema: maxLength: 5000 type: string style: form - description: Specifies which fields in the response should be expanded. explode: true in: query name: expand required: false schema: items: maxLength: 5000 type: string type: array style: deepObject - description: >- A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. in: query name: limit required: false schema: type: integer style: form - description: >- A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. in: query name: starting_after required: false schema: maxLength: 5000 type: string style: form requestBody: content: application/x-www-form-urlencoded: encoding: {} schema: additionalProperties: false properties: {} type: object required: false responses: '200': content: application/json: schema: description: '' properties: data: items: $ref: '#/components/schemas/promotion_code' type: array has_more: description: >- True if this list has another page of items after this one that can be fetched. type: boolean object: description: >- String representing the object's type. Objects of the same type share the same value. Always has the value `list`. enum: - list type: string url: description: The URL where this list can be accessed. maxLength: 5000 pattern: ^/v1/promotion_codes type: string required: - data - has_more - object - url title: PromotionCodesResourcePromotionCodeList type: object x-expandableFields: - data description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. post: description: >-

A promotion code points to a coupon. You can optionally restrict the code to a specific customer, redemption limit, and expiration date.

operationId: PostPromotionCodes requestBody: content: application/x-www-form-urlencoded: encoding: expand: explode: true style: deepObject metadata: explode: true style: deepObject restrictions: explode: true style: deepObject schema: additionalProperties: false properties: active: description: Whether the promotion code is currently active. type: boolean code: description: >- The customer-facing code. Regardless of case, this code must be unique across all active promotion codes for a specific customer. If left blank, we will generate one automatically. maxLength: 500 type: string coupon: description: The coupon for this promotion code. maxLength: 5000 type: string customer: description: >- The customer that this promotion code can be used by. If not set, the promotion code can be used by all customers. maxLength: 5000 type: string expand: description: Specifies which fields in the response should be expanded. items: maxLength: 5000 type: string type: array expires_at: description: >- The timestamp at which this promotion code will expire. If the coupon has specified a `redeems_by`, then this value cannot be after the coupon's `redeems_by`. format: unix-time type: integer max_redemptions: description: >- A positive integer specifying the number of times the promotion code can be redeemed. If the coupon has specified a `max_redemptions`, then this value cannot be greater than the coupon's `max_redemptions`. type: integer metadata: additionalProperties: type: string description: >- Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. type: object restrictions: description: Settings that restrict the redemption of the promotion code. properties: currency_options: additionalProperties: properties: minimum_amount: type: integer title: currency_option type: object type: object first_time_transaction: type: boolean minimum_amount: type: integer minimum_amount_currency: type: string title: restrictions_params type: object required: - coupon type: object required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/promotion_code' description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. '/v1/promotion_codes/{promotion_code}': get: description: >-

Retrieves the promotion code with the given ID. In order to retrieve a promotion code by the customer-facing code use list with the desired code.

operationId: GetPromotionCodesPromotionCode parameters: - description: Specifies which fields in the response should be expanded. explode: true in: query name: expand required: false schema: items: maxLength: 5000 type: string type: array style: deepObject - in: path name: promotion_code required: true schema: maxLength: 5000 type: string style: simple requestBody: content: application/x-www-form-urlencoded: encoding: {} schema: additionalProperties: false properties: {} type: object required: false responses: '200': content: application/json: schema: $ref: '#/components/schemas/promotion_code' description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. post: description: >-

Updates the specified promotion code by setting the values of the parameters passed. Most fields are, by design, not editable.

operationId: PostPromotionCodesPromotionCode parameters: - in: path name: promotion_code required: true schema: maxLength: 5000 type: string style: simple requestBody: content: application/x-www-form-urlencoded: encoding: expand: explode: true style: deepObject metadata: explode: true style: deepObject restrictions: explode: true style: deepObject schema: additionalProperties: false properties: active: description: >- Whether the promotion code is currently active. A promotion code can only be reactivated when the coupon is still valid and the promotion code is otherwise redeemable. type: boolean expand: description: Specifies which fields in the response should be expanded. items: maxLength: 5000 type: string type: array metadata: anyOf: - additionalProperties: type: string type: object - enum: - '' type: string description: >- Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. restrictions: description: Settings that restrict the redemption of the promotion code. properties: currency_options: additionalProperties: properties: minimum_amount: type: integer title: currency_option type: object type: object title: restrictions_params type: object type: object required: false responses: '200': content: application/json: schema: $ref: '#/components/schemas/promotion_code' description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. /v1/quotes: get: description:

Returns a list of your quotes.

operationId: GetQuotes parameters: - description: The ID of the customer whose quotes will be retrieved. in: query name: customer required: false schema: maxLength: 5000 type: string style: form - description: >- A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. in: query name: ending_before required: false schema: maxLength: 5000 type: string style: form - description: Specifies which fields in the response should be expanded. explode: true in: query name: expand required: false schema: items: maxLength: 5000 type: string type: array style: deepObject - description: >- A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. in: query name: limit required: false schema: type: integer style: form - description: >- A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. in: query name: starting_after required: false schema: maxLength: 5000 type: string style: form - description: The status of the quote. in: query name: status required: false schema: enum: - accepted - canceled - draft - open type: string x-stripeBypassValidation: true style: form - description: >- Provides a list of quotes that are associated with the specified test clock. The response will not include quotes with test clocks if this and the customer parameter is not set. in: query name: test_clock required: false schema: maxLength: 5000 type: string style: form requestBody: content: application/x-www-form-urlencoded: encoding: {} schema: additionalProperties: false properties: {} type: object required: false responses: '200': content: application/json: schema: description: '' properties: data: items: $ref: '#/components/schemas/quote' type: array has_more: description: >- True if this list has another page of items after this one that can be fetched. type: boolean object: description: >- String representing the object's type. Objects of the same type share the same value. Always has the value `list`. enum: - list type: string url: description: The URL where this list can be accessed. maxLength: 5000 pattern: ^/v1/quotes type: string required: - data - has_more - object - url title: QuotesResourceQuoteList type: object x-expandableFields: - data description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. post: description: >-

A quote models prices and services for a customer. Default options for header, description, footer, and expires_at can be set in the dashboard via the quote template.

operationId: PostQuotes requestBody: content: application/x-www-form-urlencoded: encoding: application_fee_amount: explode: true style: deepObject application_fee_percent: explode: true style: deepObject automatic_tax: explode: true style: deepObject default_tax_rates: explode: true style: deepObject description: explode: true style: deepObject discounts: explode: true style: deepObject expand: explode: true style: deepObject footer: explode: true style: deepObject from_quote: explode: true style: deepObject header: explode: true style: deepObject invoice_settings: explode: true style: deepObject line_items: explode: true style: deepObject metadata: explode: true style: deepObject on_behalf_of: explode: true style: deepObject subscription_data: explode: true style: deepObject transfer_data: explode: true style: deepObject schema: additionalProperties: false properties: application_fee_amount: anyOf: - type: integer - enum: - '' type: string description: >- 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. There cannot be any line items with recurring prices when using this field. application_fee_percent: anyOf: - type: number - enum: - '' type: string description: >- 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. There must be at least 1 line item with a recurring price to use this field. automatic_tax: description: >- Settings for automatic tax lookup for this quote and resulting invoices and subscriptions. properties: enabled: type: boolean liability: properties: account: type: string type: enum: - account - self type: string required: - type title: param type: object required: - enabled title: automatic_tax_param type: object collection_method: description: >- Either `charge_automatically`, or `send_invoice`. When charging automatically, Stripe will attempt to pay invoices at the end of the subscription cycle or at invoice finalization using the default payment method attached to the subscription or customer. When sending an invoice, Stripe will email your customer an invoice with payment instructions and mark the subscription as `active`. Defaults to `charge_automatically`. enum: - charge_automatically - send_invoice type: string customer: description: >- The customer for which this quote belongs to. A customer is required before finalizing the quote. Once specified, it cannot be changed. maxLength: 5000 type: string default_tax_rates: anyOf: - items: maxLength: 5000 type: string type: array - enum: - '' type: string description: >- The tax rates that will apply to any line item that does not have `tax_rates` set. description: anyOf: - maxLength: 500 type: string - enum: - '' type: string description: >- A description that will be displayed on the quote PDF. If no value is passed, the default description configured in your [quote template settings](https://dashboard.stripe.com/settings/billing/quote) will be used. discounts: anyOf: - items: properties: coupon: maxLength: 5000 type: string discount: maxLength: 5000 type: string promotion_code: maxLength: 5000 type: string title: discounts_data_param type: object type: array - enum: - '' type: string description: >- The discounts applied to the quote. You can only set up to one discount. expand: description: Specifies which fields in the response should be expanded. items: maxLength: 5000 type: string type: array expires_at: description: >- A future timestamp on which the quote will be canceled if in `open` or `draft` status. Measured in seconds since the Unix epoch. If no value is passed, the default expiration date configured in your [quote template settings](https://dashboard.stripe.com/settings/billing/quote) will be used. format: unix-time type: integer footer: anyOf: - maxLength: 500 type: string - enum: - '' type: string description: >- A footer that will be displayed on the quote PDF. If no value is passed, the default footer configured in your [quote template settings](https://dashboard.stripe.com/settings/billing/quote) will be used. from_quote: description: >- Clone an existing quote. The new quote will be created in `status=draft`. When using this parameter, you cannot specify any other parameters except for `expires_at`. properties: is_revision: type: boolean quote: maxLength: 5000 type: string required: - quote title: from_quote_params type: object header: anyOf: - maxLength: 50 type: string - enum: - '' type: string description: >- A header that will be displayed on the quote PDF. If no value is passed, the default header configured in your [quote template settings](https://dashboard.stripe.com/settings/billing/quote) will be used. invoice_settings: description: All invoices will be billed using the specified settings. properties: days_until_due: type: integer issuer: properties: account: type: string type: enum: - account - self type: string required: - type title: param type: object title: quote_param type: object line_items: description: >- A list of line items the customer is being quoted for. Each line item includes information about the product, the quantity, and the resulting cost. items: properties: discounts: anyOf: - items: properties: coupon: maxLength: 5000 type: string discount: maxLength: 5000 type: string promotion_code: maxLength: 5000 type: string title: discounts_data_param type: object type: array - enum: - '' type: string price: maxLength: 5000 type: string price_data: properties: currency: type: string product: maxLength: 5000 type: string recurring: properties: interval: enum: - day - month - week - year type: string interval_count: type: integer required: - interval title: recurring_adhoc type: object tax_behavior: enum: - exclusive - inclusive - unspecified type: string unit_amount: type: integer unit_amount_decimal: format: decimal type: string required: - currency - product title: price_data type: object quantity: type: integer tax_rates: anyOf: - items: maxLength: 5000 type: string type: array - enum: - '' type: string title: line_item_create_params type: object type: array metadata: additionalProperties: type: string description: >- Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. type: object on_behalf_of: anyOf: - type: string - enum: - '' type: string description: The account on behalf of which to charge. subscription_data: description: >- When creating a subscription or subscription schedule, the specified configuration data will be used. There must be at least one line item with a recurring price for a subscription or subscription schedule to be created. A subscription schedule is created if `subscription_data[effective_date]` is present and in the future, otherwise a subscription is created. properties: description: maxLength: 500 type: string effective_date: anyOf: - enum: - current_period_end maxLength: 5000 type: string - format: unix-time type: integer - enum: - '' type: string metadata: additionalProperties: type: string type: object trial_period_days: anyOf: - type: integer - enum: - '' type: string title: subscription_data_create_params type: object test_clock: description: ID of the test clock to attach to the quote. maxLength: 5000 type: string transfer_data: anyOf: - properties: amount: type: integer amount_percent: type: number destination: type: string required: - destination title: transfer_data_specs type: object - enum: - '' type: string description: >- The data with which to automatically create a Transfer for each of the invoices. type: object required: false responses: '200': content: application/json: schema: $ref: '#/components/schemas/quote' description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. '/v1/quotes/{quote}': get: description:

Retrieves the quote with the given ID.

operationId: GetQuotesQuote parameters: - description: Specifies which fields in the response should be expanded. explode: true in: query name: expand required: false schema: items: maxLength: 5000 type: string type: array style: deepObject - in: path name: quote required: true schema: maxLength: 5000 type: string style: simple requestBody: content: application/x-www-form-urlencoded: encoding: {} schema: additionalProperties: false properties: {} type: object required: false responses: '200': content: application/json: schema: $ref: '#/components/schemas/quote' description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. post: description:

A quote models prices and services for a customer.

operationId: PostQuotesQuote parameters: - in: path name: quote required: true schema: maxLength: 5000 type: string style: simple requestBody: content: application/x-www-form-urlencoded: encoding: application_fee_amount: explode: true style: deepObject application_fee_percent: explode: true style: deepObject automatic_tax: explode: true style: deepObject default_tax_rates: explode: true style: deepObject description: explode: true style: deepObject discounts: explode: true style: deepObject expand: explode: true style: deepObject footer: explode: true style: deepObject header: explode: true style: deepObject invoice_settings: explode: true style: deepObject line_items: explode: true style: deepObject metadata: explode: true style: deepObject on_behalf_of: explode: true style: deepObject subscription_data: explode: true style: deepObject transfer_data: explode: true style: deepObject schema: additionalProperties: false properties: application_fee_amount: anyOf: - type: integer - enum: - '' type: string description: >- 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. There cannot be any line items with recurring prices when using this field. application_fee_percent: anyOf: - type: number - enum: - '' type: string description: >- 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. There must be at least 1 line item with a recurring price to use this field. automatic_tax: description: >- Settings for automatic tax lookup for this quote and resulting invoices and subscriptions. properties: enabled: type: boolean liability: properties: account: type: string type: enum: - account - self type: string required: - type title: param type: object required: - enabled title: automatic_tax_param type: object collection_method: description: >- Either `charge_automatically`, or `send_invoice`. When charging automatically, Stripe will attempt to pay invoices at the end of the subscription cycle or at invoice finalization using the default payment method attached to the subscription or customer. When sending an invoice, Stripe will email your customer an invoice with payment instructions and mark the subscription as `active`. Defaults to `charge_automatically`. enum: - charge_automatically - send_invoice type: string customer: description: >- The customer for which this quote belongs to. A customer is required before finalizing the quote. Once specified, it cannot be changed. maxLength: 5000 type: string default_tax_rates: anyOf: - items: maxLength: 5000 type: string type: array - enum: - '' type: string description: >- The tax rates that will apply to any line item that does not have `tax_rates` set. description: anyOf: - maxLength: 500 type: string - enum: - '' type: string description: A description that will be displayed on the quote PDF. discounts: anyOf: - items: properties: coupon: maxLength: 5000 type: string discount: maxLength: 5000 type: string promotion_code: maxLength: 5000 type: string title: discounts_data_param type: object type: array - enum: - '' type: string description: >- The discounts applied to the quote. You can only set up to one discount. expand: description: Specifies which fields in the response should be expanded. items: maxLength: 5000 type: string type: array expires_at: description: >- A future timestamp on which the quote will be canceled if in `open` or `draft` status. Measured in seconds since the Unix epoch. format: unix-time type: integer footer: anyOf: - maxLength: 500 type: string - enum: - '' type: string description: A footer that will be displayed on the quote PDF. header: anyOf: - maxLength: 50 type: string - enum: - '' type: string description: A header that will be displayed on the quote PDF. invoice_settings: description: All invoices will be billed using the specified settings. properties: days_until_due: type: integer issuer: properties: account: type: string type: enum: - account - self type: string required: - type title: param type: object title: quote_param type: object line_items: description: >- A list of line items the customer is being quoted for. Each line item includes information about the product, the quantity, and the resulting cost. items: properties: discounts: anyOf: - items: properties: coupon: maxLength: 5000 type: string discount: maxLength: 5000 type: string promotion_code: maxLength: 5000 type: string title: discounts_data_param type: object type: array - enum: - '' type: string id: maxLength: 5000 type: string price: maxLength: 5000 type: string price_data: properties: currency: type: string product: maxLength: 5000 type: string recurring: properties: interval: enum: - day - month - week - year type: string interval_count: type: integer required: - interval title: recurring_adhoc type: object tax_behavior: enum: - exclusive - inclusive - unspecified type: string unit_amount: type: integer unit_amount_decimal: format: decimal type: string required: - currency - product title: price_data type: object quantity: type: integer tax_rates: anyOf: - items: maxLength: 5000 type: string type: array - enum: - '' type: string title: line_item_update_params type: object type: array metadata: additionalProperties: type: string description: >- Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. type: object on_behalf_of: anyOf: - type: string - enum: - '' type: string description: The account on behalf of which to charge. subscription_data: description: >- When creating a subscription or subscription schedule, the specified configuration data will be used. There must be at least one line item with a recurring price for a subscription or subscription schedule to be created. A subscription schedule is created if `subscription_data[effective_date]` is present and in the future, otherwise a subscription is created. properties: description: anyOf: - maxLength: 500 type: string - enum: - '' type: string effective_date: anyOf: - enum: - current_period_end maxLength: 5000 type: string - format: unix-time type: integer - enum: - '' type: string metadata: additionalProperties: type: string type: object trial_period_days: anyOf: - type: integer - enum: - '' type: string title: subscription_data_update_params type: object transfer_data: anyOf: - properties: amount: type: integer amount_percent: type: number destination: type: string required: - destination title: transfer_data_specs type: object - enum: - '' type: string description: >- The data with which to automatically create a Transfer for each of the invoices. type: object required: false responses: '200': content: application/json: schema: $ref: '#/components/schemas/quote' description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. '/v1/quotes/{quote}/accept': post: description:

Accepts the specified quote.

operationId: PostQuotesQuoteAccept parameters: - in: path name: quote required: true schema: maxLength: 5000 type: string style: simple requestBody: content: application/x-www-form-urlencoded: encoding: expand: explode: true style: deepObject schema: additionalProperties: false properties: expand: description: Specifies which fields in the response should be expanded. items: maxLength: 5000 type: string type: array type: object required: false responses: '200': content: application/json: schema: $ref: '#/components/schemas/quote' description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. '/v1/quotes/{quote}/cancel': post: description:

Cancels the quote.

operationId: PostQuotesQuoteCancel parameters: - in: path name: quote required: true schema: maxLength: 5000 type: string style: simple requestBody: content: application/x-www-form-urlencoded: encoding: expand: explode: true style: deepObject schema: additionalProperties: false properties: expand: description: Specifies which fields in the response should be expanded. items: maxLength: 5000 type: string type: array type: object required: false responses: '200': content: application/json: schema: $ref: '#/components/schemas/quote' description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. '/v1/quotes/{quote}/computed_upfront_line_items': get: description: >-

When retrieving a quote, there is an includable computed.upfront.line_items property containing the first handful of those items. There is also a URL where you can retrieve the full (paginated) list of upfront line items.

operationId: GetQuotesQuoteComputedUpfrontLineItems parameters: - description: >- A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. in: query name: ending_before required: false schema: maxLength: 5000 type: string style: form - description: Specifies which fields in the response should be expanded. explode: true in: query name: expand required: false schema: items: maxLength: 5000 type: string type: array style: deepObject - description: >- A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. in: query name: limit required: false schema: type: integer style: form - in: path name: quote required: true schema: maxLength: 5000 type: string style: simple - description: >- A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. in: query name: starting_after required: false schema: maxLength: 5000 type: string style: form requestBody: content: application/x-www-form-urlencoded: encoding: {} schema: additionalProperties: false properties: {} type: object required: false responses: '200': content: application/json: schema: description: '' properties: data: description: Details about each object. items: $ref: '#/components/schemas/item' type: array has_more: description: >- True if this list has another page of items after this one that can be fetched. type: boolean object: description: >- String representing the object's type. Objects of the same type share the same value. Always has the value `list`. enum: - list type: string url: description: The URL where this list can be accessed. maxLength: 5000 type: string required: - data - has_more - object - url title: QuotesResourceListLineItems type: object x-expandableFields: - data description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. '/v1/quotes/{quote}/finalize': post: description:

Finalizes the quote.

operationId: PostQuotesQuoteFinalize parameters: - in: path name: quote required: true schema: maxLength: 5000 type: string style: simple requestBody: content: application/x-www-form-urlencoded: encoding: expand: explode: true style: deepObject schema: additionalProperties: false properties: expand: description: Specifies which fields in the response should be expanded. items: maxLength: 5000 type: string type: array expires_at: description: >- A future timestamp on which the quote will be canceled if in `open` or `draft` status. Measured in seconds since the Unix epoch. format: unix-time type: integer type: object required: false responses: '200': content: application/json: schema: $ref: '#/components/schemas/quote' description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. '/v1/quotes/{quote}/line_items': get: description: >-

When retrieving a quote, there is an includable line_items property containing the first handful of those items. There is also a URL where you can retrieve the full (paginated) list of line items.

operationId: GetQuotesQuoteLineItems parameters: - description: >- A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. in: query name: ending_before required: false schema: maxLength: 5000 type: string style: form - description: Specifies which fields in the response should be expanded. explode: true in: query name: expand required: false schema: items: maxLength: 5000 type: string type: array style: deepObject - description: >- A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. in: query name: limit required: false schema: type: integer style: form - in: path name: quote required: true schema: maxLength: 5000 type: string style: simple - description: >- A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. in: query name: starting_after required: false schema: maxLength: 5000 type: string style: form requestBody: content: application/x-www-form-urlencoded: encoding: {} schema: additionalProperties: false properties: {} type: object required: false responses: '200': content: application/json: schema: description: '' properties: data: description: Details about each object. items: $ref: '#/components/schemas/item' type: array has_more: description: >- True if this list has another page of items after this one that can be fetched. type: boolean object: description: >- String representing the object's type. Objects of the same type share the same value. Always has the value `list`. enum: - list type: string url: description: The URL where this list can be accessed. maxLength: 5000 type: string required: - data - has_more - object - url title: QuotesResourceListLineItems type: object x-expandableFields: - data description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. '/v1/quotes/{quote}/pdf': get: description: >-

Download the PDF for a finalized quote. Explanation for special handling can be found here

operationId: GetQuotesQuotePdf parameters: - description: Specifies which fields in the response should be expanded. explode: true in: query name: expand required: false schema: items: maxLength: 5000 type: string type: array style: deepObject - in: path name: quote required: true schema: maxLength: 5000 type: string style: simple requestBody: content: application/x-www-form-urlencoded: encoding: {} schema: additionalProperties: false properties: {} type: object required: false responses: '200': content: application/pdf: schema: format: binary type: string description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. servers: - url: 'https://files.stripe.com/' /v1/radar/early_fraud_warnings: get: description:

Returns a list of early fraud warnings.

operationId: GetRadarEarlyFraudWarnings parameters: - description: >- Only return early fraud warnings for the charge specified by this charge ID. in: query name: charge required: false schema: type: string style: form - description: >- Only return early fraud warnings that were created during the given date interval. explode: true in: query name: created required: false schema: anyOf: - properties: gt: type: integer gte: type: integer lt: type: integer lte: type: integer title: range_query_specs type: object - type: integer style: deepObject - description: >- A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. in: query name: ending_before required: false schema: maxLength: 5000 type: string style: form - description: Specifies which fields in the response should be expanded. explode: true in: query name: expand required: false schema: items: maxLength: 5000 type: string type: array style: deepObject - description: >- A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. in: query name: limit required: false schema: type: integer style: form - description: >- Only return early fraud warnings for charges that were created by the PaymentIntent specified by this PaymentIntent ID. in: query name: payment_intent required: false schema: maxLength: 5000 type: string style: form - description: >- A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. in: query name: starting_after required: false schema: maxLength: 5000 type: string style: form requestBody: content: application/x-www-form-urlencoded: encoding: {} schema: additionalProperties: false properties: {} type: object required: false responses: '200': content: application/json: schema: description: '' properties: data: items: $ref: '#/components/schemas/radar.early_fraud_warning' type: array has_more: description: >- True if this list has another page of items after this one that can be fetched. type: boolean object: description: >- String representing the object's type. Objects of the same type share the same value. Always has the value `list`. enum: - list type: string url: description: The URL where this list can be accessed. maxLength: 5000 pattern: ^/v1/radar/early_fraud_warnings type: string required: - data - has_more - object - url title: RadarEarlyFraudWarningList type: object x-expandableFields: - data description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. '/v1/radar/early_fraud_warnings/{early_fraud_warning}': get: description: >-

Retrieves the details of an early fraud warning that has previously been created.

Please refer to the early fraud warning object reference for more details.

operationId: GetRadarEarlyFraudWarningsEarlyFraudWarning parameters: - in: path name: early_fraud_warning required: true schema: maxLength: 5000 type: string style: simple - description: Specifies which fields in the response should be expanded. explode: true in: query name: expand required: false schema: items: maxLength: 5000 type: string type: array style: deepObject requestBody: content: application/x-www-form-urlencoded: encoding: {} schema: additionalProperties: false properties: {} type: object required: false responses: '200': content: application/json: schema: $ref: '#/components/schemas/radar.early_fraud_warning' description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. /v1/radar/value_list_items: get: description: >-

Returns a list of ValueListItem objects. The objects are sorted in descending order by creation date, with the most recently created object appearing first.

operationId: GetRadarValueListItems parameters: - description: Only return items that were created during the given date interval. explode: true in: query name: created required: false schema: anyOf: - properties: gt: type: integer gte: type: integer lt: type: integer lte: type: integer title: range_query_specs type: object - type: integer style: deepObject - description: >- A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. in: query name: ending_before required: false schema: maxLength: 5000 type: string style: form - description: Specifies which fields in the response should be expanded. explode: true in: query name: expand required: false schema: items: maxLength: 5000 type: string type: array style: deepObject - description: >- A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. in: query name: limit required: false schema: type: integer style: form - description: >- A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. in: query name: starting_after required: false schema: maxLength: 5000 type: string style: form - description: >- Return items belonging to the parent list whose value matches the specified value (using an "is like" match). in: query name: value required: false schema: maxLength: 800 type: string style: form - description: Identifier for the parent value list this item belongs to. in: query name: value_list required: true schema: maxLength: 5000 type: string style: form requestBody: content: application/x-www-form-urlencoded: encoding: {} schema: additionalProperties: false properties: {} type: object required: false responses: '200': content: application/json: schema: description: '' properties: data: items: $ref: '#/components/schemas/radar.value_list_item' type: array has_more: description: >- True if this list has another page of items after this one that can be fetched. type: boolean object: description: >- String representing the object's type. Objects of the same type share the same value. Always has the value `list`. enum: - list type: string url: description: The URL where this list can be accessed. maxLength: 5000 pattern: ^/v1/radar/value_list_items type: string required: - data - has_more - object - url title: RadarListListItemList type: object x-expandableFields: - data description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. post: description: >-

Creates a new ValueListItem object, which is added to the specified parent value list.

operationId: PostRadarValueListItems requestBody: content: application/x-www-form-urlencoded: encoding: expand: explode: true style: deepObject schema: additionalProperties: false properties: expand: description: Specifies which fields in the response should be expanded. items: maxLength: 5000 type: string type: array value: description: >- The value of the item (whose type must match the type of the parent value list). maxLength: 800 type: string value_list: description: >- The identifier of the value list which the created item will be added to. maxLength: 5000 type: string required: - value - value_list type: object required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/radar.value_list_item' description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. '/v1/radar/value_list_items/{item}': delete: description: >-

Deletes a ValueListItem object, removing it from its parent value list.

operationId: DeleteRadarValueListItemsItem parameters: - in: path name: item required: true schema: maxLength: 5000 type: string style: simple requestBody: content: application/x-www-form-urlencoded: encoding: {} schema: additionalProperties: false properties: {} type: object required: false responses: '200': content: application/json: schema: $ref: '#/components/schemas/deleted_radar.value_list_item' description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. get: description:

Retrieves a ValueListItem object.

operationId: GetRadarValueListItemsItem parameters: - description: Specifies which fields in the response should be expanded. explode: true in: query name: expand required: false schema: items: maxLength: 5000 type: string type: array style: deepObject - in: path name: item required: true schema: maxLength: 5000 type: string style: simple requestBody: content: application/x-www-form-urlencoded: encoding: {} schema: additionalProperties: false properties: {} type: object required: false responses: '200': content: application/json: schema: $ref: '#/components/schemas/radar.value_list_item' description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. /v1/radar/value_lists: get: description: >-

Returns a list of ValueList objects. The objects are sorted in descending order by creation date, with the most recently created object appearing first.

operationId: GetRadarValueLists parameters: - description: The alias used to reference the value list when writing rules. in: query name: alias required: false schema: maxLength: 100 type: string style: form - description: >- A value contained within a value list - returns all value lists containing this value. in: query name: contains required: false schema: maxLength: 800 type: string style: form - description: >- Only return value lists that were created during the given date interval. explode: true in: query name: created required: false schema: anyOf: - properties: gt: type: integer gte: type: integer lt: type: integer lte: type: integer title: range_query_specs type: object - type: integer style: deepObject - description: >- A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. in: query name: ending_before required: false schema: maxLength: 5000 type: string style: form - description: Specifies which fields in the response should be expanded. explode: true in: query name: expand required: false schema: items: maxLength: 5000 type: string type: array style: deepObject - description: >- A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. in: query name: limit required: false schema: type: integer style: form - description: >- A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. in: query name: starting_after required: false schema: maxLength: 5000 type: string style: form requestBody: content: application/x-www-form-urlencoded: encoding: {} schema: additionalProperties: false properties: {} type: object required: false responses: '200': content: application/json: schema: description: '' properties: data: items: $ref: '#/components/schemas/radar.value_list' type: array has_more: description: >- True if this list has another page of items after this one that can be fetched. type: boolean object: description: >- String representing the object's type. Objects of the same type share the same value. Always has the value `list`. enum: - list type: string url: description: The URL where this list can be accessed. maxLength: 5000 pattern: ^/v1/radar/value_lists type: string required: - data - has_more - object - url title: RadarListListList type: object x-expandableFields: - data description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. post: description: >-

Creates a new ValueList object, which can then be referenced in rules.

operationId: PostRadarValueLists requestBody: content: application/x-www-form-urlencoded: encoding: expand: explode: true style: deepObject metadata: explode: true style: deepObject schema: additionalProperties: false properties: alias: description: The name of the value list for use in rules. maxLength: 100 type: string expand: description: Specifies which fields in the response should be expanded. items: maxLength: 5000 type: string type: array item_type: description: >- Type of the items in the value list. One of `card_fingerprint`, `us_bank_account_fingerprint`, `sepa_debit_fingerprint`, `card_bin`, `email`, `ip_address`, `country`, `string`, `case_sensitive_string`, or `customer_id`. Use `string` if the item type is unknown or mixed. enum: - card_bin - card_fingerprint - case_sensitive_string - country - customer_id - email - ip_address - sepa_debit_fingerprint - string - us_bank_account_fingerprint maxLength: 5000 type: string metadata: additionalProperties: type: string description: >- Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. type: object name: description: The human-readable name of the value list. maxLength: 100 type: string required: - alias - name type: object required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/radar.value_list' description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. '/v1/radar/value_lists/{value_list}': delete: description: >-

Deletes a ValueList object, also deleting any items contained within the value list. To be deleted, a value list must not be referenced in any rules.

operationId: DeleteRadarValueListsValueList parameters: - in: path name: value_list required: true schema: maxLength: 5000 type: string style: simple requestBody: content: application/x-www-form-urlencoded: encoding: {} schema: additionalProperties: false properties: {} type: object required: false responses: '200': content: application/json: schema: $ref: '#/components/schemas/deleted_radar.value_list' description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. get: description:

Retrieves a ValueList object.

operationId: GetRadarValueListsValueList parameters: - description: Specifies which fields in the response should be expanded. explode: true in: query name: expand required: false schema: items: maxLength: 5000 type: string type: array style: deepObject - in: path name: value_list required: true schema: maxLength: 5000 type: string style: simple requestBody: content: application/x-www-form-urlencoded: encoding: {} schema: additionalProperties: false properties: {} type: object required: false responses: '200': content: application/json: schema: $ref: '#/components/schemas/radar.value_list' description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. post: description: >-

Updates a ValueList object by setting the values of the parameters passed. Any parameters not provided will be left unchanged. Note that item_type is immutable.

operationId: PostRadarValueListsValueList parameters: - in: path name: value_list required: true schema: maxLength: 5000 type: string style: simple requestBody: content: application/x-www-form-urlencoded: encoding: expand: explode: true style: deepObject metadata: explode: true style: deepObject schema: additionalProperties: false properties: alias: description: The name of the value list for use in rules. maxLength: 100 type: string expand: description: Specifies which fields in the response should be expanded. items: maxLength: 5000 type: string type: array metadata: additionalProperties: type: string description: >- Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. type: object name: description: The human-readable name of the value list. maxLength: 100 type: string type: object required: false responses: '200': content: application/json: schema: $ref: '#/components/schemas/radar.value_list' description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. /v1/refunds: get: description: >-

Returns a list of all refunds you created. We return the refunds in sorted order, with the most recent refunds appearing first The 10 most recent refunds are always available by default on the Charge object.

operationId: GetRefunds parameters: - description: Only return refunds for the charge specified by this charge ID. in: query name: charge required: false schema: type: string style: form - description: >- Only return refunds that were created during the given date interval. explode: true in: query name: created required: false schema: anyOf: - properties: gt: type: integer gte: type: integer lt: type: integer lte: type: integer title: range_query_specs type: object - type: integer style: deepObject - description: >- A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. in: query name: ending_before required: false schema: type: string style: form - description: Specifies which fields in the response should be expanded. explode: true in: query name: expand required: false schema: items: maxLength: 5000 type: string type: array style: deepObject - description: >- A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. in: query name: limit required: false schema: type: integer style: form - description: Only return refunds for the PaymentIntent specified by this ID. in: query name: payment_intent required: false schema: maxLength: 5000 type: string style: form - description: >- A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. in: query name: starting_after required: false schema: type: string style: form requestBody: content: application/x-www-form-urlencoded: encoding: {} schema: additionalProperties: false properties: {} type: object required: false responses: '200': content: application/json: schema: description: '' properties: data: items: $ref: '#/components/schemas/refund' type: array has_more: description: >- True if this list has another page of items after this one that can be fetched. type: boolean object: description: >- String representing the object's type. Objects of the same type share the same value. Always has the value `list`. enum: - list type: string url: description: The URL where this list can be accessed. maxLength: 5000 pattern: ^/v1/refunds type: string required: - data - has_more - object - url title: APIMethodRefundList type: object x-expandableFields: - data description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. post: description: >-

When you create a new refund, you must specify a Charge or a PaymentIntent object on which to create it.

Creating a new refund will refund a charge that has previously been created but not yet refunded. Funds will be refunded to the credit or debit card that was originally charged.

You can optionally refund only part of a charge. You can do so multiple times, until the entire charge has been refunded.

Once entirely refunded, a charge can’t be refunded again. This method will raise an error when called on an already-refunded charge, or when trying to refund more money than is left on a charge.

operationId: PostRefunds requestBody: content: application/x-www-form-urlencoded: encoding: expand: explode: true style: deepObject metadata: explode: true style: deepObject schema: additionalProperties: false properties: amount: type: integer charge: description: The identifier of the charge to refund. maxLength: 5000 type: string currency: description: >- 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). type: string customer: description: Customer whose customer balance to refund from. maxLength: 5000 type: string expand: description: Specifies which fields in the response should be expanded. items: maxLength: 5000 type: string type: array instructions_email: description: >- For payment methods without native refund support (e.g., Konbini, PromptPay), use this email from the customer to receive refund instructions. type: string metadata: anyOf: - additionalProperties: type: string type: object - enum: - '' type: string description: >- Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. origin: description: Origin of the refund enum: - customer_balance type: string payment_intent: description: The identifier of the PaymentIntent to refund. maxLength: 5000 type: string reason: description: >- String indicating the reason for the refund. If set, possible values are `duplicate`, `fraudulent`, and `requested_by_customer`. If you believe the charge to be fraudulent, specifying `fraudulent` as the reason will add the associated card and email to your [block lists](https://stripe.com/docs/radar/lists), and will also help us improve our fraud detection algorithms. enum: - duplicate - fraudulent - requested_by_customer maxLength: 5000 type: string refund_application_fee: description: >- Boolean indicating whether the application fee should be refunded when refunding this charge. If a full charge refund is given, the full application fee will be refunded. Otherwise, the application fee will be refunded in an amount proportional to the amount of the charge refunded. An application fee can be refunded only by the application that created the charge. type: boolean reverse_transfer: description: >- Boolean indicating whether the transfer should be reversed when refunding this charge. The transfer will be reversed proportionally to the amount being refunded (either the entire or partial amount).

A transfer can be reversed only by the application that created the charge. type: boolean type: object required: false responses: '200': content: application/json: schema: $ref: '#/components/schemas/refund' description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. '/v1/refunds/{refund}': get: description:

Retrieves the details of an existing refund.

operationId: GetRefundsRefund parameters: - description: Specifies which fields in the response should be expanded. explode: true in: query name: expand required: false schema: items: maxLength: 5000 type: string type: array style: deepObject - in: path name: refund required: true schema: type: string style: simple requestBody: content: application/x-www-form-urlencoded: encoding: {} schema: additionalProperties: false properties: {} type: object required: false responses: '200': content: application/json: schema: $ref: '#/components/schemas/refund' description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. post: description: >-

Updates the refund that you specify by setting the values of the passed parameters. Any parameters that you don’t provide remain unchanged.

This request only accepts metadata as an argument.

operationId: PostRefundsRefund parameters: - in: path name: refund required: true schema: type: string style: simple requestBody: content: application/x-www-form-urlencoded: encoding: expand: explode: true style: deepObject metadata: explode: true style: deepObject schema: additionalProperties: false properties: expand: description: Specifies which fields in the response should be expanded. items: maxLength: 5000 type: string type: array metadata: anyOf: - additionalProperties: type: string type: object - enum: - '' type: string description: >- Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. type: object required: false responses: '200': content: application/json: schema: $ref: '#/components/schemas/refund' description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. '/v1/refunds/{refund}/cancel': post: description: >-

Cancels a refund with a status of requires_action.

You can’t cancel refunds in other states. Only refunds for payment methods that require customer action can enter the requires_action state.

operationId: PostRefundsRefundCancel parameters: - in: path name: refund required: true schema: type: string style: simple requestBody: content: application/x-www-form-urlencoded: encoding: expand: explode: true style: deepObject schema: additionalProperties: false properties: expand: description: Specifies which fields in the response should be expanded. items: maxLength: 5000 type: string type: array type: object required: false responses: '200': content: application/json: schema: $ref: '#/components/schemas/refund' description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. /v1/reporting/report_runs: get: description: >-

Returns a list of Report Runs, with the most recent appearing first.

operationId: GetReportingReportRuns parameters: - description: >- Only return Report Runs that were created during the given date interval. explode: true in: query name: created required: false schema: anyOf: - properties: gt: type: integer gte: type: integer lt: type: integer lte: type: integer title: range_query_specs type: object - type: integer style: deepObject - description: >- A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. in: query name: ending_before required: false schema: maxLength: 5000 type: string style: form - description: Specifies which fields in the response should be expanded. explode: true in: query name: expand required: false schema: items: maxLength: 5000 type: string type: array style: deepObject - description: >- A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. in: query name: limit required: false schema: type: integer style: form - description: >- A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. in: query name: starting_after required: false schema: maxLength: 5000 type: string style: form requestBody: content: application/x-www-form-urlencoded: encoding: {} schema: additionalProperties: false properties: {} type: object required: false responses: '200': content: application/json: schema: description: '' properties: data: items: $ref: '#/components/schemas/reporting.report_run' type: array has_more: description: >- True if this list has another page of items after this one that can be fetched. type: boolean object: description: >- String representing the object's type. Objects of the same type share the same value. Always has the value `list`. enum: - list type: string url: description: The URL where this list can be accessed. maxLength: 5000 pattern: ^/v1/reporting/report_runs type: string required: - data - has_more - object - url title: FinancialReportingFinanceReportRunList type: object x-expandableFields: - data description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. post: description: >-

Creates a new object and begin running the report. (Certain report types require a live-mode API key.)

operationId: PostReportingReportRuns requestBody: content: application/x-www-form-urlencoded: encoding: expand: explode: true style: deepObject parameters: explode: true style: deepObject schema: additionalProperties: false properties: expand: description: Specifies which fields in the response should be expanded. items: maxLength: 5000 type: string type: array parameters: description: >- Parameters specifying how the report should be run. Different Report Types have different required and optional parameters, listed in the [API Access to Reports](https://stripe.com/docs/reporting/statements/api) documentation. properties: columns: items: maxLength: 5000 type: string type: array connected_account: type: string currency: type: string interval_end: format: unix-time type: integer interval_start: format: unix-time type: integer payout: type: string reporting_category: enum: - advance - advance_funding - anticipation_repayment - charge - charge_failure - climate_order_purchase - climate_order_refund - connect_collection_transfer - connect_reserved_funds - contribution - dispute - dispute_reversal - fee - financing_paydown - financing_paydown_reversal - financing_payout - financing_payout_reversal - issuing_authorization_hold - issuing_authorization_release - issuing_dispute - issuing_transaction - network_cost - other_adjustment - partial_capture_reversal - payout - payout_reversal - platform_earning - platform_earning_refund - refund - refund_failure - risk_reserved_funds - tax - topup - topup_reversal - transfer - transfer_reversal - unreconciled_customer_funds maxLength: 5000 type: string x-stripeBypassValidation: true timezone: enum: - Africa/Abidjan - Africa/Accra - Africa/Addis_Ababa - Africa/Algiers - Africa/Asmara - Africa/Asmera - Africa/Bamako - Africa/Bangui - Africa/Banjul - Africa/Bissau - Africa/Blantyre - Africa/Brazzaville - Africa/Bujumbura - Africa/Cairo - Africa/Casablanca - Africa/Ceuta - Africa/Conakry - Africa/Dakar - Africa/Dar_es_Salaam - Africa/Djibouti - Africa/Douala - Africa/El_Aaiun - Africa/Freetown - Africa/Gaborone - Africa/Harare - Africa/Johannesburg - Africa/Juba - Africa/Kampala - Africa/Khartoum - Africa/Kigali - Africa/Kinshasa - Africa/Lagos - Africa/Libreville - Africa/Lome - Africa/Luanda - Africa/Lubumbashi - Africa/Lusaka - Africa/Malabo - Africa/Maputo - Africa/Maseru - Africa/Mbabane - Africa/Mogadishu - Africa/Monrovia - Africa/Nairobi - Africa/Ndjamena - Africa/Niamey - Africa/Nouakchott - Africa/Ouagadougou - Africa/Porto-Novo - Africa/Sao_Tome - Africa/Timbuktu - Africa/Tripoli - Africa/Tunis - Africa/Windhoek - America/Adak - America/Anchorage - America/Anguilla - America/Antigua - America/Araguaina - America/Argentina/Buenos_Aires - America/Argentina/Catamarca - America/Argentina/ComodRivadavia - America/Argentina/Cordoba - America/Argentina/Jujuy - America/Argentina/La_Rioja - America/Argentina/Mendoza - America/Argentina/Rio_Gallegos - America/Argentina/Salta - America/Argentina/San_Juan - America/Argentina/San_Luis - America/Argentina/Tucuman - America/Argentina/Ushuaia - America/Aruba - America/Asuncion - America/Atikokan - America/Atka - America/Bahia - America/Bahia_Banderas - America/Barbados - America/Belem - America/Belize - America/Blanc-Sablon - America/Boa_Vista - America/Bogota - America/Boise - America/Buenos_Aires - America/Cambridge_Bay - America/Campo_Grande - America/Cancun - America/Caracas - America/Catamarca - America/Cayenne - America/Cayman - America/Chicago - America/Chihuahua - America/Ciudad_Juarez - America/Coral_Harbour - America/Cordoba - America/Costa_Rica - America/Creston - America/Cuiaba - America/Curacao - America/Danmarkshavn - America/Dawson - America/Dawson_Creek - America/Denver - America/Detroit - America/Dominica - America/Edmonton - America/Eirunepe - America/El_Salvador - America/Ensenada - America/Fort_Nelson - America/Fort_Wayne - America/Fortaleza - America/Glace_Bay - America/Godthab - America/Goose_Bay - America/Grand_Turk - America/Grenada - America/Guadeloupe - America/Guatemala - America/Guayaquil - America/Guyana - America/Halifax - America/Havana - America/Hermosillo - America/Indiana/Indianapolis - America/Indiana/Knox - America/Indiana/Marengo - America/Indiana/Petersburg - America/Indiana/Tell_City - America/Indiana/Vevay - America/Indiana/Vincennes - America/Indiana/Winamac - America/Indianapolis - America/Inuvik - America/Iqaluit - America/Jamaica - America/Jujuy - America/Juneau - America/Kentucky/Louisville - America/Kentucky/Monticello - America/Knox_IN - America/Kralendijk - America/La_Paz - America/Lima - America/Los_Angeles - America/Louisville - America/Lower_Princes - America/Maceio - America/Managua - America/Manaus - America/Marigot - America/Martinique - America/Matamoros - America/Mazatlan - America/Mendoza - America/Menominee - America/Merida - America/Metlakatla - America/Mexico_City - America/Miquelon - America/Moncton - America/Monterrey - America/Montevideo - America/Montreal - America/Montserrat - America/Nassau - America/New_York - America/Nipigon - America/Nome - America/Noronha - America/North_Dakota/Beulah - America/North_Dakota/Center - America/North_Dakota/New_Salem - America/Nuuk - America/Ojinaga - America/Panama - America/Pangnirtung - America/Paramaribo - America/Phoenix - America/Port-au-Prince - America/Port_of_Spain - America/Porto_Acre - America/Porto_Velho - America/Puerto_Rico - America/Punta_Arenas - America/Rainy_River - America/Rankin_Inlet - America/Recife - America/Regina - America/Resolute - America/Rio_Branco - America/Rosario - America/Santa_Isabel - America/Santarem - America/Santiago - America/Santo_Domingo - America/Sao_Paulo - America/Scoresbysund - America/Shiprock - America/Sitka - America/St_Barthelemy - America/St_Johns - America/St_Kitts - America/St_Lucia - America/St_Thomas - America/St_Vincent - America/Swift_Current - America/Tegucigalpa - America/Thule - America/Thunder_Bay - America/Tijuana - America/Toronto - America/Tortola - America/Vancouver - America/Virgin - America/Whitehorse - America/Winnipeg - America/Yakutat - America/Yellowknife - Antarctica/Casey - Antarctica/Davis - Antarctica/DumontDUrville - Antarctica/Macquarie - Antarctica/Mawson - Antarctica/McMurdo - Antarctica/Palmer - Antarctica/Rothera - Antarctica/South_Pole - Antarctica/Syowa - Antarctica/Troll - Antarctica/Vostok - Arctic/Longyearbyen - Asia/Aden - Asia/Almaty - Asia/Amman - Asia/Anadyr - Asia/Aqtau - Asia/Aqtobe - Asia/Ashgabat - Asia/Ashkhabad - Asia/Atyrau - Asia/Baghdad - Asia/Bahrain - Asia/Baku - Asia/Bangkok - Asia/Barnaul - Asia/Beirut - Asia/Bishkek - Asia/Brunei - Asia/Calcutta - Asia/Chita - Asia/Choibalsan - Asia/Chongqing - Asia/Chungking - Asia/Colombo - Asia/Dacca - Asia/Damascus - Asia/Dhaka - Asia/Dili - Asia/Dubai - Asia/Dushanbe - Asia/Famagusta - Asia/Gaza - Asia/Harbin - Asia/Hebron - Asia/Ho_Chi_Minh - Asia/Hong_Kong - Asia/Hovd - Asia/Irkutsk - Asia/Istanbul - Asia/Jakarta - Asia/Jayapura - Asia/Jerusalem - Asia/Kabul - Asia/Kamchatka - Asia/Karachi - Asia/Kashgar - Asia/Kathmandu - Asia/Katmandu - Asia/Khandyga - Asia/Kolkata - Asia/Krasnoyarsk - Asia/Kuala_Lumpur - Asia/Kuching - Asia/Kuwait - Asia/Macao - Asia/Macau - Asia/Magadan - Asia/Makassar - Asia/Manila - Asia/Muscat - Asia/Nicosia - Asia/Novokuznetsk - Asia/Novosibirsk - Asia/Omsk - Asia/Oral - Asia/Phnom_Penh - Asia/Pontianak - Asia/Pyongyang - Asia/Qatar - Asia/Qostanay - Asia/Qyzylorda - Asia/Rangoon - Asia/Riyadh - Asia/Saigon - Asia/Sakhalin - Asia/Samarkand - Asia/Seoul - Asia/Shanghai - Asia/Singapore - Asia/Srednekolymsk - Asia/Taipei - Asia/Tashkent - Asia/Tbilisi - Asia/Tehran - Asia/Tel_Aviv - Asia/Thimbu - Asia/Thimphu - Asia/Tokyo - Asia/Tomsk - Asia/Ujung_Pandang - Asia/Ulaanbaatar - Asia/Ulan_Bator - Asia/Urumqi - Asia/Ust-Nera - Asia/Vientiane - Asia/Vladivostok - Asia/Yakutsk - Asia/Yangon - Asia/Yekaterinburg - Asia/Yerevan - Atlantic/Azores - Atlantic/Bermuda - Atlantic/Canary - Atlantic/Cape_Verde - Atlantic/Faeroe - Atlantic/Faroe - Atlantic/Jan_Mayen - Atlantic/Madeira - Atlantic/Reykjavik - Atlantic/South_Georgia - Atlantic/St_Helena - Atlantic/Stanley - Australia/ACT - Australia/Adelaide - Australia/Brisbane - Australia/Broken_Hill - Australia/Canberra - Australia/Currie - Australia/Darwin - Australia/Eucla - Australia/Hobart - Australia/LHI - Australia/Lindeman - Australia/Lord_Howe - Australia/Melbourne - Australia/NSW - Australia/North - Australia/Perth - Australia/Queensland - Australia/South - Australia/Sydney - Australia/Tasmania - Australia/Victoria - Australia/West - Australia/Yancowinna - Brazil/Acre - Brazil/DeNoronha - Brazil/East - Brazil/West - CET - CST6CDT - Canada/Atlantic - Canada/Central - Canada/Eastern - Canada/Mountain - Canada/Newfoundland - Canada/Pacific - Canada/Saskatchewan - Canada/Yukon - Chile/Continental - Chile/EasterIsland - Cuba - EET - EST - EST5EDT - Egypt - Eire - Etc/GMT - Etc/GMT+0 - Etc/GMT+1 - Etc/GMT+10 - Etc/GMT+11 - Etc/GMT+12 - Etc/GMT+2 - Etc/GMT+3 - Etc/GMT+4 - Etc/GMT+5 - Etc/GMT+6 - Etc/GMT+7 - Etc/GMT+8 - Etc/GMT+9 - Etc/GMT-0 - Etc/GMT-1 - Etc/GMT-10 - Etc/GMT-11 - Etc/GMT-12 - Etc/GMT-13 - Etc/GMT-14 - Etc/GMT-2 - Etc/GMT-3 - Etc/GMT-4 - Etc/GMT-5 - Etc/GMT-6 - Etc/GMT-7 - Etc/GMT-8 - Etc/GMT-9 - Etc/GMT0 - Etc/Greenwich - Etc/UCT - Etc/UTC - Etc/Universal - Etc/Zulu - Europe/Amsterdam - Europe/Andorra - Europe/Astrakhan - Europe/Athens - Europe/Belfast - Europe/Belgrade - Europe/Berlin - Europe/Bratislava - Europe/Brussels - Europe/Bucharest - Europe/Budapest - Europe/Busingen - Europe/Chisinau - Europe/Copenhagen - Europe/Dublin - Europe/Gibraltar - Europe/Guernsey - Europe/Helsinki - Europe/Isle_of_Man - Europe/Istanbul - Europe/Jersey - Europe/Kaliningrad - Europe/Kiev - Europe/Kirov - Europe/Kyiv - Europe/Lisbon - Europe/Ljubljana - Europe/London - Europe/Luxembourg - Europe/Madrid - Europe/Malta - Europe/Mariehamn - Europe/Minsk - Europe/Monaco - Europe/Moscow - Europe/Nicosia - Europe/Oslo - Europe/Paris - Europe/Podgorica - Europe/Prague - Europe/Riga - Europe/Rome - Europe/Samara - Europe/San_Marino - Europe/Sarajevo - Europe/Saratov - Europe/Simferopol - Europe/Skopje - Europe/Sofia - Europe/Stockholm - Europe/Tallinn - Europe/Tirane - Europe/Tiraspol - Europe/Ulyanovsk - Europe/Uzhgorod - Europe/Vaduz - Europe/Vatican - Europe/Vienna - Europe/Vilnius - Europe/Volgograd - Europe/Warsaw - Europe/Zagreb - Europe/Zaporozhye - Europe/Zurich - Factory - GB - GB-Eire - GMT - GMT+0 - GMT-0 - GMT0 - Greenwich - HST - Hongkong - Iceland - Indian/Antananarivo - Indian/Chagos - Indian/Christmas - Indian/Cocos - Indian/Comoro - Indian/Kerguelen - Indian/Mahe - Indian/Maldives - Indian/Mauritius - Indian/Mayotte - Indian/Reunion - Iran - Israel - Jamaica - Japan - Kwajalein - Libya - MET - MST - MST7MDT - Mexico/BajaNorte - Mexico/BajaSur - Mexico/General - NZ - NZ-CHAT - Navajo - PRC - PST8PDT - Pacific/Apia - Pacific/Auckland - Pacific/Bougainville - Pacific/Chatham - Pacific/Chuuk - Pacific/Easter - Pacific/Efate - Pacific/Enderbury - Pacific/Fakaofo - Pacific/Fiji - Pacific/Funafuti - Pacific/Galapagos - Pacific/Gambier - Pacific/Guadalcanal - Pacific/Guam - Pacific/Honolulu - Pacific/Johnston - Pacific/Kanton - Pacific/Kiritimati - Pacific/Kosrae - Pacific/Kwajalein - Pacific/Majuro - Pacific/Marquesas - Pacific/Midway - Pacific/Nauru - Pacific/Niue - Pacific/Norfolk - Pacific/Noumea - Pacific/Pago_Pago - Pacific/Palau - Pacific/Pitcairn - Pacific/Pohnpei - Pacific/Ponape - Pacific/Port_Moresby - Pacific/Rarotonga - Pacific/Saipan - Pacific/Samoa - Pacific/Tahiti - Pacific/Tarawa - Pacific/Tongatapu - Pacific/Truk - Pacific/Wake - Pacific/Wallis - Pacific/Yap - Poland - Portugal - ROC - ROK - Singapore - Turkey - UCT - US/Alaska - US/Aleutian - US/Arizona - US/Central - US/East-Indiana - US/Eastern - US/Hawaii - US/Indiana-Starke - US/Michigan - US/Mountain - US/Pacific - US/Pacific-New - US/Samoa - UTC - Universal - W-SU - WET - Zulu maxLength: 5000 type: string title: run_parameter_specs type: object report_type: description: >- The ID of the [report type](https://stripe.com/docs/reporting/statements/api#report-types) to run, such as `"balance.summary.1"`. type: string required: - report_type type: object required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/reporting.report_run' description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. '/v1/reporting/report_runs/{report_run}': get: description:

Retrieves the details of an existing Report Run.

operationId: GetReportingReportRunsReportRun parameters: - description: Specifies which fields in the response should be expanded. explode: true in: query name: expand required: false schema: items: maxLength: 5000 type: string type: array style: deepObject - in: path name: report_run required: true schema: maxLength: 5000 type: string style: simple requestBody: content: application/x-www-form-urlencoded: encoding: {} schema: additionalProperties: false properties: {} type: object required: false responses: '200': content: application/json: schema: $ref: '#/components/schemas/reporting.report_run' description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. /v1/reporting/report_types: get: description:

Returns a full list of Report Types.

operationId: GetReportingReportTypes parameters: - description: Specifies which fields in the response should be expanded. explode: true in: query name: expand required: false schema: items: maxLength: 5000 type: string type: array style: deepObject requestBody: content: application/x-www-form-urlencoded: encoding: {} schema: additionalProperties: false properties: {} type: object required: false responses: '200': content: application/json: schema: description: '' properties: data: items: $ref: '#/components/schemas/reporting.report_type' type: array has_more: description: >- True if this list has another page of items after this one that can be fetched. type: boolean object: description: >- String representing the object's type. Objects of the same type share the same value. Always has the value `list`. enum: - list type: string url: description: The URL where this list can be accessed. maxLength: 5000 type: string required: - data - has_more - object - url title: FinancialReportingFinanceReportTypeList type: object x-expandableFields: - data description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. '/v1/reporting/report_types/{report_type}': get: description: >-

Retrieves the details of a Report Type. (Certain report types require a live-mode API key.)

operationId: GetReportingReportTypesReportType parameters: - description: Specifies which fields in the response should be expanded. explode: true in: query name: expand required: false schema: items: maxLength: 5000 type: string type: array style: deepObject - in: path name: report_type required: true schema: type: string style: simple requestBody: content: application/x-www-form-urlencoded: encoding: {} schema: additionalProperties: false properties: {} type: object required: false responses: '200': content: application/json: schema: $ref: '#/components/schemas/reporting.report_type' description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. /v1/reviews: get: description: >-

Returns a list of Review objects that have open set to true. The objects are sorted in descending order by creation date, with the most recently created object appearing first.

operationId: GetReviews parameters: - description: >- Only return reviews that were created during the given date interval. explode: true in: query name: created required: false schema: anyOf: - properties: gt: type: integer gte: type: integer lt: type: integer lte: type: integer title: range_query_specs type: object - type: integer style: deepObject - description: >- A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. in: query name: ending_before required: false schema: maxLength: 5000 type: string style: form - description: Specifies which fields in the response should be expanded. explode: true in: query name: expand required: false schema: items: maxLength: 5000 type: string type: array style: deepObject - description: >- A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. in: query name: limit required: false schema: type: integer style: form - description: >- A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. in: query name: starting_after required: false schema: maxLength: 5000 type: string style: form requestBody: content: application/x-www-form-urlencoded: encoding: {} schema: additionalProperties: false properties: {} type: object required: false responses: '200': content: application/json: schema: description: '' properties: data: items: $ref: '#/components/schemas/review' type: array has_more: description: >- True if this list has another page of items after this one that can be fetched. type: boolean object: description: >- String representing the object's type. Objects of the same type share the same value. Always has the value `list`. enum: - list type: string url: description: The URL where this list can be accessed. maxLength: 5000 type: string required: - data - has_more - object - url title: RadarReviewList type: object x-expandableFields: - data description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. '/v1/reviews/{review}': get: description:

Retrieves a Review object.

operationId: GetReviewsReview parameters: - description: Specifies which fields in the response should be expanded. explode: true in: query name: expand required: false schema: items: maxLength: 5000 type: string type: array style: deepObject - in: path name: review required: true schema: maxLength: 5000 type: string style: simple requestBody: content: application/x-www-form-urlencoded: encoding: {} schema: additionalProperties: false properties: {} type: object required: false responses: '200': content: application/json: schema: $ref: '#/components/schemas/review' description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. '/v1/reviews/{review}/approve': post: description: >-

Approves a Review object, closing it and removing it from the list of reviews.

operationId: PostReviewsReviewApprove parameters: - in: path name: review required: true schema: maxLength: 5000 type: string style: simple requestBody: content: application/x-www-form-urlencoded: encoding: expand: explode: true style: deepObject schema: additionalProperties: false properties: expand: description: Specifies which fields in the response should be expanded. items: maxLength: 5000 type: string type: array type: object required: false responses: '200': content: application/json: schema: $ref: '#/components/schemas/review' description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. /v1/setup_attempts: get: description: >-

Returns a list of SetupAttempts that associate with a provided SetupIntent.

operationId: GetSetupAttempts parameters: - description: |- A filter on the list, based on the object `created` field. The value can be a string with an integer Unix timestamp or a dictionary with a number of different query options. explode: true in: query name: created required: false schema: anyOf: - properties: gt: type: integer gte: type: integer lt: type: integer lte: type: integer title: range_query_specs type: object - type: integer style: deepObject - description: >- A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. in: query name: ending_before required: false schema: maxLength: 5000 type: string style: form - description: Specifies which fields in the response should be expanded. explode: true in: query name: expand required: false schema: items: maxLength: 5000 type: string type: array style: deepObject - description: >- A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. in: query name: limit required: false schema: type: integer style: form - description: |- Only return SetupAttempts created by the SetupIntent specified by this ID. in: query name: setup_intent required: true schema: maxLength: 5000 type: string style: form - description: >- A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. in: query name: starting_after required: false schema: maxLength: 5000 type: string style: form requestBody: content: application/x-www-form-urlencoded: encoding: {} schema: additionalProperties: false properties: {} type: object required: false responses: '200': content: application/json: schema: description: '' properties: data: items: $ref: '#/components/schemas/setup_attempt' type: array has_more: description: >- True if this list has another page of items after this one that can be fetched. type: boolean object: description: >- String representing the object's type. Objects of the same type share the same value. Always has the value `list`. enum: - list type: string url: description: The URL where this list can be accessed. maxLength: 5000 pattern: ^/v1/setup_attempts type: string required: - data - has_more - object - url title: PaymentFlowsSetupIntentSetupAttemptList type: object x-expandableFields: - data description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. /v1/setup_intents: get: description:

Returns a list of SetupIntents.

operationId: GetSetupIntents parameters: - description: >- 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. in: query name: attach_to_self required: false schema: type: boolean style: form - description: >- A filter on the list, based on the object `created` field. The value can be a string with an integer Unix timestamp, or it can be a dictionary with a number of different query options. explode: true in: query name: created required: false schema: anyOf: - properties: gt: type: integer gte: type: integer lt: type: integer lte: type: integer title: range_query_specs type: object - type: integer style: deepObject - description: >- Only return SetupIntents for the customer specified by this customer ID. in: query name: customer required: false schema: maxLength: 5000 type: string style: form - description: >- A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. in: query name: ending_before required: false schema: maxLength: 5000 type: string style: form - description: Specifies which fields in the response should be expanded. explode: true in: query name: expand required: false schema: items: maxLength: 5000 type: string type: array style: deepObject - description: >- A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. in: query name: limit required: false schema: type: integer style: form - description: >- Only return SetupIntents that associate with the specified payment method. in: query name: payment_method required: false schema: maxLength: 5000 type: string style: form - description: >- A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. in: query name: starting_after required: false schema: maxLength: 5000 type: string style: form requestBody: content: application/x-www-form-urlencoded: encoding: {} schema: additionalProperties: false properties: {} type: object required: false responses: '200': content: application/json: schema: description: '' properties: data: items: $ref: '#/components/schemas/setup_intent' type: array has_more: description: >- True if this list has another page of items after this one that can be fetched. type: boolean object: description: >- String representing the object's type. Objects of the same type share the same value. Always has the value `list`. enum: - list type: string url: description: The URL where this list can be accessed. maxLength: 5000 pattern: ^/v1/setup_intents type: string required: - data - has_more - object - url title: PaymentFlowsSetupIntentList type: object x-expandableFields: - data description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. post: description: >-

Creates a SetupIntent object.

After you create the SetupIntent, attach a payment method and confirm it to collect any required permissions to charge the payment method later.

operationId: PostSetupIntents requestBody: content: application/x-www-form-urlencoded: encoding: automatic_payment_methods: explode: true style: deepObject expand: explode: true style: deepObject flow_directions: explode: true style: deepObject mandate_data: explode: true style: deepObject metadata: explode: true style: deepObject payment_method_data: explode: true style: deepObject payment_method_options: explode: true style: deepObject payment_method_types: explode: true style: deepObject single_use: explode: true style: deepObject schema: additionalProperties: false properties: attach_to_self: description: >- 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. type: boolean automatic_payment_methods: description: >- When you enable this parameter, this SetupIntent accepts payment methods that you enable in the Dashboard and that are compatible with its other parameters. properties: allow_redirects: enum: - always - never type: string enabled: type: boolean required: - enabled title: automatic_payment_methods_param type: object confirm: description: >- Set to `true` to attempt to confirm this SetupIntent immediately. This parameter defaults to `false`. If a card is the attached payment method, you can provide a `return_url` in case further authentication is necessary. type: boolean confirmation_token: description: >- ID of the ConfirmationToken used to confirm this SetupIntent. If the provided ConfirmationToken contains properties that are also being provided in this request, such as `payment_method`, then the values in this request will take precedence. maxLength: 5000 type: string customer: description: >- ID of the Customer this SetupIntent belongs to, if one exists. If present, the SetupIntent's payment method will be attached to the Customer on successful setup. Payment methods attached to other Customers cannot be used with this SetupIntent. maxLength: 5000 type: string description: description: >- An arbitrary string attached to the object. Often useful for displaying to users. maxLength: 1000 type: string expand: description: Specifies which fields in the response should be expanded. items: maxLength: 5000 type: string type: array flow_directions: description: >- 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. items: enum: - inbound - outbound type: string type: array mandate_data: anyOf: - properties: customer_acceptance: properties: accepted_at: format: unix-time type: integer offline: properties: {} title: offline_param type: object online: properties: ip_address: type: string user_agent: maxLength: 5000 type: string required: - ip_address - user_agent title: online_param type: object type: enum: - offline - online maxLength: 5000 type: string required: - type title: customer_acceptance_param type: object required: - customer_acceptance title: secret_key_param type: object - enum: - '' type: string description: >- This hash contains details about the mandate to create. This parameter can only be used with [`confirm=true`](https://stripe.com/docs/api/setup_intents/create#create_setup_intent-confirm). metadata: additionalProperties: type: string description: >- Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. type: object on_behalf_of: description: The Stripe account ID created for this SetupIntent. type: string payment_method: description: >- ID of the payment method (a PaymentMethod, Card, or saved Source object) to attach to this SetupIntent. maxLength: 5000 type: string payment_method_configuration: description: >- The ID of the payment method configuration to use with this SetupIntent. maxLength: 100 type: string payment_method_data: description: >- When included, this hash creates a PaymentMethod that is set as the [`payment_method`](https://stripe.com/docs/api/setup_intents/object#setup_intent_object-payment_method) value in the SetupIntent. properties: acss_debit: properties: account_number: maxLength: 5000 type: string institution_number: maxLength: 5000 type: string transit_number: maxLength: 5000 type: string required: - account_number - institution_number - transit_number title: payment_method_param type: object affirm: properties: {} title: param type: object afterpay_clearpay: properties: {} title: param type: object alipay: properties: {} title: param type: object allow_redisplay: enum: - always - limited - unspecified type: string amazon_pay: properties: {} title: param type: object au_becs_debit: properties: account_number: maxLength: 5000 type: string bsb_number: maxLength: 5000 type: string required: - account_number - bsb_number title: param type: object bacs_debit: properties: account_number: maxLength: 5000 type: string sort_code: maxLength: 5000 type: string title: param type: object bancontact: properties: {} title: param type: object billing_details: properties: address: anyOf: - properties: city: maxLength: 5000 type: string country: maxLength: 5000 type: string line1: maxLength: 5000 type: string line2: maxLength: 5000 type: string postal_code: maxLength: 5000 type: string state: maxLength: 5000 type: string title: billing_details_address type: object - enum: - '' type: string email: anyOf: - type: string - enum: - '' type: string name: anyOf: - maxLength: 5000 type: string - enum: - '' type: string phone: anyOf: - maxLength: 5000 type: string - enum: - '' type: string title: billing_details_inner_params type: object blik: properties: {} title: param type: object boleto: properties: tax_id: maxLength: 5000 type: string required: - tax_id title: param type: object cashapp: properties: {} title: param type: object customer_balance: properties: {} title: param type: object eps: properties: bank: enum: - 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 maxLength: 5000 type: string title: param type: object fpx: properties: bank: enum: - 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 maxLength: 5000 type: string x-stripeBypassValidation: true required: - bank title: param type: object giropay: properties: {} title: param type: object grabpay: properties: {} title: param type: object ideal: properties: bank: enum: - abn_amro - asn_bank - bunq - handelsbanken - ing - knab - moneyou - n26 - nn - rabobank - regiobank - revolut - sns_bank - triodos_bank - van_lanschot - yoursafe maxLength: 5000 type: string title: param type: object interac_present: properties: {} title: param type: object klarna: properties: dob: properties: day: type: integer month: type: integer year: type: integer required: - day - month - year title: date_of_birth type: object title: param type: object konbini: properties: {} title: param type: object link: properties: {} title: param type: object metadata: additionalProperties: type: string type: object mobilepay: properties: {} title: param type: object oxxo: properties: {} title: param type: object p24: properties: bank: enum: - 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 type: string x-stripeBypassValidation: true title: param type: object paynow: properties: {} title: param type: object paypal: properties: {} title: param type: object pix: properties: {} title: param type: object promptpay: properties: {} title: param type: object radar_options: properties: session: maxLength: 5000 type: string title: radar_options_with_hidden_options type: object revolut_pay: properties: {} title: param type: object sepa_debit: properties: iban: maxLength: 5000 type: string required: - iban title: param type: object sofort: properties: country: enum: - AT - BE - DE - ES - IT - NL type: string required: - country title: param type: object swish: properties: {} title: param type: object type: enum: - acss_debit - affirm - afterpay_clearpay - alipay - amazon_pay - au_becs_debit - bacs_debit - bancontact - blik - boleto - cashapp - customer_balance - eps - fpx - giropay - grabpay - ideal - klarna - konbini - link - mobilepay - oxxo - p24 - paynow - paypal - pix - promptpay - revolut_pay - sepa_debit - sofort - swish - us_bank_account - wechat_pay - zip type: string x-stripeBypassValidation: true us_bank_account: properties: account_holder_type: enum: - company - individual type: string account_number: maxLength: 5000 type: string account_type: enum: - checking - savings type: string financial_connections_account: maxLength: 5000 type: string routing_number: maxLength: 5000 type: string title: payment_method_param type: object wechat_pay: properties: {} title: param type: object zip: properties: {} title: param type: object required: - type title: payment_method_data_params type: object payment_method_options: description: Payment method-specific configuration for this SetupIntent. properties: acss_debit: properties: currency: enum: - cad - usd type: string mandate_options: properties: custom_mandate_url: anyOf: - type: string - enum: - '' type: string default_for: items: enum: - invoice - subscription type: string type: array interval_description: maxLength: 500 type: string payment_schedule: enum: - combined - interval - sporadic type: string transaction_type: enum: - business - personal type: string title: >- setup_intent_payment_method_options_mandate_options_param type: object verification_method: enum: - automatic - instant - microdeposits type: string x-stripeBypassValidation: true title: setup_intent_payment_method_options_param type: object amazon_pay: properties: {} title: setup_intent_payment_method_options_param type: object card: properties: mandate_options: properties: amount: type: integer amount_type: enum: - fixed - maximum type: string currency: type: string description: maxLength: 200 type: string end_date: format: unix-time type: integer interval: enum: - day - month - sporadic - week - year type: string interval_count: type: integer reference: maxLength: 80 type: string start_date: format: unix-time type: integer supported_types: items: enum: - india type: string type: array required: - amount - amount_type - currency - interval - reference - start_date title: setup_intent_mandate_options_param type: object network: enum: - amex - cartes_bancaires - diners - discover - eftpos_au - interac - jcb - mastercard - unionpay - unknown - visa maxLength: 5000 type: string x-stripeBypassValidation: true request_three_d_secure: enum: - any - automatic - challenge type: string x-stripeBypassValidation: true three_d_secure: properties: ares_trans_status: enum: - A - C - I - 'N' - R - U - 'Y' type: string cryptogram: maxLength: 5000 type: string electronic_commerce_indicator: enum: - '01' - '02' - '05' - '06' - '07' type: string x-stripeBypassValidation: true network_options: properties: cartes_bancaires: properties: cb_avalgo: enum: - '0' - '1' - '2' - '3' - '4' - A type: string cb_exemption: maxLength: 4 type: string cb_score: type: integer required: - cb_avalgo title: cartes_bancaires_network_options_param type: object title: network_options_param type: object requestor_challenge_indicator: maxLength: 2 type: string transaction_id: maxLength: 5000 type: string version: enum: - 1.0.2 - 2.1.0 - 2.2.0 type: string x-stripeBypassValidation: true title: setup_intent_payment_method_options_param type: object title: setup_intent_param type: object card_present: properties: {} title: setup_intent_payment_method_options_param type: object link: properties: {} title: setup_intent_payment_method_options_param type: object paypal: properties: billing_agreement_id: maxLength: 5000 type: string title: payment_method_options_param type: object sepa_debit: properties: mandate_options: properties: {} title: payment_method_options_mandate_options_param type: object title: setup_intent_payment_method_options_param type: object us_bank_account: properties: financial_connections: properties: permissions: items: enum: - balances - ownership - payment_method - transactions maxLength: 5000 type: string x-stripeBypassValidation: true type: array prefetch: items: enum: - balances - ownership - transactions type: string x-stripeBypassValidation: true type: array return_url: maxLength: 5000 type: string title: linked_account_options_param type: object mandate_options: properties: collection_method: enum: - '' - paper type: string x-stripeBypassValidation: true title: mandate_options_param type: object networks: properties: requested: items: enum: - ach - us_domestic_wire type: string type: array title: networks_options_param type: object verification_method: enum: - automatic - instant - microdeposits type: string x-stripeBypassValidation: true title: setup_intent_payment_method_options_param type: object title: payment_method_options_param type: object payment_method_types: description: >- The list of payment method types (for example, card) that this SetupIntent can use. If you don't provide this, it defaults to ["card"]. items: maxLength: 5000 type: string type: array return_url: description: >- The URL to redirect your customer back to after they authenticate or cancel their payment on the payment method's app or site. To redirect to a mobile application, you can alternatively supply an application URI scheme. This parameter can only be used with [`confirm=true`](https://stripe.com/docs/api/setup_intents/create#create_setup_intent-confirm). type: string single_use: description: >- If you populate this hash, this SetupIntent generates a `single_use` mandate after successful completion. properties: amount: type: integer currency: type: string required: - amount - currency title: setup_intent_single_use_params type: object usage: description: >- Indicates how the payment method is intended to be used in the future. If not provided, this value defaults to `off_session`. enum: - off_session - on_session type: string use_stripe_sdk: description: >- Set to `true` when confirming server-side and using Stripe.js, iOS, or Android client-side SDKs to handle the next actions. type: boolean type: object required: false responses: '200': content: application/json: schema: $ref: '#/components/schemas/setup_intent' description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. '/v1/setup_intents/{intent}': get: description: >-

Retrieves the details of a SetupIntent that has previously been created.

Client-side retrieval using a publishable key is allowed when the client_secret is provided in the query string.

When retrieved with a publishable key, only a subset of properties will be returned. Please refer to the SetupIntent object reference for more details.

operationId: GetSetupIntentsIntent parameters: - description: >- The client secret of the SetupIntent. We require this string if you use a publishable key to retrieve the SetupIntent. in: query name: client_secret required: false schema: maxLength: 5000 type: string style: form - description: Specifies which fields in the response should be expanded. explode: true in: query name: expand required: false schema: items: maxLength: 5000 type: string type: array style: deepObject - in: path name: intent required: true schema: maxLength: 5000 type: string style: simple requestBody: content: application/x-www-form-urlencoded: encoding: {} schema: additionalProperties: false properties: {} type: object required: false responses: '200': content: application/json: schema: $ref: '#/components/schemas/setup_intent' description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. post: description:

Updates a SetupIntent object.

operationId: PostSetupIntentsIntent parameters: - in: path name: intent required: true schema: maxLength: 5000 type: string style: simple requestBody: content: application/x-www-form-urlencoded: encoding: expand: explode: true style: deepObject flow_directions: explode: true style: deepObject metadata: explode: true style: deepObject payment_method_data: explode: true style: deepObject payment_method_options: explode: true style: deepObject payment_method_types: explode: true style: deepObject schema: additionalProperties: false properties: attach_to_self: description: >- 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. type: boolean customer: description: >- ID of the Customer this SetupIntent belongs to, if one exists. If present, the SetupIntent's payment method will be attached to the Customer on successful setup. Payment methods attached to other Customers cannot be used with this SetupIntent. maxLength: 5000 type: string description: description: >- An arbitrary string attached to the object. Often useful for displaying to users. maxLength: 1000 type: string expand: description: Specifies which fields in the response should be expanded. items: maxLength: 5000 type: string type: array flow_directions: description: >- 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. items: enum: - inbound - outbound type: string type: array metadata: anyOf: - additionalProperties: type: string type: object - enum: - '' type: string description: >- Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. payment_method: description: >- ID of the payment method (a PaymentMethod, Card, or saved Source object) to attach to this SetupIntent. maxLength: 5000 type: string payment_method_configuration: description: >- The ID of the payment method configuration to use with this SetupIntent. maxLength: 100 type: string payment_method_data: description: >- When included, this hash creates a PaymentMethod that is set as the [`payment_method`](https://stripe.com/docs/api/setup_intents/object#setup_intent_object-payment_method) value in the SetupIntent. properties: acss_debit: properties: account_number: maxLength: 5000 type: string institution_number: maxLength: 5000 type: string transit_number: maxLength: 5000 type: string required: - account_number - institution_number - transit_number title: payment_method_param type: object affirm: properties: {} title: param type: object afterpay_clearpay: properties: {} title: param type: object alipay: properties: {} title: param type: object allow_redisplay: enum: - always - limited - unspecified type: string amazon_pay: properties: {} title: param type: object au_becs_debit: properties: account_number: maxLength: 5000 type: string bsb_number: maxLength: 5000 type: string required: - account_number - bsb_number title: param type: object bacs_debit: properties: account_number: maxLength: 5000 type: string sort_code: maxLength: 5000 type: string title: param type: object bancontact: properties: {} title: param type: object billing_details: properties: address: anyOf: - properties: city: maxLength: 5000 type: string country: maxLength: 5000 type: string line1: maxLength: 5000 type: string line2: maxLength: 5000 type: string postal_code: maxLength: 5000 type: string state: maxLength: 5000 type: string title: billing_details_address type: object - enum: - '' type: string email: anyOf: - type: string - enum: - '' type: string name: anyOf: - maxLength: 5000 type: string - enum: - '' type: string phone: anyOf: - maxLength: 5000 type: string - enum: - '' type: string title: billing_details_inner_params type: object blik: properties: {} title: param type: object boleto: properties: tax_id: maxLength: 5000 type: string required: - tax_id title: param type: object cashapp: properties: {} title: param type: object customer_balance: properties: {} title: param type: object eps: properties: bank: enum: - 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 maxLength: 5000 type: string title: param type: object fpx: properties: bank: enum: - 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 maxLength: 5000 type: string x-stripeBypassValidation: true required: - bank title: param type: object giropay: properties: {} title: param type: object grabpay: properties: {} title: param type: object ideal: properties: bank: enum: - abn_amro - asn_bank - bunq - handelsbanken - ing - knab - moneyou - n26 - nn - rabobank - regiobank - revolut - sns_bank - triodos_bank - van_lanschot - yoursafe maxLength: 5000 type: string title: param type: object interac_present: properties: {} title: param type: object klarna: properties: dob: properties: day: type: integer month: type: integer year: type: integer required: - day - month - year title: date_of_birth type: object title: param type: object konbini: properties: {} title: param type: object link: properties: {} title: param type: object metadata: additionalProperties: type: string type: object mobilepay: properties: {} title: param type: object oxxo: properties: {} title: param type: object p24: properties: bank: enum: - 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 type: string x-stripeBypassValidation: true title: param type: object paynow: properties: {} title: param type: object paypal: properties: {} title: param type: object pix: properties: {} title: param type: object promptpay: properties: {} title: param type: object radar_options: properties: session: maxLength: 5000 type: string title: radar_options_with_hidden_options type: object revolut_pay: properties: {} title: param type: object sepa_debit: properties: iban: maxLength: 5000 type: string required: - iban title: param type: object sofort: properties: country: enum: - AT - BE - DE - ES - IT - NL type: string required: - country title: param type: object swish: properties: {} title: param type: object type: enum: - acss_debit - affirm - afterpay_clearpay - alipay - amazon_pay - au_becs_debit - bacs_debit - bancontact - blik - boleto - cashapp - customer_balance - eps - fpx - giropay - grabpay - ideal - klarna - konbini - link - mobilepay - oxxo - p24 - paynow - paypal - pix - promptpay - revolut_pay - sepa_debit - sofort - swish - us_bank_account - wechat_pay - zip type: string x-stripeBypassValidation: true us_bank_account: properties: account_holder_type: enum: - company - individual type: string account_number: maxLength: 5000 type: string account_type: enum: - checking - savings type: string financial_connections_account: maxLength: 5000 type: string routing_number: maxLength: 5000 type: string title: payment_method_param type: object wechat_pay: properties: {} title: param type: object zip: properties: {} title: param type: object required: - type title: payment_method_data_params type: object payment_method_options: description: Payment method-specific configuration for this SetupIntent. properties: acss_debit: properties: currency: enum: - cad - usd type: string mandate_options: properties: custom_mandate_url: anyOf: - type: string - enum: - '' type: string default_for: items: enum: - invoice - subscription type: string type: array interval_description: maxLength: 500 type: string payment_schedule: enum: - combined - interval - sporadic type: string transaction_type: enum: - business - personal type: string title: >- setup_intent_payment_method_options_mandate_options_param type: object verification_method: enum: - automatic - instant - microdeposits type: string x-stripeBypassValidation: true title: setup_intent_payment_method_options_param type: object amazon_pay: properties: {} title: setup_intent_payment_method_options_param type: object card: properties: mandate_options: properties: amount: type: integer amount_type: enum: - fixed - maximum type: string currency: type: string description: maxLength: 200 type: string end_date: format: unix-time type: integer interval: enum: - day - month - sporadic - week - year type: string interval_count: type: integer reference: maxLength: 80 type: string start_date: format: unix-time type: integer supported_types: items: enum: - india type: string type: array required: - amount - amount_type - currency - interval - reference - start_date title: setup_intent_mandate_options_param type: object network: enum: - amex - cartes_bancaires - diners - discover - eftpos_au - interac - jcb - mastercard - unionpay - unknown - visa maxLength: 5000 type: string x-stripeBypassValidation: true request_three_d_secure: enum: - any - automatic - challenge type: string x-stripeBypassValidation: true three_d_secure: properties: ares_trans_status: enum: - A - C - I - 'N' - R - U - 'Y' type: string cryptogram: maxLength: 5000 type: string electronic_commerce_indicator: enum: - '01' - '02' - '05' - '06' - '07' type: string x-stripeBypassValidation: true network_options: properties: cartes_bancaires: properties: cb_avalgo: enum: - '0' - '1' - '2' - '3' - '4' - A type: string cb_exemption: maxLength: 4 type: string cb_score: type: integer required: - cb_avalgo title: cartes_bancaires_network_options_param type: object title: network_options_param type: object requestor_challenge_indicator: maxLength: 2 type: string transaction_id: maxLength: 5000 type: string version: enum: - 1.0.2 - 2.1.0 - 2.2.0 type: string x-stripeBypassValidation: true title: setup_intent_payment_method_options_param type: object title: setup_intent_param type: object card_present: properties: {} title: setup_intent_payment_method_options_param type: object link: properties: {} title: setup_intent_payment_method_options_param type: object paypal: properties: billing_agreement_id: maxLength: 5000 type: string title: payment_method_options_param type: object sepa_debit: properties: mandate_options: properties: {} title: payment_method_options_mandate_options_param type: object title: setup_intent_payment_method_options_param type: object us_bank_account: properties: financial_connections: properties: permissions: items: enum: - balances - ownership - payment_method - transactions maxLength: 5000 type: string x-stripeBypassValidation: true type: array prefetch: items: enum: - balances - ownership - transactions type: string x-stripeBypassValidation: true type: array return_url: maxLength: 5000 type: string title: linked_account_options_param type: object mandate_options: properties: collection_method: enum: - '' - paper type: string x-stripeBypassValidation: true title: mandate_options_param type: object networks: properties: requested: items: enum: - ach - us_domestic_wire type: string type: array title: networks_options_param type: object verification_method: enum: - automatic - instant - microdeposits type: string x-stripeBypassValidation: true title: setup_intent_payment_method_options_param type: object title: payment_method_options_param type: object payment_method_types: description: >- The list of payment method types (for example, card) that this SetupIntent can set up. If you don't provide this array, it defaults to ["card"]. items: maxLength: 5000 type: string type: array type: object required: false responses: '200': content: application/json: schema: $ref: '#/components/schemas/setup_intent' description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. '/v1/setup_intents/{intent}/cancel': post: description: >-

You can cancel a SetupIntent object when it’s in one of these statuses: requires_payment_method, requires_confirmation, or requires_action.

After you cancel it, setup is abandoned and any operations on the SetupIntent fail with an error.

operationId: PostSetupIntentsIntentCancel parameters: - in: path name: intent required: true schema: maxLength: 5000 type: string style: simple requestBody: content: application/x-www-form-urlencoded: encoding: expand: explode: true style: deepObject schema: additionalProperties: false properties: cancellation_reason: description: >- Reason for canceling this SetupIntent. Possible values are: `abandoned`, `requested_by_customer`, or `duplicate` enum: - abandoned - duplicate - requested_by_customer maxLength: 5000 type: string expand: description: Specifies which fields in the response should be expanded. items: maxLength: 5000 type: string type: array type: object required: false responses: '200': content: application/json: schema: $ref: '#/components/schemas/setup_intent' description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. '/v1/setup_intents/{intent}/confirm': post: description: >-

Confirm that your customer intends to set up the current or provided payment method. For example, you would confirm a SetupIntent when a customer hits the “Save” button on a payment method management page on your website.

If the selected payment method does not require any additional steps from the customer, the SetupIntent will transition to the succeeded status.

Otherwise, it will transition to the requires_action status and suggest additional actions via next_action. If setup fails, the SetupIntent will transition to the requires_payment_method status or the canceled status if the confirmation limit is reached.

operationId: PostSetupIntentsIntentConfirm parameters: - in: path name: intent required: true schema: maxLength: 5000 type: string style: simple requestBody: content: application/x-www-form-urlencoded: encoding: expand: explode: true style: deepObject mandate_data: explode: true style: deepObject payment_method_data: explode: true style: deepObject payment_method_options: explode: true style: deepObject schema: additionalProperties: false properties: client_secret: description: The client secret of the SetupIntent. maxLength: 5000 type: string confirmation_token: description: >- ID of the ConfirmationToken used to confirm this SetupIntent. If the provided ConfirmationToken contains properties that are also being provided in this request, such as `payment_method`, then the values in this request will take precedence. maxLength: 5000 type: string expand: description: Specifies which fields in the response should be expanded. items: maxLength: 5000 type: string type: array mandate_data: anyOf: - properties: customer_acceptance: properties: accepted_at: format: unix-time type: integer offline: properties: {} title: offline_param type: object online: properties: ip_address: type: string user_agent: maxLength: 5000 type: string required: - ip_address - user_agent title: online_param type: object type: enum: - offline - online maxLength: 5000 type: string required: - type title: customer_acceptance_param type: object required: - customer_acceptance title: secret_key_param type: object - enum: - '' type: string - description: This hash contains details about the Mandate to create properties: customer_acceptance: properties: online: properties: ip_address: type: string user_agent: maxLength: 5000 type: string title: online_param type: object type: enum: - online maxLength: 5000 type: string required: - online - type title: customer_acceptance_param type: object required: - customer_acceptance title: client_key_param type: object payment_method: description: >- ID of the payment method (a PaymentMethod, Card, or saved Source object) to attach to this SetupIntent. maxLength: 5000 type: string payment_method_data: description: >- When included, this hash creates a PaymentMethod that is set as the [`payment_method`](https://stripe.com/docs/api/setup_intents/object#setup_intent_object-payment_method) value in the SetupIntent. properties: acss_debit: properties: account_number: maxLength: 5000 type: string institution_number: maxLength: 5000 type: string transit_number: maxLength: 5000 type: string required: - account_number - institution_number - transit_number title: payment_method_param type: object affirm: properties: {} title: param type: object afterpay_clearpay: properties: {} title: param type: object alipay: properties: {} title: param type: object allow_redisplay: enum: - always - limited - unspecified type: string amazon_pay: properties: {} title: param type: object au_becs_debit: properties: account_number: maxLength: 5000 type: string bsb_number: maxLength: 5000 type: string required: - account_number - bsb_number title: param type: object bacs_debit: properties: account_number: maxLength: 5000 type: string sort_code: maxLength: 5000 type: string title: param type: object bancontact: properties: {} title: param type: object billing_details: properties: address: anyOf: - properties: city: maxLength: 5000 type: string country: maxLength: 5000 type: string line1: maxLength: 5000 type: string line2: maxLength: 5000 type: string postal_code: maxLength: 5000 type: string state: maxLength: 5000 type: string title: billing_details_address type: object - enum: - '' type: string email: anyOf: - type: string - enum: - '' type: string name: anyOf: - maxLength: 5000 type: string - enum: - '' type: string phone: anyOf: - maxLength: 5000 type: string - enum: - '' type: string title: billing_details_inner_params type: object blik: properties: {} title: param type: object boleto: properties: tax_id: maxLength: 5000 type: string required: - tax_id title: param type: object cashapp: properties: {} title: param type: object customer_balance: properties: {} title: param type: object eps: properties: bank: enum: - 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 maxLength: 5000 type: string title: param type: object fpx: properties: bank: enum: - 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 maxLength: 5000 type: string x-stripeBypassValidation: true required: - bank title: param type: object giropay: properties: {} title: param type: object grabpay: properties: {} title: param type: object ideal: properties: bank: enum: - abn_amro - asn_bank - bunq - handelsbanken - ing - knab - moneyou - n26 - nn - rabobank - regiobank - revolut - sns_bank - triodos_bank - van_lanschot - yoursafe maxLength: 5000 type: string title: param type: object interac_present: properties: {} title: param type: object klarna: properties: dob: properties: day: type: integer month: type: integer year: type: integer required: - day - month - year title: date_of_birth type: object title: param type: object konbini: properties: {} title: param type: object link: properties: {} title: param type: object metadata: additionalProperties: type: string type: object mobilepay: properties: {} title: param type: object oxxo: properties: {} title: param type: object p24: properties: bank: enum: - 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 type: string x-stripeBypassValidation: true title: param type: object paynow: properties: {} title: param type: object paypal: properties: {} title: param type: object pix: properties: {} title: param type: object promptpay: properties: {} title: param type: object radar_options: properties: session: maxLength: 5000 type: string title: radar_options_with_hidden_options type: object revolut_pay: properties: {} title: param type: object sepa_debit: properties: iban: maxLength: 5000 type: string required: - iban title: param type: object sofort: properties: country: enum: - AT - BE - DE - ES - IT - NL type: string required: - country title: param type: object swish: properties: {} title: param type: object type: enum: - acss_debit - affirm - afterpay_clearpay - alipay - amazon_pay - au_becs_debit - bacs_debit - bancontact - blik - boleto - cashapp - customer_balance - eps - fpx - giropay - grabpay - ideal - klarna - konbini - link - mobilepay - oxxo - p24 - paynow - paypal - pix - promptpay - revolut_pay - sepa_debit - sofort - swish - us_bank_account - wechat_pay - zip type: string x-stripeBypassValidation: true us_bank_account: properties: account_holder_type: enum: - company - individual type: string account_number: maxLength: 5000 type: string account_type: enum: - checking - savings type: string financial_connections_account: maxLength: 5000 type: string routing_number: maxLength: 5000 type: string title: payment_method_param type: object wechat_pay: properties: {} title: param type: object zip: properties: {} title: param type: object required: - type title: payment_method_data_params type: object payment_method_options: description: Payment method-specific configuration for this SetupIntent. properties: acss_debit: properties: currency: enum: - cad - usd type: string mandate_options: properties: custom_mandate_url: anyOf: - type: string - enum: - '' type: string default_for: items: enum: - invoice - subscription type: string type: array interval_description: maxLength: 500 type: string payment_schedule: enum: - combined - interval - sporadic type: string transaction_type: enum: - business - personal type: string title: >- setup_intent_payment_method_options_mandate_options_param type: object verification_method: enum: - automatic - instant - microdeposits type: string x-stripeBypassValidation: true title: setup_intent_payment_method_options_param type: object amazon_pay: properties: {} title: setup_intent_payment_method_options_param type: object card: properties: mandate_options: properties: amount: type: integer amount_type: enum: - fixed - maximum type: string currency: type: string description: maxLength: 200 type: string end_date: format: unix-time type: integer interval: enum: - day - month - sporadic - week - year type: string interval_count: type: integer reference: maxLength: 80 type: string start_date: format: unix-time type: integer supported_types: items: enum: - india type: string type: array required: - amount - amount_type - currency - interval - reference - start_date title: setup_intent_mandate_options_param type: object network: enum: - amex - cartes_bancaires - diners - discover - eftpos_au - interac - jcb - mastercard - unionpay - unknown - visa maxLength: 5000 type: string x-stripeBypassValidation: true request_three_d_secure: enum: - any - automatic - challenge type: string x-stripeBypassValidation: true three_d_secure: properties: ares_trans_status: enum: - A - C - I - 'N' - R - U - 'Y' type: string cryptogram: maxLength: 5000 type: string electronic_commerce_indicator: enum: - '01' - '02' - '05' - '06' - '07' type: string x-stripeBypassValidation: true network_options: properties: cartes_bancaires: properties: cb_avalgo: enum: - '0' - '1' - '2' - '3' - '4' - A type: string cb_exemption: maxLength: 4 type: string cb_score: type: integer required: - cb_avalgo title: cartes_bancaires_network_options_param type: object title: network_options_param type: object requestor_challenge_indicator: maxLength: 2 type: string transaction_id: maxLength: 5000 type: string version: enum: - 1.0.2 - 2.1.0 - 2.2.0 type: string x-stripeBypassValidation: true title: setup_intent_payment_method_options_param type: object title: setup_intent_param type: object card_present: properties: {} title: setup_intent_payment_method_options_param type: object link: properties: {} title: setup_intent_payment_method_options_param type: object paypal: properties: billing_agreement_id: maxLength: 5000 type: string title: payment_method_options_param type: object sepa_debit: properties: mandate_options: properties: {} title: payment_method_options_mandate_options_param type: object title: setup_intent_payment_method_options_param type: object us_bank_account: properties: financial_connections: properties: permissions: items: enum: - balances - ownership - payment_method - transactions maxLength: 5000 type: string x-stripeBypassValidation: true type: array prefetch: items: enum: - balances - ownership - transactions type: string x-stripeBypassValidation: true type: array return_url: maxLength: 5000 type: string title: linked_account_options_param type: object mandate_options: properties: collection_method: enum: - '' - paper type: string x-stripeBypassValidation: true title: mandate_options_param type: object networks: properties: requested: items: enum: - ach - us_domestic_wire type: string type: array title: networks_options_param type: object verification_method: enum: - automatic - instant - microdeposits type: string x-stripeBypassValidation: true title: setup_intent_payment_method_options_param type: object title: payment_method_options_param type: object return_url: description: >- The URL to redirect your customer back to after they authenticate on the payment method's app or site. If you'd prefer to redirect to a mobile application, you can alternatively supply an application URI scheme. This parameter is only used for cards and other redirect-based payment methods. type: string use_stripe_sdk: description: >- Set to `true` when confirming server-side and using Stripe.js, iOS, or Android client-side SDKs to handle the next actions. type: boolean type: object required: false responses: '200': content: application/json: schema: $ref: '#/components/schemas/setup_intent' description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. '/v1/setup_intents/{intent}/verify_microdeposits': post: description:

Verifies microdeposits on a SetupIntent object.

operationId: PostSetupIntentsIntentVerifyMicrodeposits parameters: - in: path name: intent required: true schema: maxLength: 5000 type: string style: simple requestBody: content: application/x-www-form-urlencoded: encoding: amounts: explode: true style: deepObject expand: explode: true style: deepObject schema: additionalProperties: false properties: amounts: description: >- Two positive integers, in *cents*, equal to the values of the microdeposits sent to the bank account. items: type: integer type: array client_secret: description: The client secret of the SetupIntent. maxLength: 5000 type: string descriptor_code: description: >- A six-character code starting with SM present in the microdeposit sent to the bank account. maxLength: 5000 type: string expand: description: Specifies which fields in the response should be expanded. items: maxLength: 5000 type: string type: array type: object required: false responses: '200': content: application/json: schema: $ref: '#/components/schemas/setup_intent' description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. /v1/shipping_rates: get: description:

Returns a list of your shipping rates.

operationId: GetShippingRates parameters: - description: Only return shipping rates that are active or inactive. in: query name: active required: false schema: type: boolean style: form - description: >- A filter on the list, based on the object `created` field. The value can be a string with an integer Unix timestamp, or it can be a dictionary with a number of different query options. explode: true in: query name: created required: false schema: anyOf: - properties: gt: type: integer gte: type: integer lt: type: integer lte: type: integer title: range_query_specs type: object - type: integer style: deepObject - description: Only return shipping rates for the given currency. in: query name: currency required: false schema: type: string style: form - description: >- A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. in: query name: ending_before required: false schema: maxLength: 5000 type: string style: form - description: Specifies which fields in the response should be expanded. explode: true in: query name: expand required: false schema: items: maxLength: 5000 type: string type: array style: deepObject - description: >- A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. in: query name: limit required: false schema: type: integer style: form - description: >- A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. in: query name: starting_after required: false schema: maxLength: 5000 type: string style: form requestBody: content: application/x-www-form-urlencoded: encoding: {} schema: additionalProperties: false properties: {} type: object required: false responses: '200': content: application/json: schema: description: '' properties: data: items: $ref: '#/components/schemas/shipping_rate' type: array has_more: description: >- True if this list has another page of items after this one that can be fetched. type: boolean object: description: >- String representing the object's type. Objects of the same type share the same value. Always has the value `list`. enum: - list type: string url: description: The URL where this list can be accessed. maxLength: 5000 pattern: ^/v1/shipping_rates type: string required: - data - has_more - object - url title: ShippingResourcesShippingRateList type: object x-expandableFields: - data description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. post: description:

Creates a new shipping rate object.

operationId: PostShippingRates requestBody: content: application/x-www-form-urlencoded: encoding: delivery_estimate: explode: true style: deepObject expand: explode: true style: deepObject fixed_amount: explode: true style: deepObject metadata: explode: true style: deepObject schema: additionalProperties: false properties: delivery_estimate: description: >- The estimated range for how long shipping will take, meant to be displayable to the customer. This will appear on CheckoutSessions. properties: maximum: properties: unit: enum: - business_day - day - hour - month - week type: string value: type: integer required: - unit - value title: delivery_estimate_bound type: object minimum: properties: unit: enum: - business_day - day - hour - month - week type: string value: type: integer required: - unit - value title: delivery_estimate_bound type: object title: delivery_estimate type: object display_name: description: >- The name of the shipping rate, meant to be displayable to the customer. This will appear on CheckoutSessions. maxLength: 100 type: string expand: description: Specifies which fields in the response should be expanded. items: maxLength: 5000 type: string type: array fixed_amount: description: >- Describes a fixed amount to charge for shipping. Must be present if type is `fixed_amount`. properties: amount: type: integer currency: type: string currency_options: additionalProperties: properties: amount: type: integer tax_behavior: enum: - exclusive - inclusive - unspecified type: string required: - amount title: currency_option type: object type: object required: - amount - currency title: fixed_amount type: object metadata: additionalProperties: type: string description: >- Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. type: object tax_behavior: description: >- Specifies whether the rate is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. enum: - exclusive - inclusive - unspecified type: string tax_code: description: >- A [tax code](https://stripe.com/docs/tax/tax-categories) ID. The Shipping tax code is `txcd_92010001`. type: string type: description: >- The type of calculation to use on the shipping rate. Can only be `fixed_amount` for now. enum: - fixed_amount type: string required: - display_name type: object required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/shipping_rate' description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. '/v1/shipping_rates/{shipping_rate_token}': get: description:

Returns the shipping rate object with the given ID.

operationId: GetShippingRatesShippingRateToken parameters: - description: Specifies which fields in the response should be expanded. explode: true in: query name: expand required: false schema: items: maxLength: 5000 type: string type: array style: deepObject - in: path name: shipping_rate_token required: true schema: maxLength: 5000 type: string style: simple requestBody: content: application/x-www-form-urlencoded: encoding: {} schema: additionalProperties: false properties: {} type: object required: false responses: '200': content: application/json: schema: $ref: '#/components/schemas/shipping_rate' description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. post: description:

Updates an existing shipping rate object.

operationId: PostShippingRatesShippingRateToken parameters: - in: path name: shipping_rate_token required: true schema: maxLength: 5000 type: string style: simple requestBody: content: application/x-www-form-urlencoded: encoding: expand: explode: true style: deepObject fixed_amount: explode: true style: deepObject metadata: explode: true style: deepObject schema: additionalProperties: false properties: active: description: >- Whether the shipping rate can be used for new purchases. Defaults to `true`. type: boolean expand: description: Specifies which fields in the response should be expanded. items: maxLength: 5000 type: string type: array fixed_amount: description: >- Describes a fixed amount to charge for shipping. Must be present if type is `fixed_amount`. properties: currency_options: additionalProperties: properties: amount: type: integer tax_behavior: enum: - exclusive - inclusive - unspecified type: string title: currency_option_update type: object type: object title: fixed_amount_update type: object metadata: anyOf: - additionalProperties: type: string type: object - enum: - '' type: string description: >- Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. tax_behavior: description: >- Specifies whether the rate is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. enum: - exclusive - inclusive - unspecified type: string type: object required: false responses: '200': content: application/json: schema: $ref: '#/components/schemas/shipping_rate' description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. /v1/sigma/scheduled_query_runs: get: description:

Returns a list of scheduled query runs.

operationId: GetSigmaScheduledQueryRuns parameters: - description: >- A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. in: query name: ending_before required: false schema: maxLength: 5000 type: string style: form - description: Specifies which fields in the response should be expanded. explode: true in: query name: expand required: false schema: items: maxLength: 5000 type: string type: array style: deepObject - description: >- A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. in: query name: limit required: false schema: type: integer style: form - description: >- A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. in: query name: starting_after required: false schema: maxLength: 5000 type: string style: form requestBody: content: application/x-www-form-urlencoded: encoding: {} schema: additionalProperties: false properties: {} type: object required: false responses: '200': content: application/json: schema: description: '' properties: data: items: $ref: '#/components/schemas/scheduled_query_run' type: array has_more: description: >- True if this list has another page of items after this one that can be fetched. type: boolean object: description: >- String representing the object's type. Objects of the same type share the same value. Always has the value `list`. enum: - list type: string url: description: The URL where this list can be accessed. maxLength: 5000 pattern: ^/v1/sigma/scheduled_query_runs type: string required: - data - has_more - object - url title: SigmaScheduledQueryRunList type: object x-expandableFields: - data description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. '/v1/sigma/scheduled_query_runs/{scheduled_query_run}': get: description:

Retrieves the details of an scheduled query run.

operationId: GetSigmaScheduledQueryRunsScheduledQueryRun parameters: - description: Specifies which fields in the response should be expanded. explode: true in: query name: expand required: false schema: items: maxLength: 5000 type: string type: array style: deepObject - in: path name: scheduled_query_run required: true schema: maxLength: 5000 type: string style: simple requestBody: content: application/x-www-form-urlencoded: encoding: {} schema: additionalProperties: false properties: {} type: object required: false responses: '200': content: application/json: schema: $ref: '#/components/schemas/scheduled_query_run' description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. /v1/sources: post: description:

Creates a new source object.

operationId: PostSources requestBody: content: application/x-www-form-urlencoded: encoding: expand: explode: true style: deepObject mandate: explode: true style: deepObject metadata: explode: true style: deepObject owner: explode: true style: deepObject receiver: explode: true style: deepObject redirect: explode: true style: deepObject source_order: explode: true style: deepObject schema: additionalProperties: false properties: amount: description: >- Amount associated with the source. This is the amount for which the source will be chargeable once ready. Required for `single_use` sources. Not supported for `receiver` type sources, where charge amount may not be specified until funds land. type: integer currency: description: >- 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. type: string customer: description: >- The `Customer` to whom the original source is attached to. Must be set when the original source is not a `Source` (e.g., `Card`). maxLength: 500 type: string expand: description: Specifies which fields in the response should be expanded. items: maxLength: 5000 type: string type: array flow: description: >- The authentication `flow` of the source to create. `flow` is one of `redirect`, `receiver`, `code_verification`, `none`. It is generally inferred unless a type supports multiple flows. enum: - code_verification - none - receiver - redirect maxLength: 5000 type: string mandate: description: >- Information about a mandate possibility attached to a source object (generally for bank debits) as well as its acceptance status. properties: acceptance: properties: date: format: unix-time type: integer ip: type: string offline: properties: contact_email: type: string required: - contact_email title: mandate_offline_acceptance_params type: object online: properties: date: format: unix-time type: integer ip: type: string user_agent: maxLength: 5000 type: string title: mandate_online_acceptance_params type: object status: enum: - accepted - pending - refused - revoked maxLength: 5000 type: string type: enum: - offline - online maxLength: 5000 type: string user_agent: maxLength: 5000 type: string required: - status title: mandate_acceptance_params type: object amount: anyOf: - type: integer - enum: - '' type: string currency: type: string interval: enum: - one_time - scheduled - variable maxLength: 5000 type: string notification_method: enum: - deprecated_none - email - manual - none - stripe_email maxLength: 5000 type: string title: mandate_params type: object metadata: additionalProperties: type: string type: object original_source: description: The source to share. maxLength: 5000 type: string owner: description: >- Information about the owner of the payment instrument that may be used or required by particular source types. properties: address: properties: city: maxLength: 5000 type: string country: maxLength: 5000 type: string line1: maxLength: 5000 type: string line2: maxLength: 5000 type: string postal_code: maxLength: 5000 type: string state: maxLength: 5000 type: string title: source_address type: object email: type: string name: maxLength: 5000 type: string phone: maxLength: 5000 type: string title: owner type: object receiver: description: >- Optional parameters for the receiver flow. Can be set only if the source is a receiver (`flow` is `receiver`). properties: refund_attributes_method: enum: - email - manual - none maxLength: 5000 type: string title: receiver_params type: object redirect: description: >- Parameters required for the redirect flow. Required if the source is authenticated by a redirect (`flow` is `redirect`). properties: return_url: type: string required: - return_url title: redirect_params type: object source_order: description: >- Information about the items and shipping associated with the source. Required for transactional credit (for example Klarna) sources before you can charge it. properties: items: items: properties: amount: type: integer currency: type: string description: maxLength: 1000 type: string parent: maxLength: 5000 type: string quantity: type: integer type: enum: - discount - shipping - sku - tax maxLength: 5000 type: string title: order_item_specs type: object type: array shipping: properties: address: properties: city: maxLength: 5000 type: string country: maxLength: 5000 type: string line1: maxLength: 5000 type: string line2: maxLength: 5000 type: string postal_code: maxLength: 5000 type: string state: maxLength: 5000 type: string required: - line1 title: address type: object carrier: maxLength: 5000 type: string name: maxLength: 5000 type: string phone: maxLength: 5000 type: string tracking_number: maxLength: 5000 type: string required: - address title: order_shipping type: object title: shallow_order_specs type: object statement_descriptor: description: >- An arbitrary string to be displayed on your customer's statement. As an example, if your website is `RunClub` and the item you're charging for is a race ticket, you may want to specify a `statement_descriptor` of `RunClub 5K race ticket.` While many payment types will display this information, some may not display it at all. maxLength: 5000 type: string token: description: >- An optional token used to create the source. When passed, token properties will override source parameters. maxLength: 5000 type: string type: description: >- The `type` of the source to create. Required unless `customer` and `original_source` are specified (see the [Cloning card Sources](https://stripe.com/docs/sources/connect#cloning-card-sources) guide) maxLength: 5000 type: string usage: enum: - reusable - single_use maxLength: 5000 type: string type: object required: false responses: '200': content: application/json: schema: $ref: '#/components/schemas/source' description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. '/v1/sources/{source}': get: description: >-

Retrieves an existing source object. Supply the unique source ID from a source creation request and Stripe will return the corresponding up-to-date source object information.

operationId: GetSourcesSource parameters: - description: >- The client secret of the source. Required if a publishable key is used to retrieve the source. in: query name: client_secret required: false schema: maxLength: 5000 type: string style: form - description: Specifies which fields in the response should be expanded. explode: true in: query name: expand required: false schema: items: maxLength: 5000 type: string type: array style: deepObject - in: path name: source required: true schema: maxLength: 5000 type: string style: simple requestBody: content: application/x-www-form-urlencoded: encoding: {} schema: additionalProperties: false properties: {} type: object required: false responses: '200': content: application/json: schema: $ref: '#/components/schemas/source' description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. post: description: >-

Updates the specified source by setting the values of the parameters passed. Any parameters not provided will be left unchanged.

This request accepts the metadata and owner as arguments. It is also possible to update type specific information for selected payment methods. Please refer to our payment method guides for more detail.

operationId: PostSourcesSource parameters: - in: path name: source required: true schema: maxLength: 5000 type: string style: simple requestBody: content: application/x-www-form-urlencoded: encoding: expand: explode: true style: deepObject mandate: explode: true style: deepObject metadata: explode: true style: deepObject owner: explode: true style: deepObject source_order: explode: true style: deepObject schema: additionalProperties: false properties: amount: description: Amount associated with the source. type: integer expand: description: Specifies which fields in the response should be expanded. items: maxLength: 5000 type: string type: array mandate: description: >- Information about a mandate possibility attached to a source object (generally for bank debits) as well as its acceptance status. properties: acceptance: properties: date: format: unix-time type: integer ip: type: string offline: properties: contact_email: type: string required: - contact_email title: mandate_offline_acceptance_params type: object online: properties: date: format: unix-time type: integer ip: type: string user_agent: maxLength: 5000 type: string title: mandate_online_acceptance_params type: object status: enum: - accepted - pending - refused - revoked maxLength: 5000 type: string type: enum: - offline - online maxLength: 5000 type: string user_agent: maxLength: 5000 type: string required: - status title: mandate_acceptance_params type: object amount: anyOf: - type: integer - enum: - '' type: string currency: type: string interval: enum: - one_time - scheduled - variable maxLength: 5000 type: string notification_method: enum: - deprecated_none - email - manual - none - stripe_email maxLength: 5000 type: string title: mandate_params type: object metadata: anyOf: - additionalProperties: type: string type: object - enum: - '' type: string description: >- Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. owner: description: >- Information about the owner of the payment instrument that may be used or required by particular source types. properties: address: properties: city: maxLength: 5000 type: string country: maxLength: 5000 type: string line1: maxLength: 5000 type: string line2: maxLength: 5000 type: string postal_code: maxLength: 5000 type: string state: maxLength: 5000 type: string title: source_address type: object email: type: string name: maxLength: 5000 type: string phone: maxLength: 5000 type: string title: owner type: object source_order: description: >- Information about the items and shipping associated with the source. Required for transactional credit (for example Klarna) sources before you can charge it. properties: items: items: properties: amount: type: integer currency: type: string description: maxLength: 1000 type: string parent: maxLength: 5000 type: string quantity: type: integer type: enum: - discount - shipping - sku - tax maxLength: 5000 type: string title: order_item_specs type: object type: array shipping: properties: address: properties: city: maxLength: 5000 type: string country: maxLength: 5000 type: string line1: maxLength: 5000 type: string line2: maxLength: 5000 type: string postal_code: maxLength: 5000 type: string state: maxLength: 5000 type: string required: - line1 title: address type: object carrier: maxLength: 5000 type: string name: maxLength: 5000 type: string phone: maxLength: 5000 type: string tracking_number: maxLength: 5000 type: string required: - address title: order_shipping type: object title: order_params type: object type: object required: false responses: '200': content: application/json: schema: $ref: '#/components/schemas/source' description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. '/v1/sources/{source}/mandate_notifications/{mandate_notification}': get: description:

Retrieves a new Source MandateNotification.

operationId: GetSourcesSourceMandateNotificationsMandateNotification parameters: - description: Specifies which fields in the response should be expanded. explode: true in: query name: expand required: false schema: items: maxLength: 5000 type: string type: array style: deepObject - in: path name: mandate_notification required: true schema: maxLength: 5000 type: string style: simple - in: path name: source required: true schema: maxLength: 5000 type: string style: simple requestBody: content: application/x-www-form-urlencoded: encoding: {} schema: additionalProperties: false properties: {} type: object required: false responses: '200': content: application/json: schema: $ref: '#/components/schemas/source_mandate_notification' description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. '/v1/sources/{source}/source_transactions': get: description:

List source transactions for a given source.

operationId: GetSourcesSourceSourceTransactions parameters: - description: >- A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. in: query name: ending_before required: false schema: maxLength: 5000 type: string style: form - description: Specifies which fields in the response should be expanded. explode: true in: query name: expand required: false schema: items: maxLength: 5000 type: string type: array style: deepObject - description: >- A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. in: query name: limit required: false schema: type: integer style: form - in: path name: source required: true schema: maxLength: 5000 type: string style: simple - description: >- A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. in: query name: starting_after required: false schema: maxLength: 5000 type: string style: form requestBody: content: application/x-www-form-urlencoded: encoding: {} schema: additionalProperties: false properties: {} type: object required: false responses: '200': content: application/json: schema: description: '' properties: data: items: $ref: '#/components/schemas/source_transaction' type: array has_more: description: >- True if this list has another page of items after this one that can be fetched. type: boolean object: description: >- String representing the object's type. Objects of the same type share the same value. Always has the value `list`. enum: - list type: string url: description: The URL where this list can be accessed. maxLength: 5000 type: string required: - data - has_more - object - url title: ApmsSourcesSourceTransactionList type: object x-expandableFields: - data description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. '/v1/sources/{source}/source_transactions/{source_transaction}': get: description: >-

Retrieve an existing source transaction object. Supply the unique source ID from a source creation request and the source transaction ID and Stripe will return the corresponding up-to-date source object information.

operationId: GetSourcesSourceSourceTransactionsSourceTransaction parameters: - description: Specifies which fields in the response should be expanded. explode: true in: query name: expand required: false schema: items: maxLength: 5000 type: string type: array style: deepObject - in: path name: source required: true schema: maxLength: 5000 type: string style: simple - in: path name: source_transaction required: true schema: maxLength: 5000 type: string style: simple requestBody: content: application/x-www-form-urlencoded: encoding: {} schema: additionalProperties: false properties: {} type: object required: false responses: '200': content: application/json: schema: $ref: '#/components/schemas/source_transaction' description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. '/v1/sources/{source}/verify': post: description:

Verify a given source.

operationId: PostSourcesSourceVerify parameters: - in: path name: source required: true schema: maxLength: 5000 type: string style: simple requestBody: content: application/x-www-form-urlencoded: encoding: expand: explode: true style: deepObject values: explode: true style: deepObject schema: additionalProperties: false properties: expand: description: Specifies which fields in the response should be expanded. items: maxLength: 5000 type: string type: array values: description: The values needed to verify the source. items: maxLength: 5000 type: string type: array required: - values type: object required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/source' description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. /v1/subscription_items: get: description: >-

Returns a list of your subscription items for a given subscription.

operationId: GetSubscriptionItems parameters: - description: >- A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. in: query name: ending_before required: false schema: type: string style: form - description: Specifies which fields in the response should be expanded. explode: true in: query name: expand required: false schema: items: maxLength: 5000 type: string type: array style: deepObject - description: >- A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. in: query name: limit required: false schema: type: integer style: form - description: >- A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. in: query name: starting_after required: false schema: type: string style: form - description: The ID of the subscription whose items will be retrieved. in: query name: subscription required: true schema: maxLength: 5000 type: string style: form requestBody: content: application/x-www-form-urlencoded: encoding: {} schema: additionalProperties: false properties: {} type: object required: false responses: '200': content: application/json: schema: description: '' properties: data: items: $ref: '#/components/schemas/subscription_item' type: array has_more: description: >- True if this list has another page of items after this one that can be fetched. type: boolean object: description: >- String representing the object's type. Objects of the same type share the same value. Always has the value `list`. enum: - list type: string url: description: The URL where this list can be accessed. maxLength: 5000 pattern: ^/v1/subscription_items type: string required: - data - has_more - object - url title: SubscriptionsItemsSubscriptionItemList type: object x-expandableFields: - data description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. post: description: >-

Adds a new item to an existing subscription. No existing items will be changed or replaced.

operationId: PostSubscriptionItems requestBody: content: application/x-www-form-urlencoded: encoding: billing_thresholds: explode: true style: deepObject discounts: explode: true style: deepObject expand: explode: true style: deepObject metadata: explode: true style: deepObject price_data: explode: true style: deepObject tax_rates: explode: true style: deepObject schema: additionalProperties: false properties: billing_thresholds: anyOf: - properties: usage_gte: type: integer required: - usage_gte title: item_billing_thresholds_param type: object - enum: - '' type: string description: >- Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period. When updating, pass an empty string to remove previously-defined thresholds. discounts: anyOf: - items: properties: coupon: maxLength: 5000 type: string discount: maxLength: 5000 type: string promotion_code: maxLength: 5000 type: string title: discounts_data_param type: object type: array - enum: - '' type: string description: >- The coupons to redeem into discounts for the subscription item. expand: description: Specifies which fields in the response should be expanded. items: maxLength: 5000 type: string type: array metadata: additionalProperties: type: string description: >- Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. type: object payment_behavior: description: >- Use `allow_incomplete` to transition the subscription to `status=past_due` if a payment is required but cannot be paid. This allows you to manage scenarios where additional user actions are needed to pay a subscription's invoice. For example, SCA regulation may require 3DS authentication to complete payment. See the [SCA Migration Guide](https://stripe.com/docs/billing/migration/strong-customer-authentication) for Billing to learn more. This is the default behavior. Use `default_incomplete` to transition the subscription to `status=past_due` when payment is required and await explicit confirmation of the invoice's payment intent. This allows simpler management of scenarios where additional user actions are needed to pay a subscription’s invoice. Such as failed payments, [SCA regulation](https://stripe.com/docs/billing/migration/strong-customer-authentication), or collecting a mandate for a bank debit payment method. Use `pending_if_incomplete` to update the subscription using [pending updates](https://stripe.com/docs/billing/subscriptions/pending-updates). When you use `pending_if_incomplete` you can only pass the parameters [supported by pending updates](https://stripe.com/docs/billing/pending-updates-reference#supported-attributes). Use `error_if_incomplete` if you want Stripe to return an HTTP 402 status code if a subscription's invoice cannot be paid. For example, if a payment method requires 3DS authentication due to SCA regulation and further user action is needed, this parameter does not update the subscription and returns an error instead. This was the default behavior for API versions prior to 2019-03-14. See the [changelog](https://stripe.com/docs/upgrades#2019-03-14) to learn more. enum: - allow_incomplete - default_incomplete - error_if_incomplete - pending_if_incomplete type: string price: description: The ID of the price object. maxLength: 5000 type: string price_data: description: >- Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline. properties: currency: type: string product: maxLength: 5000 type: string recurring: properties: interval: enum: - day - month - week - year type: string interval_count: type: integer required: - interval title: recurring_adhoc type: object tax_behavior: enum: - exclusive - inclusive - unspecified type: string unit_amount: type: integer unit_amount_decimal: format: decimal type: string required: - currency - product - recurring title: recurring_price_data type: object proration_behavior: description: >- Determines how to handle [prorations](https://stripe.com/docs/billing/subscriptions/prorations) when the billing cycle changes (e.g., when switching plans, resetting `billing_cycle_anchor=now`, or starting a trial), or if an item's `quantity` changes. The default value is `create_prorations`. enum: - always_invoice - create_prorations - none type: string proration_date: description: >- If set, the proration will be calculated as though the subscription was updated at the given time. This can be used to apply the same proration that was previewed with the [upcoming invoice](https://stripe.com/docs/api#retrieve_customer_invoice) endpoint. format: unix-time type: integer quantity: description: >- The quantity you'd like to apply to the subscription item you're creating. type: integer subscription: description: The identifier of the subscription to modify. maxLength: 5000 type: string tax_rates: anyOf: - items: maxLength: 5000 type: string type: array - enum: - '' type: string description: >- A list of [Tax Rate](https://stripe.com/docs/api/tax_rates) ids. These Tax Rates will override the [`default_tax_rates`](https://stripe.com/docs/api/subscriptions/create#create_subscription-default_tax_rates) on the Subscription. When updating, pass an empty string to remove previously-defined tax rates. required: - subscription type: object required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/subscription_item' description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. '/v1/subscription_items/{item}': delete: description: >-

Deletes an item from the subscription. Removing a subscription item from a subscription will not cancel the subscription.

operationId: DeleteSubscriptionItemsItem parameters: - in: path name: item required: true schema: maxLength: 5000 type: string style: simple requestBody: content: application/x-www-form-urlencoded: encoding: {} schema: additionalProperties: false properties: clear_usage: description: >- Delete all usage for the given subscription item. Allowed only when the current plan's `usage_type` is `metered`. type: boolean proration_behavior: description: >- Determines how to handle [prorations](https://stripe.com/docs/billing/subscriptions/prorations) when the billing cycle changes (e.g., when switching plans, resetting `billing_cycle_anchor=now`, or starting a trial), or if an item's `quantity` changes. The default value is `create_prorations`. enum: - always_invoice - create_prorations - none type: string proration_date: description: >- If set, the proration will be calculated as though the subscription was updated at the given time. This can be used to apply the same proration that was previewed with the [upcoming invoice](https://stripe.com/docs/api#retrieve_customer_invoice) endpoint. format: unix-time type: integer type: object required: false responses: '200': content: application/json: schema: $ref: '#/components/schemas/deleted_subscription_item' description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. get: description:

Retrieves the subscription item with the given ID.

operationId: GetSubscriptionItemsItem parameters: - description: Specifies which fields in the response should be expanded. explode: true in: query name: expand required: false schema: items: maxLength: 5000 type: string type: array style: deepObject - in: path name: item required: true schema: maxLength: 5000 type: string style: simple requestBody: content: application/x-www-form-urlencoded: encoding: {} schema: additionalProperties: false properties: {} type: object required: false responses: '200': content: application/json: schema: $ref: '#/components/schemas/subscription_item' description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. post: description: >-

Updates the plan or quantity of an item on a current subscription.

operationId: PostSubscriptionItemsItem parameters: - in: path name: item required: true schema: maxLength: 5000 type: string style: simple requestBody: content: application/x-www-form-urlencoded: encoding: billing_thresholds: explode: true style: deepObject discounts: explode: true style: deepObject expand: explode: true style: deepObject metadata: explode: true style: deepObject price_data: explode: true style: deepObject tax_rates: explode: true style: deepObject schema: additionalProperties: false properties: billing_thresholds: anyOf: - properties: usage_gte: type: integer required: - usage_gte title: item_billing_thresholds_param type: object - enum: - '' type: string description: >- Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period. When updating, pass an empty string to remove previously-defined thresholds. discounts: anyOf: - items: properties: coupon: maxLength: 5000 type: string discount: maxLength: 5000 type: string promotion_code: maxLength: 5000 type: string title: discounts_data_param type: object type: array - enum: - '' type: string description: >- The coupons to redeem into discounts for the subscription item. expand: description: Specifies which fields in the response should be expanded. items: maxLength: 5000 type: string type: array metadata: anyOf: - additionalProperties: type: string type: object - enum: - '' type: string description: >- Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. off_session: description: >- Indicates if a customer is on or off-session while an invoice payment is attempted. type: boolean payment_behavior: description: >- Use `allow_incomplete` to transition the subscription to `status=past_due` if a payment is required but cannot be paid. This allows you to manage scenarios where additional user actions are needed to pay a subscription's invoice. For example, SCA regulation may require 3DS authentication to complete payment. See the [SCA Migration Guide](https://stripe.com/docs/billing/migration/strong-customer-authentication) for Billing to learn more. This is the default behavior. Use `default_incomplete` to transition the subscription to `status=past_due` when payment is required and await explicit confirmation of the invoice's payment intent. This allows simpler management of scenarios where additional user actions are needed to pay a subscription’s invoice. Such as failed payments, [SCA regulation](https://stripe.com/docs/billing/migration/strong-customer-authentication), or collecting a mandate for a bank debit payment method. Use `pending_if_incomplete` to update the subscription using [pending updates](https://stripe.com/docs/billing/subscriptions/pending-updates). When you use `pending_if_incomplete` you can only pass the parameters [supported by pending updates](https://stripe.com/docs/billing/pending-updates-reference#supported-attributes). Use `error_if_incomplete` if you want Stripe to return an HTTP 402 status code if a subscription's invoice cannot be paid. For example, if a payment method requires 3DS authentication due to SCA regulation and further user action is needed, this parameter does not update the subscription and returns an error instead. This was the default behavior for API versions prior to 2019-03-14. See the [changelog](https://stripe.com/docs/upgrades#2019-03-14) to learn more. enum: - allow_incomplete - default_incomplete - error_if_incomplete - pending_if_incomplete type: string price: description: >- The ID of the price object. When changing a subscription item's price, `quantity` is set to 1 unless a `quantity` parameter is provided. maxLength: 5000 type: string price_data: description: >- Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline. properties: currency: type: string product: maxLength: 5000 type: string recurring: properties: interval: enum: - day - month - week - year type: string interval_count: type: integer required: - interval title: recurring_adhoc type: object tax_behavior: enum: - exclusive - inclusive - unspecified type: string unit_amount: type: integer unit_amount_decimal: format: decimal type: string required: - currency - product - recurring title: recurring_price_data type: object proration_behavior: description: >- Determines how to handle [prorations](https://stripe.com/docs/billing/subscriptions/prorations) when the billing cycle changes (e.g., when switching plans, resetting `billing_cycle_anchor=now`, or starting a trial), or if an item's `quantity` changes. The default value is `create_prorations`. enum: - always_invoice - create_prorations - none type: string proration_date: description: >- If set, the proration will be calculated as though the subscription was updated at the given time. This can be used to apply the same proration that was previewed with the [upcoming invoice](https://stripe.com/docs/api#retrieve_customer_invoice) endpoint. format: unix-time type: integer quantity: description: >- The quantity you'd like to apply to the subscription item you're creating. type: integer tax_rates: anyOf: - items: maxLength: 5000 type: string type: array - enum: - '' type: string description: >- A list of [Tax Rate](https://stripe.com/docs/api/tax_rates) ids. These Tax Rates will override the [`default_tax_rates`](https://stripe.com/docs/api/subscriptions/create#create_subscription-default_tax_rates) on the Subscription. When updating, pass an empty string to remove previously-defined tax rates. type: object required: false responses: '200': content: application/json: schema: $ref: '#/components/schemas/subscription_item' description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. '/v1/subscription_items/{subscription_item}/usage_record_summaries': get: description: >-

For the specified subscription item, returns a list of summary objects. Each object in the list provides usage information that’s been summarized from multiple usage records and over a subscription billing period (e.g., 15 usage records in the month of September).

The list is sorted in reverse-chronological order (newest first). The first list item represents the most current usage period that hasn’t ended yet. Since new usage records can still be added, the returned summary information for the subscription item’s ID should be seen as unstable until the subscription billing period ends.

operationId: GetSubscriptionItemsSubscriptionItemUsageRecordSummaries parameters: - description: >- A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. in: query name: ending_before required: false schema: maxLength: 5000 type: string style: form - description: Specifies which fields in the response should be expanded. explode: true in: query name: expand required: false schema: items: maxLength: 5000 type: string type: array style: deepObject - description: >- A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. in: query name: limit required: false schema: type: integer style: form - description: >- A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. in: query name: starting_after required: false schema: maxLength: 5000 type: string style: form - in: path name: subscription_item required: true schema: type: string style: simple requestBody: content: application/x-www-form-urlencoded: encoding: {} schema: additionalProperties: false properties: {} type: object required: false responses: '200': content: application/json: schema: description: '' properties: data: items: $ref: '#/components/schemas/usage_record_summary' type: array has_more: description: >- True if this list has another page of items after this one that can be fetched. type: boolean object: description: >- String representing the object's type. Objects of the same type share the same value. Always has the value `list`. enum: - list type: string url: description: The URL where this list can be accessed. maxLength: 5000 type: string required: - data - has_more - object - url title: UsageEventsResourceUsageRecordSummaryList type: object x-expandableFields: - data description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. '/v1/subscription_items/{subscription_item}/usage_records': post: description: >-

Creates a usage record for a specified subscription item and date, and fills it with a quantity.

Usage records provide quantity information that Stripe uses to track how much a customer is using your service. With usage information and the pricing model set up by the metered billing plan, Stripe helps you send accurate invoices to your customers.

The default calculation for usage is to add up all the quantity values of the usage records within a billing period. You can change this default behavior with the billing plan’s aggregate_usage parameter. When there is more than one usage record with the same timestamp, Stripe adds the quantity values together. In most cases, this is the desired resolution, however, you can change this behavior with the action parameter.

The default pricing model for metered billing is per-unit pricing. For finer granularity, you can configure metered billing to have a tiered pricing model.

operationId: PostSubscriptionItemsSubscriptionItemUsageRecords parameters: - in: path name: subscription_item required: true schema: type: string style: simple requestBody: content: application/x-www-form-urlencoded: encoding: expand: explode: true style: deepObject timestamp: explode: true style: deepObject schema: additionalProperties: false properties: action: description: >- Valid values are `increment` (default) or `set`. When using `increment` the specified `quantity` will be added to the usage at the specified timestamp. The `set` action will overwrite the usage quantity at that timestamp. If the subscription has [billing thresholds](https://stripe.com/docs/api/subscriptions/object#subscription_object-billing_thresholds), `increment` is the only allowed value. enum: - increment - set type: string expand: description: Specifies which fields in the response should be expanded. items: maxLength: 5000 type: string type: array quantity: description: The usage quantity for the specified timestamp. type: integer timestamp: anyOf: - enum: - now maxLength: 5000 type: string - format: unix-time type: integer description: >- The timestamp for the usage event. This timestamp must be within the current billing period of the subscription of the provided `subscription_item`, and must not be in the future. When passing `"now"`, Stripe records usage for the current time. Default is `"now"` if a value is not provided. required: - quantity type: object required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/usage_record' description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. /v1/subscription_schedules: get: description:

Retrieves the list of your subscription schedules.

operationId: GetSubscriptionSchedules parameters: - description: >- Only return subscription schedules that were created canceled the given date interval. explode: true in: query name: canceled_at required: false schema: anyOf: - properties: gt: type: integer gte: type: integer lt: type: integer lte: type: integer title: range_query_specs type: object - type: integer style: deepObject - description: >- Only return subscription schedules that completed during the given date interval. explode: true in: query name: completed_at required: false schema: anyOf: - properties: gt: type: integer gte: type: integer lt: type: integer lte: type: integer title: range_query_specs type: object - type: integer style: deepObject - description: >- Only return subscription schedules that were created during the given date interval. explode: true in: query name: created required: false schema: anyOf: - properties: gt: type: integer gte: type: integer lt: type: integer lte: type: integer title: range_query_specs type: object - type: integer style: deepObject - description: Only return subscription schedules for the given customer. in: query name: customer required: false schema: maxLength: 5000 type: string style: form - description: >- A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. in: query name: ending_before required: false schema: maxLength: 5000 type: string style: form - description: Specifies which fields in the response should be expanded. explode: true in: query name: expand required: false schema: items: maxLength: 5000 type: string type: array style: deepObject - description: >- A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. in: query name: limit required: false schema: type: integer style: form - description: >- Only return subscription schedules that were released during the given date interval. explode: true in: query name: released_at required: false schema: anyOf: - properties: gt: type: integer gte: type: integer lt: type: integer lte: type: integer title: range_query_specs type: object - type: integer style: deepObject - description: Only return subscription schedules that have not started yet. in: query name: scheduled required: false schema: type: boolean style: form - description: >- A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. in: query name: starting_after required: false schema: maxLength: 5000 type: string style: form requestBody: content: application/x-www-form-urlencoded: encoding: {} schema: additionalProperties: false properties: {} type: object required: false responses: '200': content: application/json: schema: description: '' properties: data: items: $ref: '#/components/schemas/subscription_schedule' type: array has_more: description: >- True if this list has another page of items after this one that can be fetched. type: boolean object: description: >- String representing the object's type. Objects of the same type share the same value. Always has the value `list`. enum: - list type: string url: description: The URL where this list can be accessed. maxLength: 5000 pattern: ^/v1/subscription_schedules type: string required: - data - has_more - object - url title: SubscriptionSchedulesResourceScheduleList type: object x-expandableFields: - data description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. post: description: >-

Creates a new subscription schedule object. Each customer can have up to 500 active or scheduled subscriptions.

operationId: PostSubscriptionSchedules requestBody: content: application/x-www-form-urlencoded: encoding: default_settings: explode: true style: deepObject expand: explode: true style: deepObject metadata: explode: true style: deepObject phases: explode: true style: deepObject start_date: explode: true style: deepObject schema: additionalProperties: false properties: customer: description: >- The identifier of the customer to create the subscription schedule for. maxLength: 5000 type: string default_settings: description: >- Object representing the subscription schedule's default settings. properties: application_fee_percent: type: number automatic_tax: properties: enabled: type: boolean liability: properties: account: type: string type: enum: - account - self type: string required: - type title: param type: object required: - enabled title: automatic_tax_config type: object billing_cycle_anchor: enum: - automatic - phase_start type: string billing_thresholds: anyOf: - properties: amount_gte: type: integer reset_billing_cycle_anchor: type: boolean title: billing_thresholds_param type: object - enum: - '' type: string collection_method: enum: - charge_automatically - send_invoice type: string default_payment_method: maxLength: 5000 type: string description: anyOf: - maxLength: 500 type: string - enum: - '' type: string invoice_settings: properties: account_tax_ids: anyOf: - items: maxLength: 5000 type: string type: array - enum: - '' type: string days_until_due: type: integer issuer: properties: account: type: string type: enum: - account - self type: string required: - type title: param type: object title: subscription_schedule_default_settings_param type: object on_behalf_of: anyOf: - type: string - enum: - '' type: string transfer_data: anyOf: - properties: amount_percent: type: number destination: type: string required: - destination title: transfer_data_specs type: object - enum: - '' type: string title: default_settings_params type: object end_behavior: description: >- Behavior of the subscription schedule and underlying subscription when it ends. Possible values are `release` or `cancel` with the default being `release`. `release` will end the subscription schedule and keep the underlying subscription running. `cancel` will end the subscription schedule and cancel the underlying subscription. enum: - cancel - none - release - renew type: string expand: description: Specifies which fields in the response should be expanded. items: maxLength: 5000 type: string type: array from_subscription: description: >- Migrate an existing subscription to be managed by a subscription schedule. If this parameter is set, a subscription schedule will be created using the subscription's item(s), set to auto-renew using the subscription's interval. When using this parameter, other parameters (such as phase values) cannot be set. To create a subscription schedule with other modifications, we recommend making two separate API calls. maxLength: 5000 type: string metadata: anyOf: - additionalProperties: type: string type: object - enum: - '' type: string description: >- Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. phases: description: >- List representing phases of the subscription schedule. Each phase can be customized to have different durations, plans, and coupons. If there are multiple phases, the `end_date` of one phase will always equal the `start_date` of the next phase. items: properties: add_invoice_items: items: properties: discounts: items: properties: coupon: maxLength: 5000 type: string discount: maxLength: 5000 type: string promotion_code: maxLength: 5000 type: string title: discounts_data_param type: object type: array price: maxLength: 5000 type: string price_data: properties: currency: type: string product: maxLength: 5000 type: string tax_behavior: enum: - exclusive - inclusive - unspecified type: string unit_amount: type: integer unit_amount_decimal: format: decimal type: string required: - currency - product title: one_time_price_data_with_negative_amounts type: object quantity: type: integer tax_rates: anyOf: - items: maxLength: 5000 type: string type: array - enum: - '' type: string title: add_invoice_item_entry type: object type: array application_fee_percent: type: number automatic_tax: properties: enabled: type: boolean liability: properties: account: type: string type: enum: - account - self type: string required: - type title: param type: object required: - enabled title: automatic_tax_config type: object billing_cycle_anchor: enum: - automatic - phase_start type: string billing_thresholds: anyOf: - properties: amount_gte: type: integer reset_billing_cycle_anchor: type: boolean title: billing_thresholds_param type: object - enum: - '' type: string collection_method: enum: - charge_automatically - send_invoice type: string coupon: maxLength: 5000 type: string currency: type: string default_payment_method: maxLength: 5000 type: string default_tax_rates: anyOf: - items: maxLength: 5000 type: string type: array - enum: - '' type: string description: anyOf: - maxLength: 500 type: string - enum: - '' type: string discounts: anyOf: - items: properties: coupon: maxLength: 5000 type: string discount: maxLength: 5000 type: string promotion_code: maxLength: 5000 type: string title: discounts_data_param type: object type: array - enum: - '' type: string end_date: format: unix-time type: integer invoice_settings: properties: account_tax_ids: anyOf: - items: maxLength: 5000 type: string type: array - enum: - '' type: string days_until_due: type: integer issuer: properties: account: type: string type: enum: - account - self type: string required: - type title: param type: object title: invoice_settings type: object items: items: properties: billing_thresholds: anyOf: - properties: usage_gte: type: integer required: - usage_gte title: item_billing_thresholds_param type: object - enum: - '' type: string discounts: anyOf: - items: properties: coupon: maxLength: 5000 type: string discount: maxLength: 5000 type: string promotion_code: maxLength: 5000 type: string title: discounts_data_param type: object type: array - enum: - '' type: string metadata: additionalProperties: type: string type: object price: maxLength: 5000 type: string price_data: properties: currency: type: string product: maxLength: 5000 type: string recurring: properties: interval: enum: - day - month - week - year type: string interval_count: type: integer required: - interval title: recurring_adhoc type: object tax_behavior: enum: - exclusive - inclusive - unspecified type: string unit_amount: type: integer unit_amount_decimal: format: decimal type: string required: - currency - product - recurring title: recurring_price_data type: object quantity: type: integer tax_rates: anyOf: - items: maxLength: 5000 type: string type: array - enum: - '' type: string title: configuration_item_params type: object type: array iterations: type: integer metadata: additionalProperties: type: string type: object on_behalf_of: type: string proration_behavior: enum: - always_invoice - create_prorations - none type: string transfer_data: properties: amount_percent: type: number destination: type: string required: - destination title: transfer_data_specs type: object trial: type: boolean trial_end: format: unix-time type: integer required: - items title: phase_configuration_params type: object type: array start_date: anyOf: - format: unix-time type: integer - enum: - now maxLength: 5000 type: string description: >- When the subscription schedule starts. We recommend using `now` so that it starts the subscription immediately. You can also use a Unix timestamp to backdate the subscription so that it starts on a past date, or set a future date for the subscription to start on. type: object required: false responses: '200': content: application/json: schema: $ref: '#/components/schemas/subscription_schedule' description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. '/v1/subscription_schedules/{schedule}': get: description: >-

Retrieves the details of an existing subscription schedule. You only need to supply the unique subscription schedule identifier that was returned upon subscription schedule creation.

operationId: GetSubscriptionSchedulesSchedule parameters: - description: Specifies which fields in the response should be expanded. explode: true in: query name: expand required: false schema: items: maxLength: 5000 type: string type: array style: deepObject - in: path name: schedule required: true schema: maxLength: 5000 type: string style: simple requestBody: content: application/x-www-form-urlencoded: encoding: {} schema: additionalProperties: false properties: {} type: object required: false responses: '200': content: application/json: schema: $ref: '#/components/schemas/subscription_schedule' description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. post: description:

Updates an existing subscription schedule.

operationId: PostSubscriptionSchedulesSchedule parameters: - in: path name: schedule required: true schema: maxLength: 5000 type: string style: simple requestBody: content: application/x-www-form-urlencoded: encoding: default_settings: explode: true style: deepObject expand: explode: true style: deepObject metadata: explode: true style: deepObject phases: explode: true style: deepObject schema: additionalProperties: false properties: default_settings: description: >- Object representing the subscription schedule's default settings. properties: application_fee_percent: type: number automatic_tax: properties: enabled: type: boolean liability: properties: account: type: string type: enum: - account - self type: string required: - type title: param type: object required: - enabled title: automatic_tax_config type: object billing_cycle_anchor: enum: - automatic - phase_start type: string billing_thresholds: anyOf: - properties: amount_gte: type: integer reset_billing_cycle_anchor: type: boolean title: billing_thresholds_param type: object - enum: - '' type: string collection_method: enum: - charge_automatically - send_invoice type: string default_payment_method: maxLength: 5000 type: string description: anyOf: - maxLength: 500 type: string - enum: - '' type: string invoice_settings: properties: account_tax_ids: anyOf: - items: maxLength: 5000 type: string type: array - enum: - '' type: string days_until_due: type: integer issuer: properties: account: type: string type: enum: - account - self type: string required: - type title: param type: object title: subscription_schedule_default_settings_param type: object on_behalf_of: anyOf: - type: string - enum: - '' type: string transfer_data: anyOf: - properties: amount_percent: type: number destination: type: string required: - destination title: transfer_data_specs type: object - enum: - '' type: string title: default_settings_params type: object end_behavior: description: >- Behavior of the subscription schedule and underlying subscription when it ends. Possible values are `release` or `cancel` with the default being `release`. `release` will end the subscription schedule and keep the underlying subscription running. `cancel` will end the subscription schedule and cancel the underlying subscription. enum: - cancel - none - release - renew type: string expand: description: Specifies which fields in the response should be expanded. items: maxLength: 5000 type: string type: array metadata: anyOf: - additionalProperties: type: string type: object - enum: - '' type: string description: >- Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. phases: description: >- List representing phases of the subscription schedule. Each phase can be customized to have different durations, plans, and coupons. If there are multiple phases, the `end_date` of one phase will always equal the `start_date` of the next phase. Note that past phases can be omitted. items: properties: add_invoice_items: items: properties: discounts: items: properties: coupon: maxLength: 5000 type: string discount: maxLength: 5000 type: string promotion_code: maxLength: 5000 type: string title: discounts_data_param type: object type: array price: maxLength: 5000 type: string price_data: properties: currency: type: string product: maxLength: 5000 type: string tax_behavior: enum: - exclusive - inclusive - unspecified type: string unit_amount: type: integer unit_amount_decimal: format: decimal type: string required: - currency - product title: one_time_price_data_with_negative_amounts type: object quantity: type: integer tax_rates: anyOf: - items: maxLength: 5000 type: string type: array - enum: - '' type: string title: add_invoice_item_entry type: object type: array application_fee_percent: type: number automatic_tax: properties: enabled: type: boolean liability: properties: account: type: string type: enum: - account - self type: string required: - type title: param type: object required: - enabled title: automatic_tax_config type: object billing_cycle_anchor: enum: - automatic - phase_start type: string billing_thresholds: anyOf: - properties: amount_gte: type: integer reset_billing_cycle_anchor: type: boolean title: billing_thresholds_param type: object - enum: - '' type: string collection_method: enum: - charge_automatically - send_invoice type: string coupon: maxLength: 5000 type: string default_payment_method: maxLength: 5000 type: string default_tax_rates: anyOf: - items: maxLength: 5000 type: string type: array - enum: - '' type: string description: anyOf: - maxLength: 500 type: string - enum: - '' type: string discounts: anyOf: - items: properties: coupon: maxLength: 5000 type: string discount: maxLength: 5000 type: string promotion_code: maxLength: 5000 type: string title: discounts_data_param type: object type: array - enum: - '' type: string end_date: anyOf: - format: unix-time type: integer - enum: - now maxLength: 5000 type: string invoice_settings: properties: account_tax_ids: anyOf: - items: maxLength: 5000 type: string type: array - enum: - '' type: string days_until_due: type: integer issuer: properties: account: type: string type: enum: - account - self type: string required: - type title: param type: object title: invoice_settings type: object items: items: properties: billing_thresholds: anyOf: - properties: usage_gte: type: integer required: - usage_gte title: item_billing_thresholds_param type: object - enum: - '' type: string discounts: anyOf: - items: properties: coupon: maxLength: 5000 type: string discount: maxLength: 5000 type: string promotion_code: maxLength: 5000 type: string title: discounts_data_param type: object type: array - enum: - '' type: string metadata: additionalProperties: type: string type: object price: maxLength: 5000 type: string price_data: properties: currency: type: string product: maxLength: 5000 type: string recurring: properties: interval: enum: - day - month - week - year type: string interval_count: type: integer required: - interval title: recurring_adhoc type: object tax_behavior: enum: - exclusive - inclusive - unspecified type: string unit_amount: type: integer unit_amount_decimal: format: decimal type: string required: - currency - product - recurring title: recurring_price_data type: object quantity: type: integer tax_rates: anyOf: - items: maxLength: 5000 type: string type: array - enum: - '' type: string title: configuration_item_params type: object type: array iterations: type: integer metadata: additionalProperties: type: string type: object on_behalf_of: type: string proration_behavior: enum: - always_invoice - create_prorations - none type: string start_date: anyOf: - format: unix-time type: integer - enum: - now maxLength: 5000 type: string transfer_data: properties: amount_percent: type: number destination: type: string required: - destination title: transfer_data_specs type: object trial: type: boolean trial_end: anyOf: - format: unix-time type: integer - enum: - now maxLength: 5000 type: string required: - items title: phase_configuration_params type: object type: array proration_behavior: description: >- If the update changes the current phase, indicates whether the changes should be prorated. The default value is `create_prorations`. enum: - always_invoice - create_prorations - none type: string type: object required: false responses: '200': content: application/json: schema: $ref: '#/components/schemas/subscription_schedule' description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. '/v1/subscription_schedules/{schedule}/cancel': post: description: >-

Cancels a subscription schedule and its associated subscription immediately (if the subscription schedule has an active subscription). A subscription schedule can only be canceled if its status is not_started or active.

operationId: PostSubscriptionSchedulesScheduleCancel parameters: - in: path name: schedule required: true schema: maxLength: 5000 type: string style: simple requestBody: content: application/x-www-form-urlencoded: encoding: expand: explode: true style: deepObject schema: additionalProperties: false properties: expand: description: Specifies which fields in the response should be expanded. items: maxLength: 5000 type: string type: array invoice_now: description: >- If the subscription schedule is `active`, indicates if a final invoice will be generated that contains any un-invoiced metered usage and new/pending proration invoice items. Defaults to `true`. type: boolean prorate: description: >- If the subscription schedule is `active`, indicates if the cancellation should be prorated. Defaults to `true`. type: boolean type: object required: false responses: '200': content: application/json: schema: $ref: '#/components/schemas/subscription_schedule' description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. '/v1/subscription_schedules/{schedule}/release': post: description: >-

Releases the subscription schedule immediately, which will stop scheduling of its phases, but leave any existing subscription in place. A schedule can only be released if its status is not_started or active. If the subscription schedule is currently associated with a subscription, releasing it will remove its subscription property and set the subscription’s ID to the released_subscription property.

operationId: PostSubscriptionSchedulesScheduleRelease parameters: - in: path name: schedule required: true schema: maxLength: 5000 type: string style: simple requestBody: content: application/x-www-form-urlencoded: encoding: expand: explode: true style: deepObject schema: additionalProperties: false properties: expand: description: Specifies which fields in the response should be expanded. items: maxLength: 5000 type: string type: array preserve_cancel_date: description: >- Keep any cancellation on the subscription that the schedule has set type: boolean type: object required: false responses: '200': content: application/json: schema: $ref: '#/components/schemas/subscription_schedule' description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. /v1/subscriptions: get: description: >-

By default, returns a list of subscriptions that have not been canceled. In order to list canceled subscriptions, specify status=canceled.

operationId: GetSubscriptions parameters: - description: Filter subscriptions by their automatic tax settings. explode: true in: query name: automatic_tax required: false schema: properties: enabled: type: boolean required: - enabled title: automatic_tax_filter_params type: object style: deepObject - description: >- The collection method of the subscriptions to retrieve. Either `charge_automatically` or `send_invoice`. in: query name: collection_method required: false schema: enum: - charge_automatically - send_invoice type: string style: form - description: >- Only return subscriptions that were created during the given date interval. explode: true in: query name: created required: false schema: anyOf: - properties: gt: type: integer gte: type: integer lt: type: integer lte: type: integer title: range_query_specs type: object - type: integer style: deepObject - explode: true in: query name: current_period_end required: false schema: anyOf: - properties: gt: type: integer gte: type: integer lt: type: integer lte: type: integer title: range_query_specs type: object - type: integer style: deepObject - explode: true in: query name: current_period_start required: false schema: anyOf: - properties: gt: type: integer gte: type: integer lt: type: integer lte: type: integer title: range_query_specs type: object - type: integer style: deepObject - description: The ID of the customer whose subscriptions will be retrieved. in: query name: customer required: false schema: maxLength: 5000 type: string style: form - description: >- A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. in: query name: ending_before required: false schema: maxLength: 5000 type: string style: form - description: Specifies which fields in the response should be expanded. explode: true in: query name: expand required: false schema: items: maxLength: 5000 type: string type: array style: deepObject - description: >- A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. in: query name: limit required: false schema: type: integer style: form - description: Filter for subscriptions that contain this recurring price ID. in: query name: price required: false schema: maxLength: 5000 type: string style: form - description: >- A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. in: query name: starting_after required: false schema: maxLength: 5000 type: string style: form - description: >- The status of the subscriptions to retrieve. Passing in a value of `canceled` will return all canceled subscriptions, including those belonging to deleted customers. Pass `ended` to find subscriptions that are canceled and subscriptions that are expired due to [incomplete payment](https://stripe.com/docs/billing/subscriptions/overview#subscription-statuses). Passing in a value of `all` will return subscriptions of all statuses. If no value is supplied, all subscriptions that have not been canceled are returned. in: query name: status required: false schema: enum: - active - all - canceled - ended - incomplete - incomplete_expired - past_due - paused - trialing - unpaid type: string style: form - description: >- Filter for subscriptions that are associated with the specified test clock. The response will not include subscriptions with test clocks if this and the customer parameter is not set. in: query name: test_clock required: false schema: maxLength: 5000 type: string style: form requestBody: content: application/x-www-form-urlencoded: encoding: {} schema: additionalProperties: false properties: {} type: object required: false responses: '200': content: application/json: schema: description: '' properties: data: items: $ref: '#/components/schemas/subscription' type: array has_more: description: >- True if this list has another page of items after this one that can be fetched. type: boolean object: description: >- String representing the object's type. Objects of the same type share the same value. Always has the value `list`. enum: - list type: string url: description: The URL where this list can be accessed. maxLength: 5000 pattern: ^/v1/subscriptions type: string required: - data - has_more - object - url title: SubscriptionsSubscriptionList type: object x-expandableFields: - data description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. post: description: >-

Creates a new subscription on an existing customer. Each customer can have up to 500 active or scheduled subscriptions.

When you create a subscription with collection_method=charge_automatically, the first invoice is finalized as part of the request. The payment_behavior parameter determines the exact behavior of the initial payment.

To start subscriptions where the first invoice always begins in a draft status, use subscription schedules instead. Schedules provide the flexibility to model more complex billing configurations that change over time.

operationId: PostSubscriptions requestBody: content: application/x-www-form-urlencoded: encoding: add_invoice_items: explode: true style: deepObject application_fee_percent: explode: true style: deepObject automatic_tax: explode: true style: deepObject billing_cycle_anchor_config: explode: true style: deepObject billing_thresholds: explode: true style: deepObject default_tax_rates: explode: true style: deepObject discounts: explode: true style: deepObject expand: explode: true style: deepObject invoice_settings: explode: true style: deepObject items: explode: true style: deepObject metadata: explode: true style: deepObject on_behalf_of: explode: true style: deepObject payment_settings: explode: true style: deepObject pending_invoice_item_interval: explode: true style: deepObject transfer_data: explode: true style: deepObject trial_end: explode: true style: deepObject trial_settings: explode: true style: deepObject schema: additionalProperties: false properties: add_invoice_items: description: >- A list of prices and quantities that will generate invoice items appended to the next invoice for this subscription. You may pass up to 20 items. items: properties: discounts: items: properties: coupon: maxLength: 5000 type: string discount: maxLength: 5000 type: string promotion_code: maxLength: 5000 type: string title: discounts_data_param type: object type: array price: maxLength: 5000 type: string price_data: properties: currency: type: string product: maxLength: 5000 type: string tax_behavior: enum: - exclusive - inclusive - unspecified type: string unit_amount: type: integer unit_amount_decimal: format: decimal type: string required: - currency - product title: one_time_price_data_with_negative_amounts type: object quantity: type: integer tax_rates: anyOf: - items: maxLength: 5000 type: string type: array - enum: - '' type: string title: add_invoice_item_entry type: object type: array application_fee_percent: anyOf: - type: number - enum: - '' type: string description: >- 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. The request must be made by a platform account on a connected account in order to set an application fee percentage. For more information, see the application fees [documentation](https://stripe.com/docs/connect/subscriptions#collecting-fees-on-subscriptions). automatic_tax: description: >- Automatic tax settings for this subscription. We recommend you only include this parameter when the existing value is being changed. properties: enabled: type: boolean liability: properties: account: type: string type: enum: - account - self type: string required: - type title: param type: object required: - enabled title: automatic_tax_config type: object backdate_start_date: description: >- For new subscriptions, a past timestamp to backdate the subscription's start date to. If set, the first invoice will contain a proration for the timespan between the start date and the current time. Can be combined with trials and the billing cycle anchor. format: unix-time type: integer billing_cycle_anchor: description: >- A future timestamp in UTC format to anchor the subscription's [billing cycle](https://stripe.com/docs/subscriptions/billing-cycle). The anchor is the reference point that aligns future 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. format: unix-time type: integer x-stripeBypassValidation: true billing_cycle_anchor_config: description: >- Mutually exclusive with billing_cycle_anchor and only valid with monthly and yearly price intervals. When provided, the billing_cycle_anchor is set to the next occurence of the day_of_month at the hour, minute, and second UTC. properties: day_of_month: type: integer hour: type: integer minute: type: integer month: type: integer second: type: integer required: - day_of_month title: billing_cycle_anchor_config_param type: object billing_thresholds: anyOf: - properties: amount_gte: type: integer reset_billing_cycle_anchor: type: boolean title: billing_thresholds_param type: object - enum: - '' type: string description: >- Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period. Pass an empty string to remove previously-defined thresholds. cancel_at: description: >- A timestamp at which the subscription should cancel. If set to a date before the current period ends, this will cause a proration if prorations have been enabled using `proration_behavior`. If set during a future period, this will always cause a proration for that period. format: unix-time type: integer cancel_at_period_end: description: >- Boolean indicating whether this subscription should cancel at the end of the current period. type: boolean collection_method: description: >- 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`. Defaults to `charge_automatically`. enum: - charge_automatically - send_invoice type: string coupon: description: >- The ID of the coupon to apply to this subscription. A coupon applied to a subscription will only affect invoices created for that particular subscription. This field has been deprecated and will be removed in a future API version. Use `discounts` instead. maxLength: 5000 type: string currency: description: >- 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). type: string customer: description: The identifier of the customer to subscribe. maxLength: 5000 type: string days_until_due: description: >- Number of days a customer has to pay invoices generated by this subscription. Valid only for subscriptions where `collection_method` is set to `send_invoice`. type: integer default_payment_method: description: >- 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). maxLength: 5000 type: string default_source: description: >- 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). maxLength: 5000 type: string default_tax_rates: anyOf: - items: maxLength: 5000 type: string type: array - enum: - '' type: string description: >- 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: description: >- 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. maxLength: 500 type: string discounts: anyOf: - items: properties: coupon: maxLength: 5000 type: string discount: maxLength: 5000 type: string promotion_code: maxLength: 5000 type: string title: discounts_data_param type: object type: array - enum: - '' type: string description: >- The coupons to redeem into discounts for the subscription. If not specified or empty, inherits the discount from the subscription's customer. expand: description: Specifies which fields in the response should be expanded. items: maxLength: 5000 type: string type: array invoice_settings: description: All invoices will be billed using the specified settings. properties: account_tax_ids: anyOf: - items: maxLength: 5000 type: string type: array - enum: - '' type: string issuer: properties: account: type: string type: enum: - account - self type: string required: - type title: param type: object title: invoice_settings_param type: object items: description: >- A list of up to 20 subscription items, each with an attached price. items: properties: billing_thresholds: anyOf: - properties: usage_gte: type: integer required: - usage_gte title: item_billing_thresholds_param type: object - enum: - '' type: string discounts: anyOf: - items: properties: coupon: maxLength: 5000 type: string discount: maxLength: 5000 type: string promotion_code: maxLength: 5000 type: string title: discounts_data_param type: object type: array - enum: - '' type: string metadata: additionalProperties: type: string type: object price: maxLength: 5000 type: string price_data: properties: currency: type: string product: maxLength: 5000 type: string recurring: properties: interval: enum: - day - month - week - year type: string interval_count: type: integer required: - interval title: recurring_adhoc type: object tax_behavior: enum: - exclusive - inclusive - unspecified type: string unit_amount: type: integer unit_amount_decimal: format: decimal type: string required: - currency - product - recurring title: recurring_price_data type: object quantity: type: integer tax_rates: anyOf: - items: maxLength: 5000 type: string type: array - enum: - '' type: string title: subscription_item_create_params type: object type: array metadata: anyOf: - additionalProperties: type: string type: object - enum: - '' type: string description: >- Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. off_session: description: >- Indicates if a customer is on or off-session while an invoice payment is attempted. type: boolean on_behalf_of: anyOf: - type: string - enum: - '' type: string description: >- The account on behalf of which to charge, for each of the subscription's invoices. payment_behavior: description: >- Only applies to subscriptions with `collection_method=charge_automatically`. Use `allow_incomplete` to create Subscriptions with `status=incomplete` if the first invoice can't be paid. Creating Subscriptions with this status allows you to manage scenarios where additional customer actions are needed to pay a subscription's invoice. For example, SCA regulation may require 3DS authentication to complete payment. See the [SCA Migration Guide](https://stripe.com/docs/billing/migration/strong-customer-authentication) for Billing to learn more. This is the default behavior. Use `default_incomplete` to create Subscriptions with `status=incomplete` when the first invoice requires payment, otherwise start as active. Subscriptions transition to `status=active` when successfully confirming the PaymentIntent on the first invoice. This allows simpler management of scenarios where additional customer actions are needed to pay a subscription’s invoice, such as failed payments, [SCA regulation](https://stripe.com/docs/billing/migration/strong-customer-authentication), or collecting a mandate for a bank debit payment method. If the PaymentIntent is not confirmed within 23 hours Subscriptions transition to `status=incomplete_expired`, which is a terminal state. Use `error_if_incomplete` if you want Stripe to return an HTTP 402 status code if a subscription's first invoice can't be paid. For example, if a payment method requires 3DS authentication due to SCA regulation and further customer action is needed, this parameter doesn't create a Subscription and returns an error instead. This was the default behavior for API versions prior to 2019-03-14. See the [changelog](https://stripe.com/docs/upgrades#2019-03-14) to learn more. `pending_if_incomplete` is only used with updates and cannot be passed when creating a Subscription. Subscriptions with `collection_method=send_invoice` are automatically activated regardless of the first Invoice status. enum: - allow_incomplete - default_incomplete - error_if_incomplete - pending_if_incomplete type: string payment_settings: description: >- Payment settings to pass to invoices created by the subscription. properties: payment_method_options: properties: acss_debit: anyOf: - properties: mandate_options: properties: transaction_type: enum: - business - personal type: string title: mandate_options_param type: object verification_method: enum: - automatic - instant - microdeposits type: string x-stripeBypassValidation: true title: invoice_payment_method_options_param type: object - enum: - '' type: string bancontact: anyOf: - properties: preferred_language: enum: - de - en - fr - nl type: string title: invoice_payment_method_options_param type: object - enum: - '' type: string card: anyOf: - properties: mandate_options: properties: amount: type: integer amount_type: enum: - fixed - maximum type: string description: maxLength: 200 type: string title: mandate_options_param type: object network: enum: - amex - cartes_bancaires - diners - discover - eftpos_au - interac - jcb - mastercard - unionpay - unknown - visa maxLength: 5000 type: string x-stripeBypassValidation: true request_three_d_secure: enum: - any - automatic - challenge type: string title: subscription_payment_method_options_param type: object - enum: - '' type: string customer_balance: anyOf: - properties: bank_transfer: properties: eu_bank_transfer: properties: country: maxLength: 5000 type: string required: - country title: eu_bank_transfer_param type: object type: type: string title: bank_transfer_param type: object funding_type: type: string title: invoice_payment_method_options_param type: object - enum: - '' type: string konbini: anyOf: - properties: {} title: invoice_payment_method_options_param type: object - enum: - '' type: string sepa_debit: anyOf: - properties: {} title: invoice_payment_method_options_param type: object - enum: - '' type: string us_bank_account: anyOf: - properties: financial_connections: properties: permissions: items: enum: - balances - ownership - payment_method - transactions maxLength: 5000 type: string x-stripeBypassValidation: true type: array prefetch: items: enum: - balances - ownership - transactions type: string x-stripeBypassValidation: true type: array title: invoice_linked_account_options_param type: object verification_method: enum: - automatic - instant - microdeposits type: string x-stripeBypassValidation: true title: invoice_payment_method_options_param type: object - enum: - '' type: string title: payment_method_options type: object payment_method_types: anyOf: - items: enum: - ach_credit_transfer - ach_debit - acss_debit - au_becs_debit - bacs_debit - bancontact - boleto - card - cashapp - customer_balance - eps - fpx - giropay - grabpay - ideal - konbini - link - p24 - paynow - paypal - promptpay - sepa_debit - sofort - us_bank_account - wechat_pay type: string x-stripeBypassValidation: true type: array - enum: - '' type: string save_default_payment_method: enum: - 'off' - on_subscription type: string title: payment_settings type: object pending_invoice_item_interval: anyOf: - properties: interval: enum: - day - month - week - year type: string interval_count: type: integer required: - interval title: pending_invoice_item_interval_params type: object - enum: - '' type: string description: >- Specifies an interval for how often to bill for any pending invoice items. It is analogous to calling [Create an invoice](https://stripe.com/docs/api#create_invoice) for the given subscription at the specified interval. promotion_code: description: >- The ID of a promotion code to apply to this subscription. A promotion code applied to a subscription will only affect invoices created for that particular subscription. This field has been deprecated and will be removed in a future API version. Use `discounts` instead. maxLength: 5000 type: string proration_behavior: description: >- Determines how to handle [prorations](https://stripe.com/docs/billing/subscriptions/prorations) resulting from the `billing_cycle_anchor`. If no value is passed, the default is `create_prorations`. enum: - always_invoice - create_prorations - none type: string transfer_data: description: >- If specified, the funds from the subscription's invoices will be transferred to the destination and the ID of the resulting transfers will be found on the resulting charges. properties: amount_percent: type: number destination: type: string required: - destination title: transfer_data_specs type: object trial_end: anyOf: - enum: - now maxLength: 5000 type: string - format: unix-time type: integer description: >- Unix timestamp representing the end of the trial period the customer will get before being charged for the first time. If set, trial_end will override the default trial period of the plan the customer is being subscribed to. The special value `now` can be provided to end the customer's trial immediately. Can be at most two years from `billing_cycle_anchor`. See [Using trial periods on subscriptions](https://stripe.com/docs/billing/subscriptions/trials) to learn more. trial_from_plan: description: >- Indicates if a plan's `trial_period_days` should be applied to the subscription. Setting `trial_end` per subscription is preferred, and this defaults to `false`. Setting this flag to `true` together with `trial_end` is not allowed. See [Using trial periods on subscriptions](https://stripe.com/docs/billing/subscriptions/trials) to learn more. type: boolean trial_period_days: description: >- Integer representing the number of trial period days before the customer is charged for the first time. This will always overwrite any trials that might apply via a subscribed plan. See [Using trial periods on subscriptions](https://stripe.com/docs/billing/subscriptions/trials) to learn more. type: integer trial_settings: description: Settings related to subscription trials. properties: end_behavior: properties: missing_payment_method: enum: - cancel - create_invoice - pause type: string required: - missing_payment_method title: end_behavior type: object required: - end_behavior title: trial_settings_config type: object required: - customer type: object required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/subscription' description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. /v1/subscriptions/search: get: description: >-

Search for subscriptions you’ve previously created using Stripe’s Search Query Language. Don’t use search in read-after-write flows where strict consistency is necessary. Under normal operating conditions, data is searchable in less than a minute. Occasionally, propagation of new or updated data can be up to an hour behind during outages. Search functionality is not available to merchants in India.

operationId: GetSubscriptionsSearch parameters: - description: Specifies which fields in the response should be expanded. explode: true in: query name: expand required: false schema: items: maxLength: 5000 type: string type: array style: deepObject - description: >- A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. in: query name: limit required: false schema: type: integer style: form - description: >- A cursor for pagination across multiple pages of results. Don't include this parameter on the first call. Use the next_page value returned in a previous response to request subsequent results. in: query name: page required: false schema: maxLength: 5000 type: string style: form - description: >- The search query string. See [search query language](https://stripe.com/docs/search#search-query-language) and the list of supported [query fields for subscriptions](https://stripe.com/docs/search#query-fields-for-subscriptions). in: query name: query required: true schema: maxLength: 5000 type: string style: form requestBody: content: application/x-www-form-urlencoded: encoding: {} schema: additionalProperties: false properties: {} type: object required: false responses: '200': content: application/json: schema: description: '' properties: data: items: $ref: '#/components/schemas/subscription' type: array has_more: type: boolean next_page: maxLength: 5000 nullable: true type: string object: description: >- String representing the object's type. Objects of the same type share the same value. enum: - search_result type: string total_count: description: >- The total number of objects that match the query, only accurate up to 10,000. type: integer url: maxLength: 5000 type: string required: - data - has_more - object - url title: SearchResult type: object x-expandableFields: - data description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. '/v1/subscriptions/{subscription_exposed_id}': delete: description: >-

Cancels a customer’s subscription immediately. The customer will not be charged again for the subscription.

Note, however, that any pending invoice items that you’ve created will still be charged for at the end of the period, unless manually deleted. If you’ve set the subscription to cancel at the end of the period, any pending prorations will also be left in place and collected at the end of the period. But if the subscription is set to cancel immediately, pending prorations will be removed.

By default, upon subscription cancellation, Stripe will stop automatic collection of all finalized invoices for the customer. This is intended to prevent unexpected payment attempts after the customer has canceled a subscription. However, you can resume automatic collection of the invoices manually after subscription cancellation to have us proceed. Or, you could check for unpaid invoices before allowing the customer to cancel the subscription at all.

operationId: DeleteSubscriptionsSubscriptionExposedId parameters: - in: path name: subscription_exposed_id required: true schema: maxLength: 5000 type: string style: simple requestBody: content: application/x-www-form-urlencoded: encoding: cancellation_details: explode: true style: deepObject expand: explode: true style: deepObject schema: additionalProperties: false properties: cancellation_details: description: Details about why this subscription was cancelled properties: comment: anyOf: - maxLength: 5000 type: string - enum: - '' type: string feedback: enum: - '' - customer_service - low_quality - missing_features - other - switched_service - too_complex - too_expensive - unused type: string title: cancellation_details_param type: object expand: description: Specifies which fields in the response should be expanded. items: maxLength: 5000 type: string type: array invoice_now: description: >- Will generate a final invoice that invoices for any un-invoiced metered usage and new/pending proration invoice items. type: boolean prorate: description: >- Will generate a proration invoice item that credits remaining unused time until the subscription period end. type: boolean type: object required: false responses: '200': content: application/json: schema: $ref: '#/components/schemas/subscription' description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. get: description:

Retrieves the subscription with the given ID.

operationId: GetSubscriptionsSubscriptionExposedId parameters: - description: Specifies which fields in the response should be expanded. explode: true in: query name: expand required: false schema: items: maxLength: 5000 type: string type: array style: deepObject - in: path name: subscription_exposed_id required: true schema: maxLength: 5000 type: string style: simple requestBody: content: application/x-www-form-urlencoded: encoding: {} schema: additionalProperties: false properties: {} type: object required: false responses: '200': content: application/json: schema: $ref: '#/components/schemas/subscription' description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. post: description: >-

Updates an existing subscription to match the specified parameters. When changing prices or quantities, we optionally prorate the price we charge next month to make up for any price changes. To preview how the proration is calculated, use the upcoming invoice endpoint.

By default, we prorate subscription changes. For example, if a customer signs up on May 1 for a 100 price, they’ll be billed 100 immediately. If on May 15 they switch to a 200 price, then on June 1 they’ll be billed 250 (200 for a renewal of her subscription, plus a 50 prorating adjustment for half of the previous month’s 100 difference). Similarly, a downgrade generates a credit that is applied to the next invoice. We also prorate when you make quantity changes.

Switching prices does not normally change the billing date or generate an immediate charge unless:

  • The billing interval is changed (for example, from monthly to yearly).
  • The subscription moves from free to paid, or paid to free.
  • A trial starts or ends.

In these cases, we apply a credit for the unused time on the previous price, immediately charge the customer using the new price, and reset the billing date.

If you want to charge for an upgrade immediately, pass proration_behavior as always_invoice to create prorations, automatically invoice the customer for those proration adjustments, and attempt to collect payment. If you pass create_prorations, the prorations are created but not automatically invoiced. If you want to bill the customer for the prorations before the subscription’s renewal date, you need to manually invoice the customer.

If you don’t want to prorate, set the proration_behavior option to none. With this option, the customer is billed 100 on May 1 and 200 on June 1. Similarly, if you set proration_behavior to none when switching between different billing intervals (for example, from monthly to yearly), we don’t generate any credits for the old subscription’s unused time. We still reset the billing date and bill immediately for the new subscription.

Updating the quantity on a subscription many times in an hour may result in rate limiting. If you need to bill for a frequently changing quantity, consider integrating usage-based billing instead.

operationId: PostSubscriptionsSubscriptionExposedId parameters: - in: path name: subscription_exposed_id required: true schema: maxLength: 5000 type: string style: simple requestBody: content: application/x-www-form-urlencoded: encoding: add_invoice_items: explode: true style: deepObject application_fee_percent: explode: true style: deepObject automatic_tax: explode: true style: deepObject billing_thresholds: explode: true style: deepObject cancel_at: explode: true style: deepObject cancellation_details: explode: true style: deepObject default_source: explode: true style: deepObject default_tax_rates: explode: true style: deepObject description: explode: true style: deepObject discounts: explode: true style: deepObject expand: explode: true style: deepObject invoice_settings: explode: true style: deepObject items: explode: true style: deepObject metadata: explode: true style: deepObject on_behalf_of: explode: true style: deepObject pause_collection: explode: true style: deepObject payment_settings: explode: true style: deepObject pending_invoice_item_interval: explode: true style: deepObject transfer_data: explode: true style: deepObject trial_end: explode: true style: deepObject trial_settings: explode: true style: deepObject schema: additionalProperties: false properties: add_invoice_items: description: >- A list of prices and quantities that will generate invoice items appended to the next invoice for this subscription. You may pass up to 20 items. items: properties: discounts: items: properties: coupon: maxLength: 5000 type: string discount: maxLength: 5000 type: string promotion_code: maxLength: 5000 type: string title: discounts_data_param type: object type: array price: maxLength: 5000 type: string price_data: properties: currency: type: string product: maxLength: 5000 type: string tax_behavior: enum: - exclusive - inclusive - unspecified type: string unit_amount: type: integer unit_amount_decimal: format: decimal type: string required: - currency - product title: one_time_price_data_with_negative_amounts type: object quantity: type: integer tax_rates: anyOf: - items: maxLength: 5000 type: string type: array - enum: - '' type: string title: add_invoice_item_entry type: object type: array application_fee_percent: anyOf: - type: number - enum: - '' type: string description: >- 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. The request must be made by a platform account on a connected account in order to set an application fee percentage. For more information, see the application fees [documentation](https://stripe.com/docs/connect/subscriptions#collecting-fees-on-subscriptions). automatic_tax: description: >- Automatic tax settings for this subscription. We recommend you only include this parameter when the existing value is being changed. properties: enabled: type: boolean liability: properties: account: type: string type: enum: - account - self type: string required: - type title: param type: object required: - enabled title: automatic_tax_config type: object billing_cycle_anchor: description: >- Either `now` or `unchanged`. Setting the value to `now` resets the subscription's billing cycle anchor to the current time (in UTC). For more information, see the billing cycle [documentation](https://stripe.com/docs/billing/subscriptions/billing-cycle). enum: - now - unchanged maxLength: 5000 type: string x-stripeBypassValidation: true billing_thresholds: anyOf: - properties: amount_gte: type: integer reset_billing_cycle_anchor: type: boolean title: billing_thresholds_param type: object - enum: - '' type: string description: >- Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period. Pass an empty string to remove previously-defined thresholds. cancel_at: anyOf: - format: unix-time type: integer - enum: - '' type: string description: >- A timestamp at which the subscription should cancel. If set to a date before the current period ends, this will cause a proration if prorations have been enabled using `proration_behavior`. If set during a future period, this will always cause a proration for that period. cancel_at_period_end: description: >- Boolean indicating whether this subscription should cancel at the end of the current period. type: boolean cancellation_details: description: Details about why this subscription was cancelled properties: comment: anyOf: - maxLength: 5000 type: string - enum: - '' type: string feedback: enum: - '' - customer_service - low_quality - missing_features - other - switched_service - too_complex - too_expensive - unused type: string title: cancellation_details_param type: object collection_method: description: >- 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`. Defaults to `charge_automatically`. enum: - charge_automatically - send_invoice type: string coupon: description: >- The ID of the coupon to apply to this subscription. A coupon applied to a subscription will only affect invoices created for that particular subscription. This field has been deprecated and will be removed in a future API version. Use `discounts` instead. maxLength: 5000 type: string days_until_due: description: >- Number of days a customer has to pay invoices generated by this subscription. Valid only for subscriptions where `collection_method` is set to `send_invoice`. type: integer default_payment_method: description: >- 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). maxLength: 5000 type: string default_source: anyOf: - maxLength: 5000 type: string - enum: - '' type: string description: >- 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: anyOf: - items: maxLength: 5000 type: string type: array - enum: - '' type: string description: >- 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. Pass an empty string to remove previously-defined tax rates. description: anyOf: - maxLength: 500 type: string - enum: - '' type: string description: >- The subscription's description, meant to be displayable to the customer. Use this field to optionally store an explanation of the subscription for rendering in Stripe surfaces and certain local payment methods UIs. discounts: anyOf: - items: properties: coupon: maxLength: 5000 type: string discount: maxLength: 5000 type: string promotion_code: maxLength: 5000 type: string title: discounts_data_param type: object type: array - enum: - '' type: string description: >- The coupons to redeem into discounts for the subscription. If not specified or empty, inherits the discount from the subscription's customer. expand: description: Specifies which fields in the response should be expanded. items: maxLength: 5000 type: string type: array invoice_settings: description: All invoices will be billed using the specified settings. properties: account_tax_ids: anyOf: - items: maxLength: 5000 type: string type: array - enum: - '' type: string issuer: properties: account: type: string type: enum: - account - self type: string required: - type title: param type: object title: invoice_settings_param type: object items: description: >- A list of up to 20 subscription items, each with an attached price. items: properties: billing_thresholds: anyOf: - properties: usage_gte: type: integer required: - usage_gte title: item_billing_thresholds_param type: object - enum: - '' type: string clear_usage: type: boolean deleted: type: boolean discounts: anyOf: - items: properties: coupon: maxLength: 5000 type: string discount: maxLength: 5000 type: string promotion_code: maxLength: 5000 type: string title: discounts_data_param type: object type: array - enum: - '' type: string id: maxLength: 5000 type: string metadata: anyOf: - additionalProperties: type: string type: object - enum: - '' type: string price: maxLength: 5000 type: string price_data: properties: currency: type: string product: maxLength: 5000 type: string recurring: properties: interval: enum: - day - month - week - year type: string interval_count: type: integer required: - interval title: recurring_adhoc type: object tax_behavior: enum: - exclusive - inclusive - unspecified type: string unit_amount: type: integer unit_amount_decimal: format: decimal type: string required: - currency - product - recurring title: recurring_price_data type: object quantity: type: integer tax_rates: anyOf: - items: maxLength: 5000 type: string type: array - enum: - '' type: string title: subscription_item_update_params type: object type: array metadata: anyOf: - additionalProperties: type: string type: object - enum: - '' type: string description: >- Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. off_session: description: >- Indicates if a customer is on or off-session while an invoice payment is attempted. type: boolean on_behalf_of: anyOf: - type: string - enum: - '' type: string description: >- The account on behalf of which to charge, for each of the subscription's invoices. pause_collection: anyOf: - properties: behavior: enum: - keep_as_draft - mark_uncollectible - void type: string resumes_at: format: unix-time type: integer required: - behavior title: pause_collection_param type: object - enum: - '' type: string description: >- If specified, payment collection for this subscription will be paused. Note that the subscription status will be unchanged and will not be updated to `paused`. Learn more about [pausing collection](/billing/subscriptions/pause-payment). payment_behavior: description: >- Use `allow_incomplete` to transition the subscription to `status=past_due` if a payment is required but cannot be paid. This allows you to manage scenarios where additional user actions are needed to pay a subscription's invoice. For example, SCA regulation may require 3DS authentication to complete payment. See the [SCA Migration Guide](https://stripe.com/docs/billing/migration/strong-customer-authentication) for Billing to learn more. This is the default behavior. Use `default_incomplete` to transition the subscription to `status=past_due` when payment is required and await explicit confirmation of the invoice's payment intent. This allows simpler management of scenarios where additional user actions are needed to pay a subscription’s invoice. Such as failed payments, [SCA regulation](https://stripe.com/docs/billing/migration/strong-customer-authentication), or collecting a mandate for a bank debit payment method. Use `pending_if_incomplete` to update the subscription using [pending updates](https://stripe.com/docs/billing/subscriptions/pending-updates). When you use `pending_if_incomplete` you can only pass the parameters [supported by pending updates](https://stripe.com/docs/billing/pending-updates-reference#supported-attributes). Use `error_if_incomplete` if you want Stripe to return an HTTP 402 status code if a subscription's invoice cannot be paid. For example, if a payment method requires 3DS authentication due to SCA regulation and further user action is needed, this parameter does not update the subscription and returns an error instead. This was the default behavior for API versions prior to 2019-03-14. See the [changelog](https://stripe.com/docs/upgrades#2019-03-14) to learn more. enum: - allow_incomplete - default_incomplete - error_if_incomplete - pending_if_incomplete type: string payment_settings: description: >- Payment settings to pass to invoices created by the subscription. properties: payment_method_options: properties: acss_debit: anyOf: - properties: mandate_options: properties: transaction_type: enum: - business - personal type: string title: mandate_options_param type: object verification_method: enum: - automatic - instant - microdeposits type: string x-stripeBypassValidation: true title: invoice_payment_method_options_param type: object - enum: - '' type: string bancontact: anyOf: - properties: preferred_language: enum: - de - en - fr - nl type: string title: invoice_payment_method_options_param type: object - enum: - '' type: string card: anyOf: - properties: mandate_options: properties: amount: type: integer amount_type: enum: - fixed - maximum type: string description: maxLength: 200 type: string title: mandate_options_param type: object network: enum: - amex - cartes_bancaires - diners - discover - eftpos_au - interac - jcb - mastercard - unionpay - unknown - visa maxLength: 5000 type: string x-stripeBypassValidation: true request_three_d_secure: enum: - any - automatic - challenge type: string title: subscription_payment_method_options_param type: object - enum: - '' type: string customer_balance: anyOf: - properties: bank_transfer: properties: eu_bank_transfer: properties: country: maxLength: 5000 type: string required: - country title: eu_bank_transfer_param type: object type: type: string title: bank_transfer_param type: object funding_type: type: string title: invoice_payment_method_options_param type: object - enum: - '' type: string konbini: anyOf: - properties: {} title: invoice_payment_method_options_param type: object - enum: - '' type: string sepa_debit: anyOf: - properties: {} title: invoice_payment_method_options_param type: object - enum: - '' type: string us_bank_account: anyOf: - properties: financial_connections: properties: permissions: items: enum: - balances - ownership - payment_method - transactions maxLength: 5000 type: string x-stripeBypassValidation: true type: array prefetch: items: enum: - balances - ownership - transactions type: string x-stripeBypassValidation: true type: array title: invoice_linked_account_options_param type: object verification_method: enum: - automatic - instant - microdeposits type: string x-stripeBypassValidation: true title: invoice_payment_method_options_param type: object - enum: - '' type: string title: payment_method_options type: object payment_method_types: anyOf: - items: enum: - ach_credit_transfer - ach_debit - acss_debit - au_becs_debit - bacs_debit - bancontact - boleto - card - cashapp - customer_balance - eps - fpx - giropay - grabpay - ideal - konbini - link - p24 - paynow - paypal - promptpay - sepa_debit - sofort - us_bank_account - wechat_pay type: string x-stripeBypassValidation: true type: array - enum: - '' type: string save_default_payment_method: enum: - 'off' - on_subscription type: string title: payment_settings type: object pending_invoice_item_interval: anyOf: - properties: interval: enum: - day - month - week - year type: string interval_count: type: integer required: - interval title: pending_invoice_item_interval_params type: object - enum: - '' type: string description: >- Specifies an interval for how often to bill for any pending invoice items. It is analogous to calling [Create an invoice](https://stripe.com/docs/api#create_invoice) for the given subscription at the specified interval. promotion_code: description: >- The promotion code to apply to this subscription. A promotion code applied to a subscription will only affect invoices created for that particular subscription. maxLength: 5000 type: string proration_behavior: description: >- Determines how to handle [prorations](https://stripe.com/docs/billing/subscriptions/prorations) when the billing cycle changes (e.g., when switching plans, resetting `billing_cycle_anchor=now`, or starting a trial), or if an item's `quantity` changes. The default value is `create_prorations`. enum: - always_invoice - create_prorations - none type: string proration_date: description: >- If set, the proration will be calculated as though the subscription was updated at the given time. This can be used to apply exactly the same proration that was previewed with [upcoming invoice](https://stripe.com/docs/api#upcoming_invoice) endpoint. It can also be used to implement custom proration logic, such as prorating by day instead of by second, by providing the time that you wish to use for proration calculations. format: unix-time type: integer transfer_data: anyOf: - properties: amount_percent: type: number destination: type: string required: - destination title: transfer_data_specs type: object - enum: - '' type: string description: >- If specified, the funds from the subscription's invoices will be transferred to the destination and the ID of the resulting transfers will be found on the resulting charges. This will be unset if you POST an empty value. trial_end: anyOf: - enum: - now maxLength: 5000 type: string - format: unix-time type: integer description: >- Unix timestamp representing the end of the trial period the customer will get before being charged for the first time. This will always overwrite any trials that might apply via a subscribed plan. If set, trial_end will override the default trial period of the plan the customer is being subscribed to. The special value `now` can be provided to end the customer's trial immediately. Can be at most two years from `billing_cycle_anchor`. trial_from_plan: description: >- Indicates if a plan's `trial_period_days` should be applied to the subscription. Setting `trial_end` per subscription is preferred, and this defaults to `false`. Setting this flag to `true` together with `trial_end` is not allowed. See [Using trial periods on subscriptions](https://stripe.com/docs/billing/subscriptions/trials) to learn more. type: boolean trial_settings: description: Settings related to subscription trials. properties: end_behavior: properties: missing_payment_method: enum: - cancel - create_invoice - pause type: string required: - missing_payment_method title: end_behavior type: object required: - end_behavior title: trial_settings_config type: object type: object required: false responses: '200': content: application/json: schema: $ref: '#/components/schemas/subscription' description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. '/v1/subscriptions/{subscription_exposed_id}/discount': delete: description:

Removes the currently applied discount on a subscription.

operationId: DeleteSubscriptionsSubscriptionExposedIdDiscount parameters: - in: path name: subscription_exposed_id required: true schema: maxLength: 5000 type: string style: simple requestBody: content: application/x-www-form-urlencoded: encoding: {} schema: additionalProperties: false properties: {} type: object required: false responses: '200': content: application/json: schema: $ref: '#/components/schemas/deleted_discount' description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. '/v1/subscriptions/{subscription}/resume': post: description: >-

Initiates resumption of a paused subscription, optionally resetting the billing cycle anchor and creating prorations. If a resumption invoice is generated, it must be paid or marked uncollectible before the subscription will be unpaused. If payment succeeds the subscription will become active, and if payment fails the subscription will be past_due. The resumption invoice will void automatically if not paid by the expiration date.

operationId: PostSubscriptionsSubscriptionResume parameters: - in: path name: subscription required: true schema: maxLength: 5000 type: string style: simple requestBody: content: application/x-www-form-urlencoded: encoding: expand: explode: true style: deepObject schema: additionalProperties: false properties: billing_cycle_anchor: description: >- Either `now` or `unchanged`. Setting the value to `now` resets the subscription's billing cycle anchor to the current time (in UTC). Setting the value to `unchanged` advances the subscription's billing cycle anchor to the period that surrounds the current time. For more information, see the billing cycle [documentation](https://stripe.com/docs/billing/subscriptions/billing-cycle). enum: - now - unchanged maxLength: 5000 type: string expand: description: Specifies which fields in the response should be expanded. items: maxLength: 5000 type: string type: array proration_behavior: description: >- Determines how to handle [prorations](https://stripe.com/docs/billing/subscriptions/prorations) when the billing cycle changes (e.g., when switching plans, resetting `billing_cycle_anchor=now`, or starting a trial), or if an item's `quantity` changes. The default value is `create_prorations`. enum: - always_invoice - create_prorations - none type: string proration_date: description: >- If set, the proration will be calculated as though the subscription was resumed at the given time. This can be used to apply exactly the same proration that was previewed with [upcoming invoice](https://stripe.com/docs/api#retrieve_customer_invoice) endpoint. format: unix-time type: integer type: object required: false responses: '200': content: application/json: schema: $ref: '#/components/schemas/subscription' description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. /v1/tax/calculations: post: description: >-

Calculates tax based on input and returns a Tax Calculation object.

operationId: PostTaxCalculations requestBody: content: application/x-www-form-urlencoded: encoding: customer_details: explode: true style: deepObject expand: explode: true style: deepObject line_items: explode: true style: deepObject shipping_cost: explode: true style: deepObject schema: additionalProperties: false properties: currency: description: >- 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). type: string customer: description: >- The ID of an existing customer to use for this calculation. If provided, the customer's address and tax IDs are copied to `customer_details`. maxLength: 5000 type: string customer_details: description: 'Details about the customer, including address and tax IDs.' properties: address: properties: city: anyOf: - maxLength: 5000 type: string - enum: - '' type: string country: maxLength: 5000 type: string line1: anyOf: - maxLength: 5000 type: string - enum: - '' type: string line2: anyOf: - maxLength: 5000 type: string - enum: - '' type: string postal_code: anyOf: - maxLength: 5000 type: string - enum: - '' type: string state: anyOf: - maxLength: 5000 type: string - enum: - '' type: string required: - country title: postal_address type: object address_source: enum: - billing - shipping type: string ip_address: type: string tax_ids: items: properties: type: enum: - ad_nrt - ae_trn - ar_cuit - au_abn - au_arn - bg_uic - bh_vat - bo_tin - br_cnpj - br_cpf - ca_bn - ca_gst_hst - ca_pst_bc - ca_pst_mb - ca_pst_sk - ca_qst - ch_vat - cl_tin - cn_tin - co_nit - cr_tin - do_rcn - ec_ruc - eg_tin - es_cif - eu_oss_vat - eu_vat - gb_vat - ge_vat - hk_br - hu_tin - id_npwp - il_vat - in_gst - is_vat - jp_cn - jp_rn - jp_trn - ke_pin - kr_brn - kz_bin - li_uid - mx_rfc - my_frp - my_itn - my_sst - ng_tin - no_vat - no_voec - nz_gst - om_vat - pe_ruc - ph_tin - ro_tin - rs_pib - ru_inn - ru_kpp - sa_vat - sg_gst - sg_uen - si_tin - sv_nit - th_vat - tr_tin - tw_vat - ua_vat - us_ein - uy_ruc - ve_rif - vn_tin - za_vat maxLength: 5000 type: string x-stripeBypassValidation: true value: type: string required: - type - value title: data_params type: object type: array taxability_override: enum: - customer_exempt - none - reverse_charge type: string title: customer_details type: object expand: description: Specifies which fields in the response should be expanded. items: maxLength: 5000 type: string type: array line_items: description: A list of items the customer is purchasing. items: properties: amount: type: integer product: maxLength: 5000 type: string quantity: type: integer reference: maxLength: 500 type: string tax_behavior: enum: - exclusive - inclusive type: string tax_code: type: string required: - amount title: calculation_line_item type: object type: array shipping_cost: description: Shipping cost details to be used for the calculation. properties: amount: type: integer shipping_rate: maxLength: 5000 type: string tax_behavior: enum: - exclusive - inclusive type: string tax_code: type: string title: shipping_cost type: object tax_date: description: >- Timestamp of date at which the tax rules and rates in effect applies for the calculation. Measured in seconds since the Unix epoch. Can be up to 48 hours in the past, and up to 48 hours in the future. type: integer required: - currency - line_items type: object required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/tax.calculation' description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. '/v1/tax/calculations/{calculation}/line_items': get: description: >-

Retrieves the line items of a persisted tax calculation as a collection.

operationId: GetTaxCalculationsCalculationLineItems parameters: - in: path name: calculation required: true schema: maxLength: 5000 type: string style: simple - description: >- A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. in: query name: ending_before required: false schema: maxLength: 500 type: string style: form - description: Specifies which fields in the response should be expanded. explode: true in: query name: expand required: false schema: items: maxLength: 5000 type: string type: array style: deepObject - description: >- A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. in: query name: limit required: false schema: type: integer style: form - description: >- A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. in: query name: starting_after required: false schema: maxLength: 500 type: string style: form requestBody: content: application/x-www-form-urlencoded: encoding: {} schema: additionalProperties: false properties: {} type: object required: false responses: '200': content: application/json: schema: description: '' properties: data: description: Details about each object. items: $ref: '#/components/schemas/tax.calculation_line_item' type: array has_more: description: >- True if this list has another page of items after this one that can be fetched. type: boolean object: description: >- String representing the object's type. Objects of the same type share the same value. Always has the value `list`. enum: - list type: string url: description: The URL where this list can be accessed. maxLength: 5000 pattern: '^/v1/tax/calculations/[^/]+/line_items' type: string required: - data - has_more - object - url title: TaxProductResourceTaxCalculationLineItemList type: object x-expandableFields: - data description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. /v1/tax/registrations: get: description:

Returns a list of Tax Registration objects.

operationId: GetTaxRegistrations parameters: - description: >- A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. in: query name: ending_before required: false schema: maxLength: 5000 type: string style: form - description: Specifies which fields in the response should be expanded. explode: true in: query name: expand required: false schema: items: maxLength: 5000 type: string type: array style: deepObject - description: >- A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. in: query name: limit required: false schema: type: integer style: form - description: >- A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. in: query name: starting_after required: false schema: maxLength: 5000 type: string style: form - description: The status of the Tax Registration. in: query name: status required: false schema: enum: - active - all - expired - scheduled type: string style: form requestBody: content: application/x-www-form-urlencoded: encoding: {} schema: additionalProperties: false properties: {} type: object required: false responses: '200': content: application/json: schema: description: '' properties: data: items: $ref: '#/components/schemas/tax.registration' type: array has_more: description: >- True if this list has another page of items after this one that can be fetched. type: boolean object: description: >- String representing the object's type. Objects of the same type share the same value. Always has the value `list`. enum: - list type: string url: description: The URL where this list can be accessed. maxLength: 5000 pattern: ^/v1/tax/registrations type: string required: - data - has_more - object - url title: TaxProductRegistrationsResourceTaxRegistrationList type: object x-expandableFields: - data description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. post: description:

Creates a new Tax Registration object.

operationId: PostTaxRegistrations requestBody: content: application/x-www-form-urlencoded: encoding: active_from: explode: true style: deepObject country_options: explode: true style: deepObject expand: explode: true style: deepObject schema: additionalProperties: false properties: active_from: anyOf: - enum: - now maxLength: 5000 type: string - format: unix-time type: integer description: >- Time at which the Tax Registration becomes active. It can be either `now` to indicate the current time, or a future timestamp measured in seconds since the Unix epoch. country: description: >- Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)). maxLength: 5000 type: string country_options: description: >- Specific options for a registration in the specified `country`. properties: ae: properties: type: enum: - standard type: string required: - type title: default type: object at: properties: standard: properties: place_of_supply_scheme: enum: - small_seller - standard type: string required: - place_of_supply_scheme title: standard type: object type: enum: - ioss - oss_non_union - oss_union - standard type: string required: - type title: europe type: object au: properties: type: enum: - standard type: string required: - type title: default type: object be: properties: standard: properties: place_of_supply_scheme: enum: - small_seller - standard type: string required: - place_of_supply_scheme title: standard type: object type: enum: - ioss - oss_non_union - oss_union - standard type: string required: - type title: europe type: object bg: properties: standard: properties: place_of_supply_scheme: enum: - small_seller - standard type: string required: - place_of_supply_scheme title: standard type: object type: enum: - ioss - oss_non_union - oss_union - standard type: string required: - type title: europe type: object ca: properties: province_standard: properties: province: maxLength: 5000 type: string required: - province title: province_standard type: object type: enum: - province_standard - simplified - standard type: string required: - type title: canada type: object ch: properties: type: enum: - standard type: string required: - type title: default type: object cl: properties: type: enum: - simplified type: string required: - type title: simplified type: object co: properties: type: enum: - simplified type: string required: - type title: simplified type: object cy: properties: standard: properties: place_of_supply_scheme: enum: - small_seller - standard type: string required: - place_of_supply_scheme title: standard type: object type: enum: - ioss - oss_non_union - oss_union - standard type: string required: - type title: europe type: object cz: properties: standard: properties: place_of_supply_scheme: enum: - small_seller - standard type: string required: - place_of_supply_scheme title: standard type: object type: enum: - ioss - oss_non_union - oss_union - standard type: string required: - type title: europe type: object de: properties: standard: properties: place_of_supply_scheme: enum: - small_seller - standard type: string required: - place_of_supply_scheme title: standard type: object type: enum: - ioss - oss_non_union - oss_union - standard type: string required: - type title: europe type: object dk: properties: standard: properties: place_of_supply_scheme: enum: - small_seller - standard type: string required: - place_of_supply_scheme title: standard type: object type: enum: - ioss - oss_non_union - oss_union - standard type: string required: - type title: europe type: object ee: properties: standard: properties: place_of_supply_scheme: enum: - small_seller - standard type: string required: - place_of_supply_scheme title: standard type: object type: enum: - ioss - oss_non_union - oss_union - standard type: string required: - type title: europe type: object es: properties: standard: properties: place_of_supply_scheme: enum: - small_seller - standard type: string required: - place_of_supply_scheme title: standard type: object type: enum: - ioss - oss_non_union - oss_union - standard type: string required: - type title: europe type: object fi: properties: standard: properties: place_of_supply_scheme: enum: - small_seller - standard type: string required: - place_of_supply_scheme title: standard type: object type: enum: - ioss - oss_non_union - oss_union - standard type: string required: - type title: europe type: object fr: properties: standard: properties: place_of_supply_scheme: enum: - small_seller - standard type: string required: - place_of_supply_scheme title: standard type: object type: enum: - ioss - oss_non_union - oss_union - standard type: string required: - type title: europe type: object gb: properties: type: enum: - standard type: string required: - type title: default type: object gr: properties: standard: properties: place_of_supply_scheme: enum: - small_seller - standard type: string required: - place_of_supply_scheme title: standard type: object type: enum: - ioss - oss_non_union - oss_union - standard type: string required: - type title: europe type: object hr: properties: standard: properties: place_of_supply_scheme: enum: - small_seller - standard type: string required: - place_of_supply_scheme title: standard type: object type: enum: - ioss - oss_non_union - oss_union - standard type: string required: - type title: europe type: object hu: properties: standard: properties: place_of_supply_scheme: enum: - small_seller - standard type: string required: - place_of_supply_scheme title: standard type: object type: enum: - ioss - oss_non_union - oss_union - standard type: string required: - type title: europe type: object id: properties: type: enum: - simplified type: string required: - type title: simplified type: object ie: properties: standard: properties: place_of_supply_scheme: enum: - small_seller - standard type: string required: - place_of_supply_scheme title: standard type: object type: enum: - ioss - oss_non_union - oss_union - standard type: string required: - type title: europe type: object is: properties: type: enum: - standard type: string required: - type title: default type: object it: properties: standard: properties: place_of_supply_scheme: enum: - small_seller - standard type: string required: - place_of_supply_scheme title: standard type: object type: enum: - ioss - oss_non_union - oss_union - standard type: string required: - type title: europe type: object jp: properties: type: enum: - standard type: string required: - type title: default type: object kr: properties: type: enum: - simplified type: string required: - type title: simplified type: object lt: properties: standard: properties: place_of_supply_scheme: enum: - small_seller - standard type: string required: - place_of_supply_scheme title: standard type: object type: enum: - ioss - oss_non_union - oss_union - standard type: string required: - type title: europe type: object lu: properties: standard: properties: place_of_supply_scheme: enum: - small_seller - standard type: string required: - place_of_supply_scheme title: standard type: object type: enum: - ioss - oss_non_union - oss_union - standard type: string required: - type title: europe type: object lv: properties: standard: properties: place_of_supply_scheme: enum: - small_seller - standard type: string required: - place_of_supply_scheme title: standard type: object type: enum: - ioss - oss_non_union - oss_union - standard type: string required: - type title: europe type: object mt: properties: standard: properties: place_of_supply_scheme: enum: - small_seller - standard type: string required: - place_of_supply_scheme title: standard type: object type: enum: - ioss - oss_non_union - oss_union - standard type: string required: - type title: europe type: object mx: properties: type: enum: - simplified type: string required: - type title: simplified type: object my: properties: type: enum: - simplified type: string required: - type title: simplified type: object nl: properties: standard: properties: place_of_supply_scheme: enum: - small_seller - standard type: string required: - place_of_supply_scheme title: standard type: object type: enum: - ioss - oss_non_union - oss_union - standard type: string required: - type title: europe type: object 'no': properties: type: enum: - standard type: string required: - type title: default type: object nz: properties: type: enum: - standard type: string required: - type title: default type: object pl: properties: standard: properties: place_of_supply_scheme: enum: - small_seller - standard type: string required: - place_of_supply_scheme title: standard type: object type: enum: - ioss - oss_non_union - oss_union - standard type: string required: - type title: europe type: object pt: properties: standard: properties: place_of_supply_scheme: enum: - small_seller - standard type: string required: - place_of_supply_scheme title: standard type: object type: enum: - ioss - oss_non_union - oss_union - standard type: string required: - type title: europe type: object ro: properties: standard: properties: place_of_supply_scheme: enum: - small_seller - standard type: string required: - place_of_supply_scheme title: standard type: object type: enum: - ioss - oss_non_union - oss_union - standard type: string required: - type title: europe type: object sa: properties: type: enum: - simplified type: string required: - type title: simplified type: object se: properties: standard: properties: place_of_supply_scheme: enum: - small_seller - standard type: string required: - place_of_supply_scheme title: standard type: object type: enum: - ioss - oss_non_union - oss_union - standard type: string required: - type title: europe type: object sg: properties: type: enum: - standard type: string required: - type title: default type: object si: properties: standard: properties: place_of_supply_scheme: enum: - small_seller - standard type: string required: - place_of_supply_scheme title: standard type: object type: enum: - ioss - oss_non_union - oss_union - standard type: string required: - type title: europe type: object sk: properties: standard: properties: place_of_supply_scheme: enum: - small_seller - standard type: string required: - place_of_supply_scheme title: standard type: object type: enum: - ioss - oss_non_union - oss_union - standard type: string required: - type title: europe type: object th: properties: type: enum: - simplified type: string required: - type title: simplified type: object tr: properties: type: enum: - simplified type: string required: - type title: simplified type: object us: properties: local_amusement_tax: properties: jurisdiction: maxLength: 5000 type: string required: - jurisdiction title: local_amusement_tax type: object local_lease_tax: properties: jurisdiction: maxLength: 5000 type: string required: - jurisdiction title: local_lease_tax type: object state: maxLength: 5000 type: string type: enum: - local_amusement_tax - local_lease_tax - state_communications_tax - state_sales_tax type: string x-stripeBypassValidation: true required: - state - type title: united_states type: object vn: properties: type: enum: - simplified type: string required: - type title: simplified type: object za: properties: type: enum: - standard type: string required: - type title: default type: object title: country_options type: object expand: description: Specifies which fields in the response should be expanded. items: maxLength: 5000 type: string type: array expires_at: description: >- If set, the Tax Registration stops being active at this time. If not set, the Tax Registration will be active indefinitely. Timestamp measured in seconds since the Unix epoch. format: unix-time type: integer required: - active_from - country - country_options type: object required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/tax.registration' description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. '/v1/tax/registrations/{id}': get: description:

Returns a Tax Registration object.

operationId: GetTaxRegistrationsId parameters: - description: Specifies which fields in the response should be expanded. explode: true in: query name: expand required: false schema: items: maxLength: 5000 type: string type: array style: deepObject - in: path name: id required: true schema: maxLength: 5000 type: string style: simple requestBody: content: application/x-www-form-urlencoded: encoding: {} schema: additionalProperties: false properties: {} type: object required: false responses: '200': content: application/json: schema: $ref: '#/components/schemas/tax.registration' description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. post: description: >-

Updates an existing Tax Registration object.

A registration cannot be deleted after it has been created. If you wish to end a registration you may do so by setting expires_at.

operationId: PostTaxRegistrationsId parameters: - in: path name: id required: true schema: maxLength: 5000 type: string style: simple requestBody: content: application/x-www-form-urlencoded: encoding: active_from: explode: true style: deepObject expand: explode: true style: deepObject expires_at: explode: true style: deepObject schema: additionalProperties: false properties: active_from: anyOf: - enum: - now maxLength: 5000 type: string - format: unix-time type: integer description: >- Time at which the registration becomes active. It can be either `now` to indicate the current time, or a timestamp measured in seconds since the Unix epoch. expand: description: Specifies which fields in the response should be expanded. items: maxLength: 5000 type: string type: array expires_at: anyOf: - enum: - now maxLength: 5000 type: string - format: unix-time type: integer - enum: - '' type: string description: >- If set, the registration stops being active at this time. If not set, the registration will be active indefinitely. It can be either `now` to indicate the current time, or a timestamp measured in seconds since the Unix epoch. type: object required: false responses: '200': content: application/json: schema: $ref: '#/components/schemas/tax.registration' description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. /v1/tax/settings: get: description:

Retrieves Tax Settings for a merchant.

operationId: GetTaxSettings parameters: - description: Specifies which fields in the response should be expanded. explode: true in: query name: expand required: false schema: items: maxLength: 5000 type: string type: array style: deepObject requestBody: content: application/x-www-form-urlencoded: encoding: {} schema: additionalProperties: false properties: {} type: object required: false responses: '200': content: application/json: schema: $ref: '#/components/schemas/tax.settings' description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. post: description: >-

Updates Tax Settings parameters used in tax calculations. All parameters are editable but none can be removed once set.

operationId: PostTaxSettings requestBody: content: application/x-www-form-urlencoded: encoding: defaults: explode: true style: deepObject expand: explode: true style: deepObject head_office: explode: true style: deepObject schema: additionalProperties: false properties: defaults: description: Default configuration to be used on Stripe Tax calculations. properties: tax_behavior: enum: - exclusive - inclusive - inferred_by_currency type: string tax_code: type: string title: defaults_param type: object expand: description: Specifies which fields in the response should be expanded. items: maxLength: 5000 type: string type: array head_office: description: The place where your business is located. properties: address: properties: city: maxLength: 5000 type: string country: maxLength: 5000 type: string line1: maxLength: 5000 type: string line2: maxLength: 5000 type: string postal_code: maxLength: 5000 type: string state: maxLength: 5000 type: string title: validated_country_address type: object required: - address title: head_office_param type: object type: object required: false responses: '200': content: application/json: schema: $ref: '#/components/schemas/tax.settings' description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. /v1/tax/transactions/create_from_calculation: post: description:

Creates a Tax Transaction from a calculation.

operationId: PostTaxTransactionsCreateFromCalculation requestBody: content: application/x-www-form-urlencoded: encoding: expand: explode: true style: deepObject metadata: explode: true style: deepObject schema: additionalProperties: false properties: calculation: description: >- Tax Calculation ID to be used as input when creating the transaction. maxLength: 5000 type: string expand: description: Specifies which fields in the response should be expanded. items: maxLength: 5000 type: string type: array metadata: additionalProperties: type: string description: >- Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. type: object reference: description: >- A custom order or sale identifier, such as 'myOrder_123'. Must be unique across all transactions, including reversals. maxLength: 500 type: string required: - calculation - reference type: object required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/tax.transaction' description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. /v1/tax/transactions/create_reversal: post: description: >-

Partially or fully reverses a previously created Transaction.

operationId: PostTaxTransactionsCreateReversal requestBody: content: application/x-www-form-urlencoded: encoding: expand: explode: true style: deepObject line_items: explode: true style: deepObject metadata: explode: true style: deepObject shipping_cost: explode: true style: deepObject schema: additionalProperties: false properties: expand: description: Specifies which fields in the response should be expanded. items: maxLength: 5000 type: string type: array flat_amount: description: >- A flat amount to reverse across the entire transaction, in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal) in negative. This value represents the total amount to refund from the transaction, including taxes. type: integer line_items: description: The line item amounts to reverse. items: properties: amount: type: integer amount_tax: type: integer metadata: additionalProperties: type: string type: object original_line_item: maxLength: 5000 type: string quantity: type: integer reference: maxLength: 500 type: string required: - amount - amount_tax - original_line_item - reference title: transaction_line_item_reversal type: object type: array metadata: additionalProperties: type: string description: >- Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. type: object mode: description: >- If `partial`, the provided line item or shipping cost amounts are reversed. If `full`, the original transaction is fully reversed. enum: - full - partial type: string original_transaction: description: The ID of the Transaction to partially or fully reverse. maxLength: 5000 type: string reference: description: >- A custom identifier for this reversal, such as `myOrder_123-refund_1`, which must be unique across all transactions. The reference helps identify this reversal transaction in exported [tax reports](https://stripe.com/docs/tax/reports). maxLength: 500 type: string shipping_cost: description: The shipping cost to reverse. properties: amount: type: integer amount_tax: type: integer required: - amount - amount_tax title: transaction_shipping_cost_reversal type: object required: - mode - original_transaction - reference type: object required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/tax.transaction' description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. '/v1/tax/transactions/{transaction}': get: description:

Retrieves a Tax Transaction object.

operationId: GetTaxTransactionsTransaction parameters: - description: Specifies which fields in the response should be expanded. explode: true in: query name: expand required: false schema: items: maxLength: 5000 type: string type: array style: deepObject - in: path name: transaction required: true schema: maxLength: 5000 type: string style: simple requestBody: content: application/x-www-form-urlencoded: encoding: {} schema: additionalProperties: false properties: {} type: object required: false responses: '200': content: application/json: schema: $ref: '#/components/schemas/tax.transaction' description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. '/v1/tax/transactions/{transaction}/line_items': get: description: >-

Retrieves the line items of a committed standalone transaction as a collection.

operationId: GetTaxTransactionsTransactionLineItems parameters: - description: >- A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. in: query name: ending_before required: false schema: maxLength: 500 type: string style: form - description: Specifies which fields in the response should be expanded. explode: true in: query name: expand required: false schema: items: maxLength: 5000 type: string type: array style: deepObject - description: >- A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. in: query name: limit required: false schema: type: integer style: form - description: >- A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. in: query name: starting_after required: false schema: maxLength: 500 type: string style: form - in: path name: transaction required: true schema: maxLength: 5000 type: string style: simple requestBody: content: application/x-www-form-urlencoded: encoding: {} schema: additionalProperties: false properties: {} type: object required: false responses: '200': content: application/json: schema: description: '' properties: data: description: Details about each object. items: $ref: '#/components/schemas/tax.transaction_line_item' type: array has_more: description: >- True if this list has another page of items after this one that can be fetched. type: boolean object: description: >- String representing the object's type. Objects of the same type share the same value. Always has the value `list`. enum: - list type: string url: description: The URL where this list can be accessed. maxLength: 5000 pattern: '^/v1/tax/transactions/[^/]+/line_items' type: string required: - data - has_more - object - url title: TaxProductResourceTaxTransactionLineItemList type: object x-expandableFields: - data description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. /v1/tax_codes: get: description: >-

A list of all tax codes available to add to Products in order to allow specific tax calculations.

operationId: GetTaxCodes parameters: - description: >- A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. in: query name: ending_before required: false schema: type: string style: form - description: Specifies which fields in the response should be expanded. explode: true in: query name: expand required: false schema: items: maxLength: 5000 type: string type: array style: deepObject - description: >- A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. in: query name: limit required: false schema: type: integer style: form - description: >- A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. in: query name: starting_after required: false schema: type: string style: form requestBody: content: application/x-www-form-urlencoded: encoding: {} schema: additionalProperties: false properties: {} type: object required: false responses: '200': content: application/json: schema: description: '' properties: data: items: $ref: '#/components/schemas/tax_code' type: array has_more: description: >- True if this list has another page of items after this one that can be fetched. type: boolean object: description: >- String representing the object's type. Objects of the same type share the same value. Always has the value `list`. enum: - list type: string url: description: The URL where this list can be accessed. maxLength: 5000 type: string required: - data - has_more - object - url title: TaxProductResourceTaxCodeList type: object x-expandableFields: - data description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. '/v1/tax_codes/{id}': get: description: >-

Retrieves the details of an existing tax code. Supply the unique tax code ID and Stripe will return the corresponding tax code information.

operationId: GetTaxCodesId parameters: - description: Specifies which fields in the response should be expanded. explode: true in: query name: expand required: false schema: items: maxLength: 5000 type: string type: array style: deepObject - in: path name: id required: true schema: maxLength: 5000 type: string style: simple requestBody: content: application/x-www-form-urlencoded: encoding: {} schema: additionalProperties: false properties: {} type: object required: false responses: '200': content: application/json: schema: $ref: '#/components/schemas/tax_code' description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. /v1/tax_ids: get: description:

Returns a list of tax IDs.

operationId: GetTaxIds parameters: - description: >- A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. in: query name: ending_before required: false schema: maxLength: 5000 type: string style: form - description: Specifies which fields in the response should be expanded. explode: true in: query name: expand required: false schema: items: maxLength: 5000 type: string type: array style: deepObject - description: >- A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. in: query name: limit required: false schema: type: integer style: form - description: >- The account or customer the tax ID belongs to. Defaults to `owner[type]=self`. explode: true in: query name: owner required: false schema: properties: account: type: string customer: maxLength: 5000 type: string type: enum: - account - application - customer - self type: string required: - type title: owner_params type: object style: deepObject - description: >- A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. in: query name: starting_after required: false schema: maxLength: 5000 type: string style: form requestBody: content: application/x-www-form-urlencoded: encoding: {} schema: additionalProperties: false properties: {} type: object required: false responses: '200': content: application/json: schema: description: '' properties: data: description: Details about each object. items: $ref: '#/components/schemas/tax_id' type: array has_more: description: >- True if this list has another page of items after this one that can be fetched. type: boolean object: description: >- String representing the object's type. Objects of the same type share the same value. Always has the value `list`. enum: - list type: string url: description: The URL where this list can be accessed. maxLength: 5000 type: string required: - data - has_more - object - url title: TaxIDsList type: object x-expandableFields: - data description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. post: description:

Creates a new account or customer tax_id object.

operationId: PostTaxIds requestBody: content: application/x-www-form-urlencoded: encoding: expand: explode: true style: deepObject owner: explode: true style: deepObject schema: additionalProperties: false properties: expand: description: Specifies which fields in the response should be expanded. items: maxLength: 5000 type: string type: array owner: description: >- The account or customer the tax ID belongs to. Defaults to `owner[type]=self`. properties: account: type: string customer: maxLength: 5000 type: string type: enum: - account - application - customer - self type: string required: - type title: owner_params type: object type: description: >- Type of the tax ID, one of `ad_nrt`, `ae_trn`, `ar_cuit`, `au_abn`, `au_arn`, `bg_uic`, `bh_vat`, `bo_tin`, `br_cnpj`, `br_cpf`, `ca_bn`, `ca_gst_hst`, `ca_pst_bc`, `ca_pst_mb`, `ca_pst_sk`, `ca_qst`, `ch_vat`, `cl_tin`, `cn_tin`, `co_nit`, `cr_tin`, `do_rcn`, `ec_ruc`, `eg_tin`, `es_cif`, `eu_oss_vat`, `eu_vat`, `gb_vat`, `ge_vat`, `hk_br`, `hu_tin`, `id_npwp`, `il_vat`, `in_gst`, `is_vat`, `jp_cn`, `jp_rn`, `jp_trn`, `ke_pin`, `kr_brn`, `kz_bin`, `li_uid`, `mx_rfc`, `my_frp`, `my_itn`, `my_sst`, `ng_tin`, `no_vat`, `no_voec`, `nz_gst`, `om_vat`, `pe_ruc`, `ph_tin`, `ro_tin`, `rs_pib`, `ru_inn`, `ru_kpp`, `sa_vat`, `sg_gst`, `sg_uen`, `si_tin`, `sv_nit`, `th_vat`, `tr_tin`, `tw_vat`, `ua_vat`, `us_ein`, `uy_ruc`, `ve_rif`, `vn_tin`, or `za_vat` enum: - ad_nrt - ae_trn - ar_cuit - au_abn - au_arn - bg_uic - bh_vat - bo_tin - br_cnpj - br_cpf - ca_bn - ca_gst_hst - ca_pst_bc - ca_pst_mb - ca_pst_sk - ca_qst - ch_vat - cl_tin - cn_tin - co_nit - cr_tin - do_rcn - ec_ruc - eg_tin - es_cif - eu_oss_vat - eu_vat - gb_vat - ge_vat - hk_br - hu_tin - id_npwp - il_vat - in_gst - is_vat - jp_cn - jp_rn - jp_trn - ke_pin - kr_brn - kz_bin - li_uid - mx_rfc - my_frp - my_itn - my_sst - ng_tin - no_vat - no_voec - nz_gst - om_vat - pe_ruc - ph_tin - ro_tin - rs_pib - ru_inn - ru_kpp - sa_vat - sg_gst - sg_uen - si_tin - sv_nit - th_vat - tr_tin - tw_vat - ua_vat - us_ein - uy_ruc - ve_rif - vn_tin - za_vat maxLength: 5000 type: string x-stripeBypassValidation: true value: description: Value of the tax ID. type: string required: - type - value type: object required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/tax_id' description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. '/v1/tax_ids/{id}': delete: description: >-

Deletes an existing account or customer tax_id object.

operationId: DeleteTaxIdsId parameters: - in: path name: id required: true schema: maxLength: 5000 type: string style: simple requestBody: content: application/x-www-form-urlencoded: encoding: {} schema: additionalProperties: false properties: {} type: object required: false responses: '200': content: application/json: schema: $ref: '#/components/schemas/deleted_tax_id' description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. get: description:

Retrieves an account or customer tax_id object.

operationId: GetTaxIdsId parameters: - description: Specifies which fields in the response should be expanded. explode: true in: query name: expand required: false schema: items: maxLength: 5000 type: string type: array style: deepObject - in: path name: id required: true schema: maxLength: 5000 type: string style: simple requestBody: content: application/x-www-form-urlencoded: encoding: {} schema: additionalProperties: false properties: {} type: object required: false responses: '200': content: application/json: schema: $ref: '#/components/schemas/tax_id' description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. /v1/tax_rates: get: description: >-

Returns a list of your tax rates. Tax rates are returned sorted by creation date, with the most recently created tax rates appearing first.

operationId: GetTaxRates parameters: - description: >- Optional flag to filter by tax rates that are either active or inactive (archived). in: query name: active required: false schema: type: boolean style: form - description: Optional range for filtering created date. explode: true in: query name: created required: false schema: anyOf: - properties: gt: type: integer gte: type: integer lt: type: integer lte: type: integer title: range_query_specs type: object - type: integer style: deepObject - description: >- A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. in: query name: ending_before required: false schema: maxLength: 5000 type: string style: form - description: Specifies which fields in the response should be expanded. explode: true in: query name: expand required: false schema: items: maxLength: 5000 type: string type: array style: deepObject - description: >- Optional flag to filter by tax rates that are inclusive (or those that are not inclusive). in: query name: inclusive required: false schema: type: boolean style: form - description: >- A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. in: query name: limit required: false schema: type: integer style: form - description: >- A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. in: query name: starting_after required: false schema: maxLength: 5000 type: string style: form requestBody: content: application/x-www-form-urlencoded: encoding: {} schema: additionalProperties: false properties: {} type: object required: false responses: '200': content: application/json: schema: description: '' properties: data: items: $ref: '#/components/schemas/tax_rate' type: array has_more: description: >- True if this list has another page of items after this one that can be fetched. type: boolean object: description: >- String representing the object's type. Objects of the same type share the same value. Always has the value `list`. enum: - list type: string url: description: The URL where this list can be accessed. maxLength: 5000 pattern: ^/v1/tax_rates type: string required: - data - has_more - object - url title: TaxRatesList type: object x-expandableFields: - data description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. post: description:

Creates a new tax rate.

operationId: PostTaxRates requestBody: content: application/x-www-form-urlencoded: encoding: expand: explode: true style: deepObject metadata: explode: true style: deepObject schema: additionalProperties: false properties: active: description: >- Flag determining whether the tax rate is active or inactive (archived). Inactive tax rates cannot be used with new applications or Checkout Sessions, but will still work for subscriptions and invoices that already have it set. type: boolean country: description: >- Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)). maxLength: 5000 type: string description: description: >- An arbitrary string attached to the tax rate for your internal use only. It will not be visible to your customers. maxLength: 5000 type: string display_name: description: >- The display name of the tax rate, which will be shown to users. maxLength: 50 type: string expand: description: Specifies which fields in the response should be expanded. items: maxLength: 5000 type: string type: array inclusive: description: This specifies if the tax rate is inclusive or exclusive. type: boolean jurisdiction: description: >- The jurisdiction for the tax rate. You can use this label field for tax reporting purposes. It also appears on your customer’s invoice. maxLength: 50 type: string metadata: additionalProperties: type: string description: >- Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. type: object percentage: description: This represents the tax rate percent out of 100. type: number state: description: >- [ISO 3166-2 subdivision code](https://en.wikipedia.org/wiki/ISO_3166-2:US), without country prefix. For example, "NY" for New York, United States. maxLength: 2 type: string tax_type: description: 'The high-level tax type, such as `vat` or `sales_tax`.' enum: - amusement_tax - communications_tax - gst - hst - igst - jct - lease_tax - pst - qst - rst - sales_tax - vat type: string x-stripeBypassValidation: true required: - display_name - inclusive - percentage type: object required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/tax_rate' description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. '/v1/tax_rates/{tax_rate}': get: description:

Retrieves a tax rate with the given ID

operationId: GetTaxRatesTaxRate parameters: - description: Specifies which fields in the response should be expanded. explode: true in: query name: expand required: false schema: items: maxLength: 5000 type: string type: array style: deepObject - in: path name: tax_rate required: true schema: maxLength: 5000 type: string style: simple requestBody: content: application/x-www-form-urlencoded: encoding: {} schema: additionalProperties: false properties: {} type: object required: false responses: '200': content: application/json: schema: $ref: '#/components/schemas/tax_rate' description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. post: description:

Updates an existing tax rate.

operationId: PostTaxRatesTaxRate parameters: - in: path name: tax_rate required: true schema: maxLength: 5000 type: string style: simple requestBody: content: application/x-www-form-urlencoded: encoding: expand: explode: true style: deepObject metadata: explode: true style: deepObject schema: additionalProperties: false properties: active: description: >- Flag determining whether the tax rate is active or inactive (archived). Inactive tax rates cannot be used with new applications or Checkout Sessions, but will still work for subscriptions and invoices that already have it set. type: boolean country: description: >- Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)). maxLength: 5000 type: string description: description: >- An arbitrary string attached to the tax rate for your internal use only. It will not be visible to your customers. maxLength: 5000 type: string display_name: description: >- The display name of the tax rate, which will be shown to users. maxLength: 50 type: string expand: description: Specifies which fields in the response should be expanded. items: maxLength: 5000 type: string type: array jurisdiction: description: >- The jurisdiction for the tax rate. You can use this label field for tax reporting purposes. It also appears on your customer’s invoice. maxLength: 50 type: string metadata: anyOf: - additionalProperties: type: string type: object - enum: - '' type: string description: >- Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. state: description: >- [ISO 3166-2 subdivision code](https://en.wikipedia.org/wiki/ISO_3166-2:US), without country prefix. For example, "NY" for New York, United States. maxLength: 2 type: string tax_type: description: 'The high-level tax type, such as `vat` or `sales_tax`.' enum: - amusement_tax - communications_tax - gst - hst - igst - jct - lease_tax - pst - qst - rst - sales_tax - vat type: string x-stripeBypassValidation: true type: object required: false responses: '200': content: application/json: schema: $ref: '#/components/schemas/tax_rate' description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. /v1/terminal/configurations: get: description:

Returns a list of Configuration objects.

operationId: GetTerminalConfigurations parameters: - description: >- A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. in: query name: ending_before required: false schema: maxLength: 5000 type: string style: form - description: Specifies which fields in the response should be expanded. explode: true in: query name: expand required: false schema: items: maxLength: 5000 type: string type: array style: deepObject - description: >- if present, only return the account default or non-default configurations. in: query name: is_account_default required: false schema: type: boolean style: form - description: >- A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. in: query name: limit required: false schema: type: integer style: form - description: >- A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. in: query name: starting_after required: false schema: maxLength: 5000 type: string style: form requestBody: content: application/x-www-form-urlencoded: encoding: {} schema: additionalProperties: false properties: {} type: object required: false responses: '200': content: application/json: schema: description: '' properties: data: items: $ref: '#/components/schemas/terminal.configuration' type: array has_more: description: >- True if this list has another page of items after this one that can be fetched. type: boolean object: description: >- String representing the object's type. Objects of the same type share the same value. Always has the value `list`. enum: - list type: string url: description: The URL where this list can be accessed. maxLength: 5000 pattern: ^/v1/terminal/configurations type: string required: - data - has_more - object - url title: TerminalConfigurationConfigurationList type: object x-expandableFields: - data description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. post: description:

Creates a new Configuration object.

operationId: PostTerminalConfigurations requestBody: content: application/x-www-form-urlencoded: encoding: bbpos_wisepos_e: explode: true style: deepObject expand: explode: true style: deepObject offline: explode: true style: deepObject tipping: explode: true style: deepObject verifone_p400: explode: true style: deepObject schema: additionalProperties: false properties: bbpos_wisepos_e: description: >- An object containing device type specific settings for BBPOS WisePOS E readers properties: splashscreen: anyOf: - type: string - enum: - '' type: string title: bbpos_wise_pose type: object expand: description: Specifies which fields in the response should be expanded. items: maxLength: 5000 type: string type: array name: description: Name of the configuration maxLength: 100 type: string offline: anyOf: - properties: enabled: type: boolean required: - enabled title: offline type: object - enum: - '' type: string description: Configurations for collecting transactions offline. tipping: anyOf: - properties: aud: properties: fixed_amounts: items: type: integer type: array percentages: items: type: integer type: array smart_tip_threshold: type: integer title: currency_specific_config type: object cad: properties: fixed_amounts: items: type: integer type: array percentages: items: type: integer type: array smart_tip_threshold: type: integer title: currency_specific_config type: object chf: properties: fixed_amounts: items: type: integer type: array percentages: items: type: integer type: array smart_tip_threshold: type: integer title: currency_specific_config type: object czk: properties: fixed_amounts: items: type: integer type: array percentages: items: type: integer type: array smart_tip_threshold: type: integer title: currency_specific_config type: object dkk: properties: fixed_amounts: items: type: integer type: array percentages: items: type: integer type: array smart_tip_threshold: type: integer title: currency_specific_config type: object eur: properties: fixed_amounts: items: type: integer type: array percentages: items: type: integer type: array smart_tip_threshold: type: integer title: currency_specific_config type: object gbp: properties: fixed_amounts: items: type: integer type: array percentages: items: type: integer type: array smart_tip_threshold: type: integer title: currency_specific_config type: object hkd: properties: fixed_amounts: items: type: integer type: array percentages: items: type: integer type: array smart_tip_threshold: type: integer title: currency_specific_config type: object myr: properties: fixed_amounts: items: type: integer type: array percentages: items: type: integer type: array smart_tip_threshold: type: integer title: currency_specific_config type: object nok: properties: fixed_amounts: items: type: integer type: array percentages: items: type: integer type: array smart_tip_threshold: type: integer title: currency_specific_config type: object nzd: properties: fixed_amounts: items: type: integer type: array percentages: items: type: integer type: array smart_tip_threshold: type: integer title: currency_specific_config type: object sek: properties: fixed_amounts: items: type: integer type: array percentages: items: type: integer type: array smart_tip_threshold: type: integer title: currency_specific_config type: object sgd: properties: fixed_amounts: items: type: integer type: array percentages: items: type: integer type: array smart_tip_threshold: type: integer title: currency_specific_config type: object usd: properties: fixed_amounts: items: type: integer type: array percentages: items: type: integer type: array smart_tip_threshold: type: integer title: currency_specific_config type: object title: tipping type: object - enum: - '' type: string description: Tipping configurations for readers supporting on-reader tips verifone_p400: description: >- An object containing device type specific settings for Verifone P400 readers properties: splashscreen: anyOf: - type: string - enum: - '' type: string title: verifone_p400 type: object type: object required: false responses: '200': content: application/json: schema: $ref: '#/components/schemas/terminal.configuration' description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. '/v1/terminal/configurations/{configuration}': delete: description:

Deletes a Configuration object.

operationId: DeleteTerminalConfigurationsConfiguration parameters: - in: path name: configuration required: true schema: maxLength: 5000 type: string style: simple requestBody: content: application/x-www-form-urlencoded: encoding: {} schema: additionalProperties: false properties: {} type: object required: false responses: '200': content: application/json: schema: $ref: '#/components/schemas/deleted_terminal.configuration' description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. get: description:

Retrieves a Configuration object.

operationId: GetTerminalConfigurationsConfiguration parameters: - in: path name: configuration required: true schema: maxLength: 5000 type: string style: simple - description: Specifies which fields in the response should be expanded. explode: true in: query name: expand required: false schema: items: maxLength: 5000 type: string type: array style: deepObject requestBody: content: application/x-www-form-urlencoded: encoding: {} schema: additionalProperties: false properties: {} type: object required: false responses: '200': content: application/json: schema: anyOf: - $ref: '#/components/schemas/terminal.configuration' - $ref: '#/components/schemas/deleted_terminal.configuration' description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. post: description:

Updates a new Configuration object.

operationId: PostTerminalConfigurationsConfiguration parameters: - in: path name: configuration required: true schema: maxLength: 5000 type: string style: simple requestBody: content: application/x-www-form-urlencoded: encoding: bbpos_wisepos_e: explode: true style: deepObject expand: explode: true style: deepObject offline: explode: true style: deepObject tipping: explode: true style: deepObject verifone_p400: explode: true style: deepObject schema: additionalProperties: false properties: bbpos_wisepos_e: anyOf: - properties: splashscreen: anyOf: - type: string - enum: - '' type: string title: bbpos_wise_pose type: object - enum: - '' type: string description: >- An object containing device type specific settings for BBPOS WisePOS E readers expand: description: Specifies which fields in the response should be expanded. items: maxLength: 5000 type: string type: array name: description: Name of the configuration maxLength: 100 type: string offline: anyOf: - properties: enabled: type: boolean required: - enabled title: offline type: object - enum: - '' type: string description: Configurations for collecting transactions offline. tipping: anyOf: - properties: aud: properties: fixed_amounts: items: type: integer type: array percentages: items: type: integer type: array smart_tip_threshold: type: integer title: currency_specific_config type: object cad: properties: fixed_amounts: items: type: integer type: array percentages: items: type: integer type: array smart_tip_threshold: type: integer title: currency_specific_config type: object chf: properties: fixed_amounts: items: type: integer type: array percentages: items: type: integer type: array smart_tip_threshold: type: integer title: currency_specific_config type: object czk: properties: fixed_amounts: items: type: integer type: array percentages: items: type: integer type: array smart_tip_threshold: type: integer title: currency_specific_config type: object dkk: properties: fixed_amounts: items: type: integer type: array percentages: items: type: integer type: array smart_tip_threshold: type: integer title: currency_specific_config type: object eur: properties: fixed_amounts: items: type: integer type: array percentages: items: type: integer type: array smart_tip_threshold: type: integer title: currency_specific_config type: object gbp: properties: fixed_amounts: items: type: integer type: array percentages: items: type: integer type: array smart_tip_threshold: type: integer title: currency_specific_config type: object hkd: properties: fixed_amounts: items: type: integer type: array percentages: items: type: integer type: array smart_tip_threshold: type: integer title: currency_specific_config type: object myr: properties: fixed_amounts: items: type: integer type: array percentages: items: type: integer type: array smart_tip_threshold: type: integer title: currency_specific_config type: object nok: properties: fixed_amounts: items: type: integer type: array percentages: items: type: integer type: array smart_tip_threshold: type: integer title: currency_specific_config type: object nzd: properties: fixed_amounts: items: type: integer type: array percentages: items: type: integer type: array smart_tip_threshold: type: integer title: currency_specific_config type: object sek: properties: fixed_amounts: items: type: integer type: array percentages: items: type: integer type: array smart_tip_threshold: type: integer title: currency_specific_config type: object sgd: properties: fixed_amounts: items: type: integer type: array percentages: items: type: integer type: array smart_tip_threshold: type: integer title: currency_specific_config type: object usd: properties: fixed_amounts: items: type: integer type: array percentages: items: type: integer type: array smart_tip_threshold: type: integer title: currency_specific_config type: object title: tipping type: object - enum: - '' type: string description: Tipping configurations for readers supporting on-reader tips verifone_p400: anyOf: - properties: splashscreen: anyOf: - type: string - enum: - '' type: string title: verifone_p400 type: object - enum: - '' type: string description: >- An object containing device type specific settings for Verifone P400 readers type: object required: false responses: '200': content: application/json: schema: anyOf: - $ref: '#/components/schemas/terminal.configuration' - $ref: '#/components/schemas/deleted_terminal.configuration' description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. /v1/terminal/connection_tokens: post: description: >-

To connect to a reader the Stripe Terminal SDK needs to retrieve a short-lived connection token from Stripe, proxied through your server. On your backend, add an endpoint that creates and returns a connection token.

operationId: PostTerminalConnectionTokens requestBody: content: application/x-www-form-urlencoded: encoding: expand: explode: true style: deepObject schema: additionalProperties: false properties: expand: description: Specifies which fields in the response should be expanded. items: maxLength: 5000 type: string type: array location: description: >- The id of the location that this connection token is scoped to. If specified the connection token will only be usable with readers assigned to that location, otherwise the connection token will be usable with all readers. Note that location scoping only applies to internet-connected readers. For more details, see [the docs on scoping connection tokens](https://stripe.com/docs/terminal/fleet/locations#connection-tokens). maxLength: 5000 type: string type: object required: false responses: '200': content: application/json: schema: $ref: '#/components/schemas/terminal.connection_token' description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. /v1/terminal/locations: get: description:

Returns a list of Location objects.

operationId: GetTerminalLocations parameters: - description: >- A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. in: query name: ending_before required: false schema: maxLength: 5000 type: string style: form - description: Specifies which fields in the response should be expanded. explode: true in: query name: expand required: false schema: items: maxLength: 5000 type: string type: array style: deepObject - description: >- A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. in: query name: limit required: false schema: type: integer style: form - description: >- A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. in: query name: starting_after required: false schema: maxLength: 5000 type: string style: form requestBody: content: application/x-www-form-urlencoded: encoding: {} schema: additionalProperties: false properties: {} type: object required: false responses: '200': content: application/json: schema: description: '' properties: data: items: $ref: '#/components/schemas/terminal.location' type: array has_more: description: >- True if this list has another page of items after this one that can be fetched. type: boolean object: description: >- String representing the object's type. Objects of the same type share the same value. Always has the value `list`. enum: - list type: string url: description: The URL where this list can be accessed. maxLength: 5000 pattern: ^/v1/terminal/locations type: string required: - data - has_more - object - url title: TerminalLocationLocationList type: object x-expandableFields: - data description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. post: description: >-

Creates a new Location object. For further details, including which address fields are required in each country, see the Manage locations guide.

operationId: PostTerminalLocations requestBody: content: application/x-www-form-urlencoded: encoding: address: explode: true style: deepObject expand: explode: true style: deepObject metadata: explode: true style: deepObject schema: additionalProperties: false properties: address: description: The full address of the location. properties: city: maxLength: 5000 type: string country: maxLength: 5000 type: string line1: maxLength: 5000 type: string line2: maxLength: 5000 type: string postal_code: maxLength: 5000 type: string state: maxLength: 5000 type: string required: - country title: create_location_address_param type: object configuration_overrides: description: >- The ID of a configuration that will be used to customize all readers in this location. maxLength: 1000 type: string display_name: description: A name for the location. maxLength: 1000 type: string expand: description: Specifies which fields in the response should be expanded. items: maxLength: 5000 type: string type: array metadata: anyOf: - additionalProperties: type: string type: object - enum: - '' type: string description: >- Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. required: - address - display_name type: object required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/terminal.location' description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. '/v1/terminal/locations/{location}': delete: description:

Deletes a Location object.

operationId: DeleteTerminalLocationsLocation parameters: - in: path name: location required: true schema: maxLength: 5000 type: string style: simple requestBody: content: application/x-www-form-urlencoded: encoding: {} schema: additionalProperties: false properties: {} type: object required: false responses: '200': content: application/json: schema: $ref: '#/components/schemas/deleted_terminal.location' description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. get: description:

Retrieves a Location object.

operationId: GetTerminalLocationsLocation parameters: - description: Specifies which fields in the response should be expanded. explode: true in: query name: expand required: false schema: items: maxLength: 5000 type: string type: array style: deepObject - in: path name: location required: true schema: maxLength: 5000 type: string style: simple requestBody: content: application/x-www-form-urlencoded: encoding: {} schema: additionalProperties: false properties: {} type: object required: false responses: '200': content: application/json: schema: anyOf: - $ref: '#/components/schemas/terminal.location' - $ref: '#/components/schemas/deleted_terminal.location' description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. post: description: >-

Updates a Location object by setting the values of the parameters passed. Any parameters not provided will be left unchanged.

operationId: PostTerminalLocationsLocation parameters: - in: path name: location required: true schema: maxLength: 5000 type: string style: simple requestBody: content: application/x-www-form-urlencoded: encoding: address: explode: true style: deepObject configuration_overrides: explode: true style: deepObject expand: explode: true style: deepObject metadata: explode: true style: deepObject schema: additionalProperties: false properties: address: description: The full address of the location. properties: city: maxLength: 5000 type: string country: maxLength: 5000 type: string line1: maxLength: 5000 type: string line2: maxLength: 5000 type: string postal_code: maxLength: 5000 type: string state: maxLength: 5000 type: string title: optional_fields_address type: object configuration_overrides: anyOf: - maxLength: 1000 type: string - enum: - '' type: string description: >- The ID of a configuration that will be used to customize all readers in this location. display_name: description: A name for the location. maxLength: 1000 type: string expand: description: Specifies which fields in the response should be expanded. items: maxLength: 5000 type: string type: array metadata: anyOf: - additionalProperties: type: string type: object - enum: - '' type: string description: >- Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. type: object required: false responses: '200': content: application/json: schema: anyOf: - $ref: '#/components/schemas/terminal.location' - $ref: '#/components/schemas/deleted_terminal.location' description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. /v1/terminal/readers: get: description:

Returns a list of Reader objects.

operationId: GetTerminalReaders parameters: - description: Filters readers by device type in: query name: device_type required: false schema: enum: - bbpos_chipper2x - bbpos_wisepad3 - bbpos_wisepos_e - mobile_phone_reader - simulated_wisepos_e - stripe_m2 - verifone_P400 type: string x-stripeBypassValidation: true style: form - description: >- A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. in: query name: ending_before required: false schema: maxLength: 5000 type: string style: form - description: Specifies which fields in the response should be expanded. explode: true in: query name: expand required: false schema: items: maxLength: 5000 type: string type: array style: deepObject - description: >- A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. in: query name: limit required: false schema: type: integer style: form - description: >- A location ID to filter the response list to only readers at the specific location in: query name: location required: false schema: maxLength: 5000 type: string style: form - description: Filters readers by serial number in: query name: serial_number required: false schema: maxLength: 5000 type: string style: form - description: >- A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. in: query name: starting_after required: false schema: maxLength: 5000 type: string style: form - description: A status filter to filter readers to only offline or online readers in: query name: status required: false schema: enum: - offline - online type: string style: form requestBody: content: application/x-www-form-urlencoded: encoding: {} schema: additionalProperties: false properties: {} type: object required: false responses: '200': content: application/json: schema: description: '' properties: data: description: A list of readers items: $ref: '#/components/schemas/terminal.reader' type: array has_more: description: >- True if this list has another page of items after this one that can be fetched. type: boolean object: description: >- String representing the object's type. Objects of the same type share the same value. Always has the value `list`. enum: - list type: string url: description: The URL where this list can be accessed. maxLength: 5000 type: string required: - data - has_more - object - url title: TerminalReaderRetrieveReader type: object x-expandableFields: - data description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. post: description:

Creates a new Reader object.

operationId: PostTerminalReaders requestBody: content: application/x-www-form-urlencoded: encoding: expand: explode: true style: deepObject metadata: explode: true style: deepObject schema: additionalProperties: false properties: expand: description: Specifies which fields in the response should be expanded. items: maxLength: 5000 type: string type: array label: description: >- Custom label given to the reader for easier identification. If no label is specified, the registration code will be used. maxLength: 5000 type: string location: description: The location to assign the reader to. maxLength: 5000 type: string metadata: anyOf: - additionalProperties: type: string type: object - enum: - '' type: string description: >- Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. registration_code: description: >- A code generated by the reader used for registering to an account. maxLength: 5000 type: string required: - registration_code type: object required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/terminal.reader' description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. '/v1/terminal/readers/{reader}': delete: description:

Deletes a Reader object.

operationId: DeleteTerminalReadersReader parameters: - in: path name: reader required: true schema: maxLength: 5000 type: string style: simple requestBody: content: application/x-www-form-urlencoded: encoding: {} schema: additionalProperties: false properties: {} type: object required: false responses: '200': content: application/json: schema: $ref: '#/components/schemas/deleted_terminal.reader' description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. get: description:

Retrieves a Reader object.

operationId: GetTerminalReadersReader parameters: - description: Specifies which fields in the response should be expanded. explode: true in: query name: expand required: false schema: items: maxLength: 5000 type: string type: array style: deepObject - in: path name: reader required: true schema: maxLength: 5000 type: string style: simple requestBody: content: application/x-www-form-urlencoded: encoding: {} schema: additionalProperties: false properties: {} type: object required: false responses: '200': content: application/json: schema: anyOf: - $ref: '#/components/schemas/terminal.reader' - $ref: '#/components/schemas/deleted_terminal.reader' description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. post: description: >-

Updates a Reader object by setting the values of the parameters passed. Any parameters not provided will be left unchanged.

operationId: PostTerminalReadersReader parameters: - in: path name: reader required: true schema: maxLength: 5000 type: string style: simple requestBody: content: application/x-www-form-urlencoded: encoding: expand: explode: true style: deepObject label: explode: true style: deepObject metadata: explode: true style: deepObject schema: additionalProperties: false properties: expand: description: Specifies which fields in the response should be expanded. items: maxLength: 5000 type: string type: array label: anyOf: - maxLength: 5000 type: string - enum: - '' type: string description: The new label of the reader. metadata: anyOf: - additionalProperties: type: string type: object - enum: - '' type: string description: >- Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. type: object required: false responses: '200': content: application/json: schema: anyOf: - $ref: '#/components/schemas/terminal.reader' - $ref: '#/components/schemas/deleted_terminal.reader' description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. '/v1/terminal/readers/{reader}/cancel_action': post: description:

Cancels the current reader action.

operationId: PostTerminalReadersReaderCancelAction parameters: - in: path name: reader required: true schema: maxLength: 5000 type: string style: simple requestBody: content: application/x-www-form-urlencoded: encoding: expand: explode: true style: deepObject schema: additionalProperties: false properties: expand: description: Specifies which fields in the response should be expanded. items: maxLength: 5000 type: string type: array type: object required: false responses: '200': content: application/json: schema: $ref: '#/components/schemas/terminal.reader' description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. '/v1/terminal/readers/{reader}/process_payment_intent': post: description:

Initiates a payment flow on a Reader.

operationId: PostTerminalReadersReaderProcessPaymentIntent parameters: - in: path name: reader required: true schema: maxLength: 5000 type: string style: simple requestBody: content: application/x-www-form-urlencoded: encoding: expand: explode: true style: deepObject process_config: explode: true style: deepObject schema: additionalProperties: false properties: expand: description: Specifies which fields in the response should be expanded. items: maxLength: 5000 type: string type: array payment_intent: description: PaymentIntent ID maxLength: 5000 type: string process_config: description: Configuration overrides properties: enable_customer_cancellation: type: boolean skip_tipping: type: boolean tipping: properties: amount_eligible: type: integer title: tipping_config type: object title: process_config type: object required: - payment_intent type: object required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/terminal.reader' description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. '/v1/terminal/readers/{reader}/process_setup_intent': post: description:

Initiates a setup intent flow on a Reader.

operationId: PostTerminalReadersReaderProcessSetupIntent parameters: - in: path name: reader required: true schema: maxLength: 5000 type: string style: simple requestBody: content: application/x-www-form-urlencoded: encoding: expand: explode: true style: deepObject process_config: explode: true style: deepObject schema: additionalProperties: false properties: customer_consent_collected: description: Customer Consent Collected type: boolean expand: description: Specifies which fields in the response should be expanded. items: maxLength: 5000 type: string type: array process_config: description: Configuration overrides properties: enable_customer_cancellation: type: boolean title: process_setup_config type: object setup_intent: description: SetupIntent ID maxLength: 5000 type: string required: - customer_consent_collected - setup_intent type: object required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/terminal.reader' description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. '/v1/terminal/readers/{reader}/refund_payment': post: description:

Initiates a refund on a Reader

operationId: PostTerminalReadersReaderRefundPayment parameters: - in: path name: reader required: true schema: maxLength: 5000 type: string style: simple requestBody: content: application/x-www-form-urlencoded: encoding: expand: explode: true style: deepObject metadata: explode: true style: deepObject refund_payment_config: explode: true style: deepObject schema: additionalProperties: false properties: amount: description: >- A positive integer in __cents__ representing how much of this charge to refund. type: integer charge: description: ID of the Charge to refund. maxLength: 5000 type: string expand: description: Specifies which fields in the response should be expanded. items: maxLength: 5000 type: string type: array metadata: additionalProperties: type: string description: >- Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. type: object payment_intent: description: ID of the PaymentIntent to refund. maxLength: 5000 type: string refund_application_fee: description: >- Boolean indicating whether the application fee should be refunded when refunding this charge. If a full charge refund is given, the full application fee will be refunded. Otherwise, the application fee will be refunded in an amount proportional to the amount of the charge refunded. An application fee can be refunded only by the application that created the charge. type: boolean refund_payment_config: description: Configuration overrides properties: enable_customer_cancellation: type: boolean title: refund_payment_config type: object reverse_transfer: description: >- Boolean indicating whether the transfer should be reversed when refunding this charge. The transfer will be reversed proportionally to the amount being refunded (either the entire or partial amount). A transfer can be reversed only by the application that created the charge. type: boolean type: object required: false responses: '200': content: application/json: schema: $ref: '#/components/schemas/terminal.reader' description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. '/v1/terminal/readers/{reader}/set_reader_display': post: description:

Sets reader display to show cart details.

operationId: PostTerminalReadersReaderSetReaderDisplay parameters: - in: path name: reader required: true schema: maxLength: 5000 type: string style: simple requestBody: content: application/x-www-form-urlencoded: encoding: cart: explode: true style: deepObject expand: explode: true style: deepObject schema: additionalProperties: false properties: cart: description: Cart properties: currency: type: string line_items: items: properties: amount: type: integer description: maxLength: 5000 type: string quantity: type: integer required: - amount - description - quantity title: line_item type: object type: array tax: type: integer total: type: integer required: - currency - line_items - total title: cart type: object expand: description: Specifies which fields in the response should be expanded. items: maxLength: 5000 type: string type: array type: description: Type enum: - cart type: string required: - type type: object required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/terminal.reader' description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. /v1/test_helpers/confirmation_tokens: post: description: >-

Creates a test mode Confirmation Token server side for your integration tests.

operationId: PostTestHelpersConfirmationTokens requestBody: content: application/x-www-form-urlencoded: encoding: expand: explode: true style: deepObject payment_method_data: explode: true style: deepObject shipping: explode: true style: deepObject schema: additionalProperties: false properties: expand: description: Specifies which fields in the response should be expanded. items: maxLength: 5000 type: string type: array payment_method: description: ID of an existing PaymentMethod. maxLength: 5000 type: string payment_method_data: description: >- If provided, this hash will be used to create a PaymentMethod. properties: acss_debit: properties: account_number: maxLength: 5000 type: string institution_number: maxLength: 5000 type: string transit_number: maxLength: 5000 type: string required: - account_number - institution_number - transit_number title: payment_method_param type: object affirm: properties: {} title: param type: object afterpay_clearpay: properties: {} title: param type: object alipay: properties: {} title: param type: object allow_redisplay: enum: - always - limited - unspecified type: string amazon_pay: properties: {} title: param type: object au_becs_debit: properties: account_number: maxLength: 5000 type: string bsb_number: maxLength: 5000 type: string required: - account_number - bsb_number title: param type: object bacs_debit: properties: account_number: maxLength: 5000 type: string sort_code: maxLength: 5000 type: string title: param type: object bancontact: properties: {} title: param type: object billing_details: properties: address: anyOf: - properties: city: maxLength: 5000 type: string country: maxLength: 5000 type: string line1: maxLength: 5000 type: string line2: maxLength: 5000 type: string postal_code: maxLength: 5000 type: string state: maxLength: 5000 type: string title: billing_details_address type: object - enum: - '' type: string email: anyOf: - type: string - enum: - '' type: string name: anyOf: - maxLength: 5000 type: string - enum: - '' type: string phone: anyOf: - maxLength: 5000 type: string - enum: - '' type: string title: billing_details_inner_params type: object blik: properties: {} title: param type: object boleto: properties: tax_id: maxLength: 5000 type: string required: - tax_id title: param type: object cashapp: properties: {} title: param type: object customer_balance: properties: {} title: param type: object eps: properties: bank: enum: - 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 maxLength: 5000 type: string title: param type: object fpx: properties: bank: enum: - 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 maxLength: 5000 type: string x-stripeBypassValidation: true required: - bank title: param type: object giropay: properties: {} title: param type: object grabpay: properties: {} title: param type: object ideal: properties: bank: enum: - abn_amro - asn_bank - bunq - handelsbanken - ing - knab - moneyou - n26 - nn - rabobank - regiobank - revolut - sns_bank - triodos_bank - van_lanschot - yoursafe maxLength: 5000 type: string title: param type: object interac_present: properties: {} title: param type: object klarna: properties: dob: properties: day: type: integer month: type: integer year: type: integer required: - day - month - year title: date_of_birth type: object title: param type: object konbini: properties: {} title: param type: object link: properties: {} title: param type: object metadata: additionalProperties: type: string type: object mobilepay: properties: {} title: param type: object oxxo: properties: {} title: param type: object p24: properties: bank: enum: - 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 type: string x-stripeBypassValidation: true title: param type: object paynow: properties: {} title: param type: object paypal: properties: {} title: param type: object pix: properties: {} title: param type: object promptpay: properties: {} title: param type: object radar_options: properties: session: maxLength: 5000 type: string title: radar_options_with_hidden_options type: object revolut_pay: properties: {} title: param type: object sepa_debit: properties: iban: maxLength: 5000 type: string required: - iban title: param type: object sofort: properties: country: enum: - AT - BE - DE - ES - IT - NL type: string required: - country title: param type: object swish: properties: {} title: param type: object type: enum: - acss_debit - affirm - afterpay_clearpay - alipay - amazon_pay - au_becs_debit - bacs_debit - bancontact - blik - boleto - cashapp - customer_balance - eps - fpx - giropay - grabpay - ideal - klarna - konbini - link - mobilepay - oxxo - p24 - paynow - paypal - pix - promptpay - revolut_pay - sepa_debit - sofort - swish - us_bank_account - wechat_pay - zip type: string x-stripeBypassValidation: true us_bank_account: properties: account_holder_type: enum: - company - individual type: string account_number: maxLength: 5000 type: string account_type: enum: - checking - savings type: string financial_connections_account: maxLength: 5000 type: string routing_number: maxLength: 5000 type: string title: payment_method_param type: object wechat_pay: properties: {} title: param type: object zip: properties: {} title: param type: object required: - type title: payment_method_data_params type: object return_url: description: Return URL used to confirm the Intent. type: string setup_future_usage: description: >- Indicates that you intend to make future payments with this ConfirmationToken's payment method. The presence of this property will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. enum: - off_session - on_session type: string shipping: description: Shipping information for this ConfirmationToken. properties: address: properties: city: maxLength: 5000 type: string country: maxLength: 5000 type: string line1: maxLength: 5000 type: string line2: maxLength: 5000 type: string postal_code: maxLength: 5000 type: string state: maxLength: 5000 type: string title: optional_fields_address type: object name: maxLength: 5000 type: string phone: anyOf: - maxLength: 5000 type: string - enum: - '' type: string required: - address - name title: recipient_shipping_with_optional_fields_address type: object type: object required: false responses: '200': content: application/json: schema: $ref: '#/components/schemas/confirmation_token' description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. '/v1/test_helpers/customers/{customer}/fund_cash_balance': post: description:

Create an incoming testmode bank transfer

operationId: PostTestHelpersCustomersCustomerFundCashBalance parameters: - in: path name: customer required: true schema: maxLength: 5000 type: string style: simple requestBody: content: application/x-www-form-urlencoded: encoding: expand: explode: true style: deepObject schema: additionalProperties: false properties: amount: description: >- Amount to be used for this test cash balance transaction. A positive integer representing how much to fund in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal) (e.g., 100 cents to fund $1.00 or 100 to fund ¥100, a zero-decimal currency). type: integer currency: description: >- 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). type: string expand: description: Specifies which fields in the response should be expanded. items: maxLength: 5000 type: string type: array reference: description: >- A description of the test funding. This simulates free-text references supplied by customers when making bank transfers to their cash balance. You can use this to test how Stripe's [reconciliation algorithm](https://stripe.com/docs/payments/customer-balance/reconciliation) applies to different user inputs. maxLength: 5000 type: string required: - amount - currency type: object required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/customer_cash_balance_transaction' description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. /v1/test_helpers/issuing/authorizations: post: description:

Create a test-mode authorization.

operationId: PostTestHelpersIssuingAuthorizations requestBody: content: application/x-www-form-urlencoded: encoding: amount_details: explode: true style: deepObject expand: explode: true style: deepObject merchant_data: explode: true style: deepObject network_data: explode: true style: deepObject verification_data: explode: true style: deepObject schema: additionalProperties: false properties: amount: description: >- The total amount to attempt to authorize. This amount is in the provided currency, or defaults to the card's currency, and in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). type: integer amount_details: description: >- Detailed breakdown of amount components. These amounts are denominated in `currency` and in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). properties: atm_fee: type: integer cashback_amount: type: integer title: amount_details_specs type: object authorization_method: description: How the card details were provided. Defaults to online. enum: - chip - contactless - keyed_in - online - swipe type: string card: description: Card associated with this authorization. maxLength: 5000 type: string currency: description: >- The currency of the authorization. If not provided, defaults to the currency of the card. 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). type: string expand: description: Specifies which fields in the response should be expanded. items: maxLength: 5000 type: string type: array is_amount_controllable: description: >- If set `true`, you may provide [amount](https://stripe.com/docs/api/issuing/authorizations/approve#approve_issuing_authorization-amount) to control how much to hold for the authorization. type: boolean merchant_data: description: >- Details about the seller (grocery store, e-commerce website, etc.) where the card authorization happened. properties: category: enum: - ac_refrigeration_repair - accounting_bookkeeping_services - advertising_services - agricultural_cooperative - airlines_air_carriers - airports_flying_fields - ambulance_services - amusement_parks_carnivals - antique_reproductions - antique_shops - aquariums - architectural_surveying_services - art_dealers_and_galleries - artists_supply_and_craft_shops - auto_and_home_supply_stores - auto_body_repair_shops - auto_paint_shops - auto_service_shops - automated_cash_disburse - automated_fuel_dispensers - automobile_associations - automotive_parts_and_accessories_stores - automotive_tire_stores - bail_and_bond_payments - bakeries - bands_orchestras - barber_and_beauty_shops - betting_casino_gambling - bicycle_shops - billiard_pool_establishments - boat_dealers - boat_rentals_and_leases - book_stores - books_periodicals_and_newspapers - bowling_alleys - bus_lines - business_secretarial_schools - buying_shopping_services - cable_satellite_and_other_pay_television_and_radio - camera_and_photographic_supply_stores - candy_nut_and_confectionery_stores - car_and_truck_dealers_new_used - car_and_truck_dealers_used_only - car_rental_agencies - car_washes - carpentry_services - carpet_upholstery_cleaning - caterers - >- charitable_and_social_service_organizations_fundraising - chemicals_and_allied_products - child_care_services - childrens_and_infants_wear_stores - chiropodists_podiatrists - chiropractors - cigar_stores_and_stands - civic_social_fraternal_associations - cleaning_and_maintenance - clothing_rental - colleges_universities - commercial_equipment - commercial_footwear - commercial_photography_art_and_graphics - commuter_transport_and_ferries - computer_network_services - computer_programming - computer_repair - computer_software_stores - computers_peripherals_and_software - concrete_work_services - construction_materials - consulting_public_relations - correspondence_schools - cosmetic_stores - counseling_services - country_clubs - courier_services - court_costs - credit_reporting_agencies - cruise_lines - dairy_products_stores - dance_hall_studios_schools - dating_escort_services - dentists_orthodontists - department_stores - detective_agencies - digital_goods_applications - digital_goods_games - digital_goods_large_volume - digital_goods_media - direct_marketing_catalog_merchant - >- direct_marketing_combination_catalog_and_retail_merchant - direct_marketing_inbound_telemarketing - direct_marketing_insurance_services - direct_marketing_other - direct_marketing_outbound_telemarketing - direct_marketing_subscription - direct_marketing_travel - discount_stores - doctors - door_to_door_sales - drapery_window_covering_and_upholstery_stores - drinking_places - drug_stores_and_pharmacies - drugs_drug_proprietaries_and_druggist_sundries - dry_cleaners - durable_goods - duty_free_stores - eating_places_restaurants - educational_services - electric_razor_stores - electric_vehicle_charging - electrical_parts_and_equipment - electrical_services - electronics_repair_shops - electronics_stores - elementary_secondary_schools - emergency_services_gcas_visa_use_only - employment_temp_agencies - equipment_rental - exterminating_services - family_clothing_stores - fast_food_restaurants - financial_institutions - fines_government_administrative_entities - fireplace_fireplace_screens_and_accessories_stores - floor_covering_stores - florists - florists_supplies_nursery_stock_and_flowers - freezer_and_locker_meat_provisioners - fuel_dealers_non_automotive - funeral_services_crematories - >- furniture_home_furnishings_and_equipment_stores_except_appliances - furniture_repair_refinishing - furriers_and_fur_shops - general_services - gift_card_novelty_and_souvenir_shops - glass_paint_and_wallpaper_stores - glassware_crystal_stores - golf_courses_public - government_licensed_horse_dog_racing_us_region_only - >- government_licensed_online_casions_online_gambling_us_region_only - government_owned_lotteries_non_us_region - government_owned_lotteries_us_region_only - government_services - grocery_stores_supermarkets - hardware_equipment_and_supplies - hardware_stores - health_and_beauty_spas - hearing_aids_sales_and_supplies - heating_plumbing_a_c - hobby_toy_and_game_shops - home_supply_warehouse_stores - hospitals - hotels_motels_and_resorts - household_appliance_stores - industrial_supplies - information_retrieval_services - insurance_default - insurance_underwriting_premiums - intra_company_purchases - jewelry_stores_watches_clocks_and_silverware_stores - landscaping_services - laundries - laundry_cleaning_services - legal_services_attorneys - luggage_and_leather_goods_stores - lumber_building_materials_stores - manual_cash_disburse - marinas_service_and_supplies - marketplaces - masonry_stonework_and_plaster - massage_parlors - medical_and_dental_labs - >- medical_dental_ophthalmic_and_hospital_equipment_and_supplies - medical_services - membership_organizations - mens_and_boys_clothing_and_accessories_stores - mens_womens_clothing_stores - metal_service_centers - miscellaneous_apparel_and_accessory_shops - miscellaneous_auto_dealers - miscellaneous_business_services - miscellaneous_food_stores - miscellaneous_general_merchandise - miscellaneous_general_services - miscellaneous_home_furnishing_specialty_stores - miscellaneous_publishing_and_printing - miscellaneous_recreation_services - miscellaneous_repair_shops - miscellaneous_specialty_retail - mobile_home_dealers - motion_picture_theaters - motor_freight_carriers_and_trucking - motor_homes_dealers - motor_vehicle_supplies_and_new_parts - motorcycle_shops_and_dealers - motorcycle_shops_dealers - >- music_stores_musical_instruments_pianos_and_sheet_music - news_dealers_and_newsstands - non_fi_money_orders - non_fi_stored_value_card_purchase_load - nondurable_goods - nurseries_lawn_and_garden_supply_stores - nursing_personal_care - office_and_commercial_furniture - opticians_eyeglasses - optometrists_ophthalmologist - orthopedic_goods_prosthetic_devices - osteopaths - package_stores_beer_wine_and_liquor - paints_varnishes_and_supplies - parking_lots_garages - passenger_railways - pawn_shops - pet_shops_pet_food_and_supplies - petroleum_and_petroleum_products - photo_developing - >- photographic_photocopy_microfilm_equipment_and_supplies - photographic_studios - picture_video_production - piece_goods_notions_and_other_dry_goods - plumbing_heating_equipment_and_supplies - political_organizations - postal_services_government_only - precious_stones_and_metals_watches_and_jewelry - professional_services - public_warehousing_and_storage - quick_copy_repro_and_blueprint - railroads - real_estate_agents_and_managers_rentals - record_stores - recreational_vehicle_rentals - religious_goods_stores - religious_organizations - roofing_siding_sheet_metal - secretarial_support_services - security_brokers_dealers - service_stations - sewing_needlework_fabric_and_piece_goods_stores - shoe_repair_hat_cleaning - shoe_stores - small_appliance_repair - snowmobile_dealers - special_trade_services - specialty_cleaning - sporting_goods_stores - sporting_recreation_camps - sports_and_riding_apparel_stores - sports_clubs_fields - stamp_and_coin_stores - stationary_office_supplies_printing_and_writing_paper - stationery_stores_office_and_school_supply_stores - swimming_pools_sales - t_ui_travel_germany - tailors_alterations - tax_payments_government_agencies - tax_preparation_services - taxicabs_limousines - telecommunication_equipment_and_telephone_sales - telecommunication_services - telegraph_services - tent_and_awning_shops - testing_laboratories - theatrical_ticket_agencies - timeshares - tire_retreading_and_repair - tolls_bridge_fees - tourist_attractions_and_exhibits - towing_services - trailer_parks_campgrounds - transportation_services - travel_agencies_tour_operators - truck_stop_iteration - truck_utility_trailer_rentals - typesetting_plate_making_and_related_services - typewriter_stores - u_s_federal_government_agencies_or_departments - uniforms_commercial_clothing - used_merchandise_and_secondhand_stores - utilities - variety_stores - veterinary_services - video_amusement_game_supplies - video_game_arcades - video_tape_rental_stores - vocational_trade_schools - watch_jewelry_repair - welding_repair - wholesale_clubs - wig_and_toupee_stores - wires_money_orders - womens_accessory_and_specialty_shops - womens_ready_to_wear_stores - wrecking_and_salvage_yards maxLength: 5000 type: string city: maxLength: 5000 type: string country: maxLength: 5000 type: string name: maxLength: 5000 type: string network_id: maxLength: 5000 type: string postal_code: maxLength: 5000 type: string state: maxLength: 5000 type: string terminal_id: maxLength: 5000 type: string url: maxLength: 5000 type: string title: merchant_data_specs type: object network_data: description: >- Details about the authorization, such as identifiers, set by the card network. properties: acquiring_institution_id: maxLength: 5000 type: string title: network_data_specs type: object verification_data: description: >- Verifications that Stripe performed on information that the cardholder provided to the merchant. properties: address_line1_check: enum: - match - mismatch - not_provided type: string address_postal_code_check: enum: - match - mismatch - not_provided type: string authentication_exemption: properties: claimed_by: enum: - acquirer - issuer type: string type: enum: - low_value_transaction - transaction_risk_analysis - unknown type: string x-stripeBypassValidation: true required: - claimed_by - type title: authentication_exemption_specs type: object cvc_check: enum: - match - mismatch - not_provided type: string expiry_check: enum: - match - mismatch - not_provided type: string three_d_secure: properties: result: enum: - attempt_acknowledged - authenticated - failed - required type: string x-stripeBypassValidation: true required: - result title: three_d_secure_specs type: object title: verification_data_specs type: object wallet: description: >- The digital wallet used for this transaction. One of `apple_pay`, `google_pay`, or `samsung_pay`. Will populate as `null` when no digital wallet was utilized. enum: - apple_pay - google_pay - samsung_pay type: string required: - amount - card type: object required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/issuing.authorization' description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. '/v1/test_helpers/issuing/authorizations/{authorization}/capture': post: description:

Capture a test-mode authorization.

operationId: PostTestHelpersIssuingAuthorizationsAuthorizationCapture parameters: - in: path name: authorization required: true schema: maxLength: 5000 type: string style: simple requestBody: content: application/x-www-form-urlencoded: encoding: expand: explode: true style: deepObject purchase_details: explode: true style: deepObject schema: additionalProperties: false properties: capture_amount: description: >- The amount to capture from the authorization. If not provided, the full amount of the authorization will be captured. This amount is in the authorization currency and in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). type: integer close_authorization: description: >- Whether to close the authorization after capture. Defaults to true. Set to false to enable multi-capture flows. type: boolean expand: description: Specifies which fields in the response should be expanded. items: maxLength: 5000 type: string type: array purchase_details: description: >- Additional purchase information that is optionally provided by the merchant. properties: flight: properties: departure_at: format: unix-time type: integer passenger_name: maxLength: 5000 type: string refundable: type: boolean segments: items: properties: arrival_airport_code: maxLength: 3 type: string carrier: maxLength: 5000 type: string departure_airport_code: maxLength: 3 type: string flight_number: maxLength: 5000 type: string service_class: maxLength: 5000 type: string stopover_allowed: type: boolean title: flight_segment_specs type: object type: array travel_agency: maxLength: 5000 type: string title: flight_specs type: object fuel: properties: type: enum: - diesel - other - unleaded_plus - unleaded_regular - unleaded_super maxLength: 5000 type: string unit: enum: - liter - other - us_gallon maxLength: 5000 type: string unit_cost_decimal: format: decimal type: string volume_decimal: format: decimal type: string title: fuel_specs type: object lodging: properties: check_in_at: format: unix-time type: integer nights: type: integer title: lodging_specs type: object receipt: items: properties: description: maxLength: 26 type: string quantity: format: decimal type: string total: type: integer unit_cost: type: integer title: receipt_specs type: object type: array reference: maxLength: 5000 type: string title: purchase_details_specs type: object type: object required: false responses: '200': content: application/json: schema: $ref: '#/components/schemas/issuing.authorization' description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. '/v1/test_helpers/issuing/authorizations/{authorization}/expire': post: description:

Expire a test-mode Authorization.

operationId: PostTestHelpersIssuingAuthorizationsAuthorizationExpire parameters: - in: path name: authorization required: true schema: maxLength: 5000 type: string style: simple requestBody: content: application/x-www-form-urlencoded: encoding: expand: explode: true style: deepObject schema: additionalProperties: false properties: expand: description: Specifies which fields in the response should be expanded. items: maxLength: 5000 type: string type: array type: object required: false responses: '200': content: application/json: schema: $ref: '#/components/schemas/issuing.authorization' description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. '/v1/test_helpers/issuing/authorizations/{authorization}/increment': post: description:

Increment a test-mode Authorization.

operationId: PostTestHelpersIssuingAuthorizationsAuthorizationIncrement parameters: - in: path name: authorization required: true schema: maxLength: 5000 type: string style: simple requestBody: content: application/x-www-form-urlencoded: encoding: expand: explode: true style: deepObject schema: additionalProperties: false properties: expand: description: Specifies which fields in the response should be expanded. items: maxLength: 5000 type: string type: array increment_amount: description: >- The amount to increment the authorization by. This amount is in the authorization currency and in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). type: integer is_amount_controllable: description: >- If set `true`, you may provide [amount](https://stripe.com/docs/api/issuing/authorizations/approve#approve_issuing_authorization-amount) to control how much to hold for the authorization. type: boolean required: - increment_amount type: object required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/issuing.authorization' description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. '/v1/test_helpers/issuing/authorizations/{authorization}/reverse': post: description:

Reverse a test-mode Authorization.

operationId: PostTestHelpersIssuingAuthorizationsAuthorizationReverse parameters: - in: path name: authorization required: true schema: maxLength: 5000 type: string style: simple requestBody: content: application/x-www-form-urlencoded: encoding: expand: explode: true style: deepObject schema: additionalProperties: false properties: expand: description: Specifies which fields in the response should be expanded. items: maxLength: 5000 type: string type: array reverse_amount: description: >- The amount to reverse from the authorization. If not provided, the full amount of the authorization will be reversed. This amount is in the authorization currency and in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). type: integer type: object required: false responses: '200': content: application/json: schema: $ref: '#/components/schemas/issuing.authorization' description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. '/v1/test_helpers/issuing/cards/{card}/shipping/deliver': post: description: >-

Updates the shipping status of the specified Issuing Card object to delivered.

operationId: PostTestHelpersIssuingCardsCardShippingDeliver parameters: - in: path name: card required: true schema: maxLength: 5000 type: string style: simple requestBody: content: application/x-www-form-urlencoded: encoding: expand: explode: true style: deepObject schema: additionalProperties: false properties: expand: description: Specifies which fields in the response should be expanded. items: maxLength: 5000 type: string type: array type: object required: false responses: '200': content: application/json: schema: $ref: '#/components/schemas/issuing.card' description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. '/v1/test_helpers/issuing/cards/{card}/shipping/fail': post: description: >-

Updates the shipping status of the specified Issuing Card object to failure.

operationId: PostTestHelpersIssuingCardsCardShippingFail parameters: - in: path name: card required: true schema: maxLength: 5000 type: string style: simple requestBody: content: application/x-www-form-urlencoded: encoding: expand: explode: true style: deepObject schema: additionalProperties: false properties: expand: description: Specifies which fields in the response should be expanded. items: maxLength: 5000 type: string type: array type: object required: false responses: '200': content: application/json: schema: $ref: '#/components/schemas/issuing.card' description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. '/v1/test_helpers/issuing/cards/{card}/shipping/return': post: description: >-

Updates the shipping status of the specified Issuing Card object to returned.

operationId: PostTestHelpersIssuingCardsCardShippingReturn parameters: - in: path name: card required: true schema: maxLength: 5000 type: string style: simple requestBody: content: application/x-www-form-urlencoded: encoding: expand: explode: true style: deepObject schema: additionalProperties: false properties: expand: description: Specifies which fields in the response should be expanded. items: maxLength: 5000 type: string type: array type: object required: false responses: '200': content: application/json: schema: $ref: '#/components/schemas/issuing.card' description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. '/v1/test_helpers/issuing/cards/{card}/shipping/ship': post: description: >-

Updates the shipping status of the specified Issuing Card object to shipped.

operationId: PostTestHelpersIssuingCardsCardShippingShip parameters: - in: path name: card required: true schema: maxLength: 5000 type: string style: simple requestBody: content: application/x-www-form-urlencoded: encoding: expand: explode: true style: deepObject schema: additionalProperties: false properties: expand: description: Specifies which fields in the response should be expanded. items: maxLength: 5000 type: string type: array type: object required: false responses: '200': content: application/json: schema: $ref: '#/components/schemas/issuing.card' description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. '/v1/test_helpers/issuing/personalization_designs/{personalization_design}/activate': post: description: >-

Updates the status of the specified testmode personalization design object to active.

operationId: >- PostTestHelpersIssuingPersonalizationDesignsPersonalizationDesignActivate parameters: - in: path name: personalization_design required: true schema: maxLength: 5000 type: string style: simple requestBody: content: application/x-www-form-urlencoded: encoding: expand: explode: true style: deepObject schema: additionalProperties: false properties: expand: description: Specifies which fields in the response should be expanded. items: maxLength: 5000 type: string type: array type: object required: false responses: '200': content: application/json: schema: $ref: '#/components/schemas/issuing.personalization_design' description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. '/v1/test_helpers/issuing/personalization_designs/{personalization_design}/deactivate': post: description: >-

Updates the status of the specified testmode personalization design object to inactive.

operationId: >- PostTestHelpersIssuingPersonalizationDesignsPersonalizationDesignDeactivate parameters: - in: path name: personalization_design required: true schema: maxLength: 5000 type: string style: simple requestBody: content: application/x-www-form-urlencoded: encoding: expand: explode: true style: deepObject schema: additionalProperties: false properties: expand: description: Specifies which fields in the response should be expanded. items: maxLength: 5000 type: string type: array type: object required: false responses: '200': content: application/json: schema: $ref: '#/components/schemas/issuing.personalization_design' description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. '/v1/test_helpers/issuing/personalization_designs/{personalization_design}/reject': post: description: >-

Updates the status of the specified testmode personalization design object to rejected.

operationId: PostTestHelpersIssuingPersonalizationDesignsPersonalizationDesignReject parameters: - in: path name: personalization_design required: true schema: maxLength: 5000 type: string style: simple requestBody: content: application/x-www-form-urlencoded: encoding: expand: explode: true style: deepObject rejection_reasons: explode: true style: deepObject schema: additionalProperties: false properties: expand: description: Specifies which fields in the response should be expanded. items: maxLength: 5000 type: string type: array rejection_reasons: description: The reason(s) the personalization design was rejected. properties: card_logo: items: enum: - geographic_location - inappropriate - network_name - non_binary_image - non_fiat_currency - other - other_entity - promotional_material type: string type: array carrier_text: items: enum: - geographic_location - inappropriate - network_name - non_fiat_currency - other - other_entity - promotional_material type: string type: array title: rejection_reasons_param type: object required: - rejection_reasons type: object required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/issuing.personalization_design' description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. /v1/test_helpers/issuing/transactions/create_force_capture: post: description: >-

Allows the user to capture an arbitrary amount, also known as a forced capture.

operationId: PostTestHelpersIssuingTransactionsCreateForceCapture requestBody: content: application/x-www-form-urlencoded: encoding: expand: explode: true style: deepObject merchant_data: explode: true style: deepObject purchase_details: explode: true style: deepObject schema: additionalProperties: false properties: amount: description: >- The total amount to attempt to capture. This amount is in the provided currency, or defaults to the cards currency, and in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). type: integer card: description: Card associated with this transaction. maxLength: 5000 type: string currency: description: >- The currency of the capture. If not provided, defaults to the currency of the card. 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). type: string expand: description: Specifies which fields in the response should be expanded. items: maxLength: 5000 type: string type: array merchant_data: description: >- Details about the seller (grocery store, e-commerce website, etc.) where the card authorization happened. properties: category: enum: - ac_refrigeration_repair - accounting_bookkeeping_services - advertising_services - agricultural_cooperative - airlines_air_carriers - airports_flying_fields - ambulance_services - amusement_parks_carnivals - antique_reproductions - antique_shops - aquariums - architectural_surveying_services - art_dealers_and_galleries - artists_supply_and_craft_shops - auto_and_home_supply_stores - auto_body_repair_shops - auto_paint_shops - auto_service_shops - automated_cash_disburse - automated_fuel_dispensers - automobile_associations - automotive_parts_and_accessories_stores - automotive_tire_stores - bail_and_bond_payments - bakeries - bands_orchestras - barber_and_beauty_shops - betting_casino_gambling - bicycle_shops - billiard_pool_establishments - boat_dealers - boat_rentals_and_leases - book_stores - books_periodicals_and_newspapers - bowling_alleys - bus_lines - business_secretarial_schools - buying_shopping_services - cable_satellite_and_other_pay_television_and_radio - camera_and_photographic_supply_stores - candy_nut_and_confectionery_stores - car_and_truck_dealers_new_used - car_and_truck_dealers_used_only - car_rental_agencies - car_washes - carpentry_services - carpet_upholstery_cleaning - caterers - >- charitable_and_social_service_organizations_fundraising - chemicals_and_allied_products - child_care_services - childrens_and_infants_wear_stores - chiropodists_podiatrists - chiropractors - cigar_stores_and_stands - civic_social_fraternal_associations - cleaning_and_maintenance - clothing_rental - colleges_universities - commercial_equipment - commercial_footwear - commercial_photography_art_and_graphics - commuter_transport_and_ferries - computer_network_services - computer_programming - computer_repair - computer_software_stores - computers_peripherals_and_software - concrete_work_services - construction_materials - consulting_public_relations - correspondence_schools - cosmetic_stores - counseling_services - country_clubs - courier_services - court_costs - credit_reporting_agencies - cruise_lines - dairy_products_stores - dance_hall_studios_schools - dating_escort_services - dentists_orthodontists - department_stores - detective_agencies - digital_goods_applications - digital_goods_games - digital_goods_large_volume - digital_goods_media - direct_marketing_catalog_merchant - >- direct_marketing_combination_catalog_and_retail_merchant - direct_marketing_inbound_telemarketing - direct_marketing_insurance_services - direct_marketing_other - direct_marketing_outbound_telemarketing - direct_marketing_subscription - direct_marketing_travel - discount_stores - doctors - door_to_door_sales - drapery_window_covering_and_upholstery_stores - drinking_places - drug_stores_and_pharmacies - drugs_drug_proprietaries_and_druggist_sundries - dry_cleaners - durable_goods - duty_free_stores - eating_places_restaurants - educational_services - electric_razor_stores - electric_vehicle_charging - electrical_parts_and_equipment - electrical_services - electronics_repair_shops - electronics_stores - elementary_secondary_schools - emergency_services_gcas_visa_use_only - employment_temp_agencies - equipment_rental - exterminating_services - family_clothing_stores - fast_food_restaurants - financial_institutions - fines_government_administrative_entities - fireplace_fireplace_screens_and_accessories_stores - floor_covering_stores - florists - florists_supplies_nursery_stock_and_flowers - freezer_and_locker_meat_provisioners - fuel_dealers_non_automotive - funeral_services_crematories - >- furniture_home_furnishings_and_equipment_stores_except_appliances - furniture_repair_refinishing - furriers_and_fur_shops - general_services - gift_card_novelty_and_souvenir_shops - glass_paint_and_wallpaper_stores - glassware_crystal_stores - golf_courses_public - government_licensed_horse_dog_racing_us_region_only - >- government_licensed_online_casions_online_gambling_us_region_only - government_owned_lotteries_non_us_region - government_owned_lotteries_us_region_only - government_services - grocery_stores_supermarkets - hardware_equipment_and_supplies - hardware_stores - health_and_beauty_spas - hearing_aids_sales_and_supplies - heating_plumbing_a_c - hobby_toy_and_game_shops - home_supply_warehouse_stores - hospitals - hotels_motels_and_resorts - household_appliance_stores - industrial_supplies - information_retrieval_services - insurance_default - insurance_underwriting_premiums - intra_company_purchases - jewelry_stores_watches_clocks_and_silverware_stores - landscaping_services - laundries - laundry_cleaning_services - legal_services_attorneys - luggage_and_leather_goods_stores - lumber_building_materials_stores - manual_cash_disburse - marinas_service_and_supplies - marketplaces - masonry_stonework_and_plaster - massage_parlors - medical_and_dental_labs - >- medical_dental_ophthalmic_and_hospital_equipment_and_supplies - medical_services - membership_organizations - mens_and_boys_clothing_and_accessories_stores - mens_womens_clothing_stores - metal_service_centers - miscellaneous_apparel_and_accessory_shops - miscellaneous_auto_dealers - miscellaneous_business_services - miscellaneous_food_stores - miscellaneous_general_merchandise - miscellaneous_general_services - miscellaneous_home_furnishing_specialty_stores - miscellaneous_publishing_and_printing - miscellaneous_recreation_services - miscellaneous_repair_shops - miscellaneous_specialty_retail - mobile_home_dealers - motion_picture_theaters - motor_freight_carriers_and_trucking - motor_homes_dealers - motor_vehicle_supplies_and_new_parts - motorcycle_shops_and_dealers - motorcycle_shops_dealers - >- music_stores_musical_instruments_pianos_and_sheet_music - news_dealers_and_newsstands - non_fi_money_orders - non_fi_stored_value_card_purchase_load - nondurable_goods - nurseries_lawn_and_garden_supply_stores - nursing_personal_care - office_and_commercial_furniture - opticians_eyeglasses - optometrists_ophthalmologist - orthopedic_goods_prosthetic_devices - osteopaths - package_stores_beer_wine_and_liquor - paints_varnishes_and_supplies - parking_lots_garages - passenger_railways - pawn_shops - pet_shops_pet_food_and_supplies - petroleum_and_petroleum_products - photo_developing - >- photographic_photocopy_microfilm_equipment_and_supplies - photographic_studios - picture_video_production - piece_goods_notions_and_other_dry_goods - plumbing_heating_equipment_and_supplies - political_organizations - postal_services_government_only - precious_stones_and_metals_watches_and_jewelry - professional_services - public_warehousing_and_storage - quick_copy_repro_and_blueprint - railroads - real_estate_agents_and_managers_rentals - record_stores - recreational_vehicle_rentals - religious_goods_stores - religious_organizations - roofing_siding_sheet_metal - secretarial_support_services - security_brokers_dealers - service_stations - sewing_needlework_fabric_and_piece_goods_stores - shoe_repair_hat_cleaning - shoe_stores - small_appliance_repair - snowmobile_dealers - special_trade_services - specialty_cleaning - sporting_goods_stores - sporting_recreation_camps - sports_and_riding_apparel_stores - sports_clubs_fields - stamp_and_coin_stores - stationary_office_supplies_printing_and_writing_paper - stationery_stores_office_and_school_supply_stores - swimming_pools_sales - t_ui_travel_germany - tailors_alterations - tax_payments_government_agencies - tax_preparation_services - taxicabs_limousines - telecommunication_equipment_and_telephone_sales - telecommunication_services - telegraph_services - tent_and_awning_shops - testing_laboratories - theatrical_ticket_agencies - timeshares - tire_retreading_and_repair - tolls_bridge_fees - tourist_attractions_and_exhibits - towing_services - trailer_parks_campgrounds - transportation_services - travel_agencies_tour_operators - truck_stop_iteration - truck_utility_trailer_rentals - typesetting_plate_making_and_related_services - typewriter_stores - u_s_federal_government_agencies_or_departments - uniforms_commercial_clothing - used_merchandise_and_secondhand_stores - utilities - variety_stores - veterinary_services - video_amusement_game_supplies - video_game_arcades - video_tape_rental_stores - vocational_trade_schools - watch_jewelry_repair - welding_repair - wholesale_clubs - wig_and_toupee_stores - wires_money_orders - womens_accessory_and_specialty_shops - womens_ready_to_wear_stores - wrecking_and_salvage_yards maxLength: 5000 type: string city: maxLength: 5000 type: string country: maxLength: 5000 type: string name: maxLength: 5000 type: string network_id: maxLength: 5000 type: string postal_code: maxLength: 5000 type: string state: maxLength: 5000 type: string terminal_id: maxLength: 5000 type: string url: maxLength: 5000 type: string title: merchant_data_specs type: object purchase_details: description: >- Additional purchase information that is optionally provided by the merchant. properties: flight: properties: departure_at: format: unix-time type: integer passenger_name: maxLength: 5000 type: string refundable: type: boolean segments: items: properties: arrival_airport_code: maxLength: 3 type: string carrier: maxLength: 5000 type: string departure_airport_code: maxLength: 3 type: string flight_number: maxLength: 5000 type: string service_class: maxLength: 5000 type: string stopover_allowed: type: boolean title: flight_segment_specs type: object type: array travel_agency: maxLength: 5000 type: string title: flight_specs type: object fuel: properties: type: enum: - diesel - other - unleaded_plus - unleaded_regular - unleaded_super maxLength: 5000 type: string unit: enum: - liter - other - us_gallon maxLength: 5000 type: string unit_cost_decimal: format: decimal type: string volume_decimal: format: decimal type: string title: fuel_specs type: object lodging: properties: check_in_at: format: unix-time type: integer nights: type: integer title: lodging_specs type: object receipt: items: properties: description: maxLength: 26 type: string quantity: format: decimal type: string total: type: integer unit_cost: type: integer title: receipt_specs type: object type: array reference: maxLength: 5000 type: string title: purchase_details_specs type: object required: - amount - card type: object required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/issuing.transaction' description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. /v1/test_helpers/issuing/transactions/create_unlinked_refund: post: description: >-

Allows the user to refund an arbitrary amount, also known as a unlinked refund.

operationId: PostTestHelpersIssuingTransactionsCreateUnlinkedRefund requestBody: content: application/x-www-form-urlencoded: encoding: expand: explode: true style: deepObject merchant_data: explode: true style: deepObject purchase_details: explode: true style: deepObject schema: additionalProperties: false properties: amount: description: >- The total amount to attempt to refund. This amount is in the provided currency, or defaults to the cards currency, and in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). type: integer card: description: Card associated with this unlinked refund transaction. maxLength: 5000 type: string currency: description: >- The currency of the unlinked refund. If not provided, defaults to the currency of the card. 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). type: string expand: description: Specifies which fields in the response should be expanded. items: maxLength: 5000 type: string type: array merchant_data: description: >- Details about the seller (grocery store, e-commerce website, etc.) where the card authorization happened. properties: category: enum: - ac_refrigeration_repair - accounting_bookkeeping_services - advertising_services - agricultural_cooperative - airlines_air_carriers - airports_flying_fields - ambulance_services - amusement_parks_carnivals - antique_reproductions - antique_shops - aquariums - architectural_surveying_services - art_dealers_and_galleries - artists_supply_and_craft_shops - auto_and_home_supply_stores - auto_body_repair_shops - auto_paint_shops - auto_service_shops - automated_cash_disburse - automated_fuel_dispensers - automobile_associations - automotive_parts_and_accessories_stores - automotive_tire_stores - bail_and_bond_payments - bakeries - bands_orchestras - barber_and_beauty_shops - betting_casino_gambling - bicycle_shops - billiard_pool_establishments - boat_dealers - boat_rentals_and_leases - book_stores - books_periodicals_and_newspapers - bowling_alleys - bus_lines - business_secretarial_schools - buying_shopping_services - cable_satellite_and_other_pay_television_and_radio - camera_and_photographic_supply_stores - candy_nut_and_confectionery_stores - car_and_truck_dealers_new_used - car_and_truck_dealers_used_only - car_rental_agencies - car_washes - carpentry_services - carpet_upholstery_cleaning - caterers - >- charitable_and_social_service_organizations_fundraising - chemicals_and_allied_products - child_care_services - childrens_and_infants_wear_stores - chiropodists_podiatrists - chiropractors - cigar_stores_and_stands - civic_social_fraternal_associations - cleaning_and_maintenance - clothing_rental - colleges_universities - commercial_equipment - commercial_footwear - commercial_photography_art_and_graphics - commuter_transport_and_ferries - computer_network_services - computer_programming - computer_repair - computer_software_stores - computers_peripherals_and_software - concrete_work_services - construction_materials - consulting_public_relations - correspondence_schools - cosmetic_stores - counseling_services - country_clubs - courier_services - court_costs - credit_reporting_agencies - cruise_lines - dairy_products_stores - dance_hall_studios_schools - dating_escort_services - dentists_orthodontists - department_stores - detective_agencies - digital_goods_applications - digital_goods_games - digital_goods_large_volume - digital_goods_media - direct_marketing_catalog_merchant - >- direct_marketing_combination_catalog_and_retail_merchant - direct_marketing_inbound_telemarketing - direct_marketing_insurance_services - direct_marketing_other - direct_marketing_outbound_telemarketing - direct_marketing_subscription - direct_marketing_travel - discount_stores - doctors - door_to_door_sales - drapery_window_covering_and_upholstery_stores - drinking_places - drug_stores_and_pharmacies - drugs_drug_proprietaries_and_druggist_sundries - dry_cleaners - durable_goods - duty_free_stores - eating_places_restaurants - educational_services - electric_razor_stores - electric_vehicle_charging - electrical_parts_and_equipment - electrical_services - electronics_repair_shops - electronics_stores - elementary_secondary_schools - emergency_services_gcas_visa_use_only - employment_temp_agencies - equipment_rental - exterminating_services - family_clothing_stores - fast_food_restaurants - financial_institutions - fines_government_administrative_entities - fireplace_fireplace_screens_and_accessories_stores - floor_covering_stores - florists - florists_supplies_nursery_stock_and_flowers - freezer_and_locker_meat_provisioners - fuel_dealers_non_automotive - funeral_services_crematories - >- furniture_home_furnishings_and_equipment_stores_except_appliances - furniture_repair_refinishing - furriers_and_fur_shops - general_services - gift_card_novelty_and_souvenir_shops - glass_paint_and_wallpaper_stores - glassware_crystal_stores - golf_courses_public - government_licensed_horse_dog_racing_us_region_only - >- government_licensed_online_casions_online_gambling_us_region_only - government_owned_lotteries_non_us_region - government_owned_lotteries_us_region_only - government_services - grocery_stores_supermarkets - hardware_equipment_and_supplies - hardware_stores - health_and_beauty_spas - hearing_aids_sales_and_supplies - heating_plumbing_a_c - hobby_toy_and_game_shops - home_supply_warehouse_stores - hospitals - hotels_motels_and_resorts - household_appliance_stores - industrial_supplies - information_retrieval_services - insurance_default - insurance_underwriting_premiums - intra_company_purchases - jewelry_stores_watches_clocks_and_silverware_stores - landscaping_services - laundries - laundry_cleaning_services - legal_services_attorneys - luggage_and_leather_goods_stores - lumber_building_materials_stores - manual_cash_disburse - marinas_service_and_supplies - marketplaces - masonry_stonework_and_plaster - massage_parlors - medical_and_dental_labs - >- medical_dental_ophthalmic_and_hospital_equipment_and_supplies - medical_services - membership_organizations - mens_and_boys_clothing_and_accessories_stores - mens_womens_clothing_stores - metal_service_centers - miscellaneous_apparel_and_accessory_shops - miscellaneous_auto_dealers - miscellaneous_business_services - miscellaneous_food_stores - miscellaneous_general_merchandise - miscellaneous_general_services - miscellaneous_home_furnishing_specialty_stores - miscellaneous_publishing_and_printing - miscellaneous_recreation_services - miscellaneous_repair_shops - miscellaneous_specialty_retail - mobile_home_dealers - motion_picture_theaters - motor_freight_carriers_and_trucking - motor_homes_dealers - motor_vehicle_supplies_and_new_parts - motorcycle_shops_and_dealers - motorcycle_shops_dealers - >- music_stores_musical_instruments_pianos_and_sheet_music - news_dealers_and_newsstands - non_fi_money_orders - non_fi_stored_value_card_purchase_load - nondurable_goods - nurseries_lawn_and_garden_supply_stores - nursing_personal_care - office_and_commercial_furniture - opticians_eyeglasses - optometrists_ophthalmologist - orthopedic_goods_prosthetic_devices - osteopaths - package_stores_beer_wine_and_liquor - paints_varnishes_and_supplies - parking_lots_garages - passenger_railways - pawn_shops - pet_shops_pet_food_and_supplies - petroleum_and_petroleum_products - photo_developing - >- photographic_photocopy_microfilm_equipment_and_supplies - photographic_studios - picture_video_production - piece_goods_notions_and_other_dry_goods - plumbing_heating_equipment_and_supplies - political_organizations - postal_services_government_only - precious_stones_and_metals_watches_and_jewelry - professional_services - public_warehousing_and_storage - quick_copy_repro_and_blueprint - railroads - real_estate_agents_and_managers_rentals - record_stores - recreational_vehicle_rentals - religious_goods_stores - religious_organizations - roofing_siding_sheet_metal - secretarial_support_services - security_brokers_dealers - service_stations - sewing_needlework_fabric_and_piece_goods_stores - shoe_repair_hat_cleaning - shoe_stores - small_appliance_repair - snowmobile_dealers - special_trade_services - specialty_cleaning - sporting_goods_stores - sporting_recreation_camps - sports_and_riding_apparel_stores - sports_clubs_fields - stamp_and_coin_stores - stationary_office_supplies_printing_and_writing_paper - stationery_stores_office_and_school_supply_stores - swimming_pools_sales - t_ui_travel_germany - tailors_alterations - tax_payments_government_agencies - tax_preparation_services - taxicabs_limousines - telecommunication_equipment_and_telephone_sales - telecommunication_services - telegraph_services - tent_and_awning_shops - testing_laboratories - theatrical_ticket_agencies - timeshares - tire_retreading_and_repair - tolls_bridge_fees - tourist_attractions_and_exhibits - towing_services - trailer_parks_campgrounds - transportation_services - travel_agencies_tour_operators - truck_stop_iteration - truck_utility_trailer_rentals - typesetting_plate_making_and_related_services - typewriter_stores - u_s_federal_government_agencies_or_departments - uniforms_commercial_clothing - used_merchandise_and_secondhand_stores - utilities - variety_stores - veterinary_services - video_amusement_game_supplies - video_game_arcades - video_tape_rental_stores - vocational_trade_schools - watch_jewelry_repair - welding_repair - wholesale_clubs - wig_and_toupee_stores - wires_money_orders - womens_accessory_and_specialty_shops - womens_ready_to_wear_stores - wrecking_and_salvage_yards maxLength: 5000 type: string city: maxLength: 5000 type: string country: maxLength: 5000 type: string name: maxLength: 5000 type: string network_id: maxLength: 5000 type: string postal_code: maxLength: 5000 type: string state: maxLength: 5000 type: string terminal_id: maxLength: 5000 type: string url: maxLength: 5000 type: string title: merchant_data_specs type: object purchase_details: description: >- Additional purchase information that is optionally provided by the merchant. properties: flight: properties: departure_at: format: unix-time type: integer passenger_name: maxLength: 5000 type: string refundable: type: boolean segments: items: properties: arrival_airport_code: maxLength: 3 type: string carrier: maxLength: 5000 type: string departure_airport_code: maxLength: 3 type: string flight_number: maxLength: 5000 type: string service_class: maxLength: 5000 type: string stopover_allowed: type: boolean title: flight_segment_specs type: object type: array travel_agency: maxLength: 5000 type: string title: flight_specs type: object fuel: properties: type: enum: - diesel - other - unleaded_plus - unleaded_regular - unleaded_super maxLength: 5000 type: string unit: enum: - liter - other - us_gallon maxLength: 5000 type: string unit_cost_decimal: format: decimal type: string volume_decimal: format: decimal type: string title: fuel_specs type: object lodging: properties: check_in_at: format: unix-time type: integer nights: type: integer title: lodging_specs type: object receipt: items: properties: description: maxLength: 26 type: string quantity: format: decimal type: string total: type: integer unit_cost: type: integer title: receipt_specs type: object type: array reference: maxLength: 5000 type: string title: purchase_details_specs type: object required: - amount - card type: object required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/issuing.transaction' description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. '/v1/test_helpers/issuing/transactions/{transaction}/refund': post: description:

Refund a test-mode Transaction.

operationId: PostTestHelpersIssuingTransactionsTransactionRefund parameters: - in: path name: transaction required: true schema: maxLength: 5000 type: string style: simple requestBody: content: application/x-www-form-urlencoded: encoding: expand: explode: true style: deepObject schema: additionalProperties: false properties: expand: description: Specifies which fields in the response should be expanded. items: maxLength: 5000 type: string type: array refund_amount: description: >- The total amount to attempt to refund. This amount is in the provided currency, or defaults to the cards currency, and in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). type: integer type: object required: false responses: '200': content: application/json: schema: $ref: '#/components/schemas/issuing.transaction' description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. '/v1/test_helpers/refunds/{refund}/expire': post: description:

Expire a refund with a status of requires_action.

operationId: PostTestHelpersRefundsRefundExpire parameters: - in: path name: refund required: true schema: type: string style: simple requestBody: content: application/x-www-form-urlencoded: encoding: expand: explode: true style: deepObject schema: additionalProperties: false properties: expand: description: Specifies which fields in the response should be expanded. items: maxLength: 5000 type: string type: array type: object required: false responses: '200': content: application/json: schema: $ref: '#/components/schemas/refund' description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. '/v1/test_helpers/terminal/readers/{reader}/present_payment_method': post: description: >-

Presents a payment method on a simulated reader. Can be used to simulate accepting a payment, saving a card or refunding a transaction.

operationId: PostTestHelpersTerminalReadersReaderPresentPaymentMethod parameters: - in: path name: reader required: true schema: maxLength: 5000 type: string style: simple requestBody: content: application/x-www-form-urlencoded: encoding: card_present: explode: true style: deepObject expand: explode: true style: deepObject interac_present: explode: true style: deepObject schema: additionalProperties: false properties: amount_tip: description: Simulated on-reader tip amount. type: integer card_present: description: Simulated data for the card_present payment method. properties: number: maxLength: 5000 type: string title: card_present type: object expand: description: Specifies which fields in the response should be expanded. items: maxLength: 5000 type: string type: array interac_present: description: Simulated data for the interac_present payment method. properties: number: maxLength: 5000 type: string title: interac_present type: object type: description: Simulated payment type. enum: - card_present - interac_present type: string x-stripeBypassValidation: true type: object required: false responses: '200': content: application/json: schema: $ref: '#/components/schemas/terminal.reader' description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. /v1/test_helpers/test_clocks: get: description:

Returns a list of your test clocks.

operationId: GetTestHelpersTestClocks parameters: - description: >- A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. in: query name: ending_before required: false schema: maxLength: 5000 type: string style: form - description: Specifies which fields in the response should be expanded. explode: true in: query name: expand required: false schema: items: maxLength: 5000 type: string type: array style: deepObject - description: >- A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. in: query name: limit required: false schema: type: integer style: form - description: >- A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. in: query name: starting_after required: false schema: maxLength: 5000 type: string style: form requestBody: content: application/x-www-form-urlencoded: encoding: {} schema: additionalProperties: false properties: {} type: object required: false responses: '200': content: application/json: schema: description: '' properties: data: items: $ref: '#/components/schemas/test_helpers.test_clock' type: array has_more: description: >- True if this list has another page of items after this one that can be fetched. type: boolean object: description: >- String representing the object's type. Objects of the same type share the same value. Always has the value `list`. enum: - list type: string url: description: The URL where this list can be accessed. maxLength: 5000 pattern: ^/v1/test_helpers/test_clocks type: string required: - data - has_more - object - url title: BillingClocksResourceBillingClockList type: object x-expandableFields: - data description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. post: description: >-

Creates a new test clock that can be attached to new customers and quotes.

operationId: PostTestHelpersTestClocks requestBody: content: application/x-www-form-urlencoded: encoding: expand: explode: true style: deepObject schema: additionalProperties: false properties: expand: description: Specifies which fields in the response should be expanded. items: maxLength: 5000 type: string type: array frozen_time: description: The initial frozen time for this test clock. format: unix-time type: integer name: description: The name for this test clock. maxLength: 300 type: string required: - frozen_time type: object required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/test_helpers.test_clock' description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. '/v1/test_helpers/test_clocks/{test_clock}': delete: description:

Deletes a test clock.

operationId: DeleteTestHelpersTestClocksTestClock parameters: - in: path name: test_clock required: true schema: maxLength: 5000 type: string style: simple requestBody: content: application/x-www-form-urlencoded: encoding: {} schema: additionalProperties: false properties: {} type: object required: false responses: '200': content: application/json: schema: $ref: '#/components/schemas/deleted_test_helpers.test_clock' description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. get: description:

Retrieves a test clock.

operationId: GetTestHelpersTestClocksTestClock parameters: - description: Specifies which fields in the response should be expanded. explode: true in: query name: expand required: false schema: items: maxLength: 5000 type: string type: array style: deepObject - in: path name: test_clock required: true schema: maxLength: 5000 type: string style: simple requestBody: content: application/x-www-form-urlencoded: encoding: {} schema: additionalProperties: false properties: {} type: object required: false responses: '200': content: application/json: schema: $ref: '#/components/schemas/test_helpers.test_clock' description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. '/v1/test_helpers/test_clocks/{test_clock}/advance': post: description: >-

Starts advancing a test clock to a specified time in the future. Advancement is done when status changes to Ready.

operationId: PostTestHelpersTestClocksTestClockAdvance parameters: - in: path name: test_clock required: true schema: maxLength: 5000 type: string style: simple requestBody: content: application/x-www-form-urlencoded: encoding: expand: explode: true style: deepObject schema: additionalProperties: false properties: expand: description: Specifies which fields in the response should be expanded. items: maxLength: 5000 type: string type: array frozen_time: description: >- The time to advance the test clock. Must be after the test clock's current frozen time. Cannot be more than two intervals in the future from the shortest subscription in this test clock. If there are no subscriptions in this test clock, it cannot be more than two years in the future. format: unix-time type: integer required: - frozen_time type: object required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/test_helpers.test_clock' description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. '/v1/test_helpers/treasury/inbound_transfers/{id}/fail': post: description: >-

Transitions a test mode created InboundTransfer to the failed status. The InboundTransfer must already be in the processing state.

operationId: PostTestHelpersTreasuryInboundTransfersIdFail parameters: - in: path name: id required: true schema: maxLength: 5000 type: string style: simple requestBody: content: application/x-www-form-urlencoded: encoding: expand: explode: true style: deepObject failure_details: explode: true style: deepObject schema: additionalProperties: false properties: expand: description: Specifies which fields in the response should be expanded. items: maxLength: 5000 type: string type: array failure_details: description: Details about a failed InboundTransfer. properties: code: enum: - account_closed - account_frozen - bank_account_restricted - bank_ownership_changed - debit_not_authorized - incorrect_account_holder_address - incorrect_account_holder_name - incorrect_account_holder_tax_id - insufficient_funds - invalid_account_number - invalid_currency - no_account - other type: string title: failure_details_params type: object type: object required: false responses: '200': content: application/json: schema: $ref: '#/components/schemas/treasury.inbound_transfer' description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. '/v1/test_helpers/treasury/inbound_transfers/{id}/return': post: description: >-

Marks the test mode InboundTransfer object as returned and links the InboundTransfer to a ReceivedDebit. The InboundTransfer must already be in the succeeded state.

operationId: PostTestHelpersTreasuryInboundTransfersIdReturn parameters: - in: path name: id required: true schema: maxLength: 5000 type: string style: simple requestBody: content: application/x-www-form-urlencoded: encoding: expand: explode: true style: deepObject schema: additionalProperties: false properties: expand: description: Specifies which fields in the response should be expanded. items: maxLength: 5000 type: string type: array type: object required: false responses: '200': content: application/json: schema: $ref: '#/components/schemas/treasury.inbound_transfer' description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. '/v1/test_helpers/treasury/inbound_transfers/{id}/succeed': post: description: >-

Transitions a test mode created InboundTransfer to the succeeded status. The InboundTransfer must already be in the processing state.

operationId: PostTestHelpersTreasuryInboundTransfersIdSucceed parameters: - in: path name: id required: true schema: maxLength: 5000 type: string style: simple requestBody: content: application/x-www-form-urlencoded: encoding: expand: explode: true style: deepObject schema: additionalProperties: false properties: expand: description: Specifies which fields in the response should be expanded. items: maxLength: 5000 type: string type: array type: object required: false responses: '200': content: application/json: schema: $ref: '#/components/schemas/treasury.inbound_transfer' description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. '/v1/test_helpers/treasury/outbound_payments/{id}/fail': post: description: >-

Transitions a test mode created OutboundPayment to the failed status. The OutboundPayment must already be in the processing state.

operationId: PostTestHelpersTreasuryOutboundPaymentsIdFail parameters: - in: path name: id required: true schema: maxLength: 5000 type: string style: simple requestBody: content: application/x-www-form-urlencoded: encoding: expand: explode: true style: deepObject schema: additionalProperties: false properties: expand: description: Specifies which fields in the response should be expanded. items: maxLength: 5000 type: string type: array type: object required: false responses: '200': content: application/json: schema: $ref: '#/components/schemas/treasury.outbound_payment' description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. '/v1/test_helpers/treasury/outbound_payments/{id}/post': post: description: >-

Transitions a test mode created OutboundPayment to the posted status. The OutboundPayment must already be in the processing state.

operationId: PostTestHelpersTreasuryOutboundPaymentsIdPost parameters: - in: path name: id required: true schema: maxLength: 5000 type: string style: simple requestBody: content: application/x-www-form-urlencoded: encoding: expand: explode: true style: deepObject schema: additionalProperties: false properties: expand: description: Specifies which fields in the response should be expanded. items: maxLength: 5000 type: string type: array type: object required: false responses: '200': content: application/json: schema: $ref: '#/components/schemas/treasury.outbound_payment' description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. '/v1/test_helpers/treasury/outbound_payments/{id}/return': post: description: >-

Transitions a test mode created OutboundPayment to the returned status. The OutboundPayment must already be in the processing state.

operationId: PostTestHelpersTreasuryOutboundPaymentsIdReturn parameters: - in: path name: id required: true schema: maxLength: 5000 type: string style: simple requestBody: content: application/x-www-form-urlencoded: encoding: expand: explode: true style: deepObject returned_details: explode: true style: deepObject schema: additionalProperties: false properties: expand: description: Specifies which fields in the response should be expanded. items: maxLength: 5000 type: string type: array returned_details: description: Optional hash to set the the return code. properties: code: enum: - account_closed - account_frozen - bank_account_restricted - bank_ownership_changed - declined - incorrect_account_holder_name - invalid_account_number - invalid_currency - no_account - other type: string title: returned_details_params type: object type: object required: false responses: '200': content: application/json: schema: $ref: '#/components/schemas/treasury.outbound_payment' description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. '/v1/test_helpers/treasury/outbound_transfers/{outbound_transfer}/fail': post: description: >-

Transitions a test mode created OutboundTransfer to the failed status. The OutboundTransfer must already be in the processing state.

operationId: PostTestHelpersTreasuryOutboundTransfersOutboundTransferFail parameters: - in: path name: outbound_transfer required: true schema: maxLength: 5000 type: string style: simple requestBody: content: application/x-www-form-urlencoded: encoding: expand: explode: true style: deepObject schema: additionalProperties: false properties: expand: description: Specifies which fields in the response should be expanded. items: maxLength: 5000 type: string type: array type: object required: false responses: '200': content: application/json: schema: $ref: '#/components/schemas/treasury.outbound_transfer' description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. '/v1/test_helpers/treasury/outbound_transfers/{outbound_transfer}/post': post: description: >-

Transitions a test mode created OutboundTransfer to the posted status. The OutboundTransfer must already be in the processing state.

operationId: PostTestHelpersTreasuryOutboundTransfersOutboundTransferPost parameters: - in: path name: outbound_transfer required: true schema: maxLength: 5000 type: string style: simple requestBody: content: application/x-www-form-urlencoded: encoding: expand: explode: true style: deepObject schema: additionalProperties: false properties: expand: description: Specifies which fields in the response should be expanded. items: maxLength: 5000 type: string type: array type: object required: false responses: '200': content: application/json: schema: $ref: '#/components/schemas/treasury.outbound_transfer' description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. '/v1/test_helpers/treasury/outbound_transfers/{outbound_transfer}/return': post: description: >-

Transitions a test mode created OutboundTransfer to the returned status. The OutboundTransfer must already be in the processing state.

operationId: PostTestHelpersTreasuryOutboundTransfersOutboundTransferReturn parameters: - in: path name: outbound_transfer required: true schema: maxLength: 5000 type: string style: simple requestBody: content: application/x-www-form-urlencoded: encoding: expand: explode: true style: deepObject returned_details: explode: true style: deepObject schema: additionalProperties: false properties: expand: description: Specifies which fields in the response should be expanded. items: maxLength: 5000 type: string type: array returned_details: description: Details about a returned OutboundTransfer. properties: code: enum: - account_closed - account_frozen - bank_account_restricted - bank_ownership_changed - declined - incorrect_account_holder_name - invalid_account_number - invalid_currency - no_account - other type: string title: returned_details_params type: object type: object required: false responses: '200': content: application/json: schema: $ref: '#/components/schemas/treasury.outbound_transfer' description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. /v1/test_helpers/treasury/received_credits: post: description: >-

Use this endpoint to simulate a test mode ReceivedCredit initiated by a third party. In live mode, you can’t directly create ReceivedCredits initiated by third parties.

operationId: PostTestHelpersTreasuryReceivedCredits requestBody: content: application/x-www-form-urlencoded: encoding: expand: explode: true style: deepObject initiating_payment_method_details: explode: true style: deepObject schema: additionalProperties: false properties: amount: description: Amount (in cents) to be transferred. type: integer currency: description: >- 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). type: string description: description: >- An arbitrary string attached to the object. Often useful for displaying to users. maxLength: 5000 type: string expand: description: Specifies which fields in the response should be expanded. items: maxLength: 5000 type: string type: array financial_account: description: The FinancialAccount to send funds to. type: string initiating_payment_method_details: description: Initiating payment method details for the object. properties: type: enum: - us_bank_account type: string us_bank_account: properties: account_holder_name: maxLength: 5000 type: string account_number: maxLength: 5000 type: string routing_number: maxLength: 5000 type: string title: us_bank_account_source_params type: object required: - type title: source_params type: object network: description: >- Specifies the network rails to be used. If not set, will default to the PaymentMethod's preferred network. See the [docs](https://stripe.com/docs/treasury/money-movement/timelines) to learn more about money movement timelines for each network type. enum: - ach - us_domestic_wire type: string required: - amount - currency - financial_account - network type: object required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/treasury.received_credit' description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. /v1/test_helpers/treasury/received_debits: post: description: >-

Use this endpoint to simulate a test mode ReceivedDebit initiated by a third party. In live mode, you can’t directly create ReceivedDebits initiated by third parties.

operationId: PostTestHelpersTreasuryReceivedDebits requestBody: content: application/x-www-form-urlencoded: encoding: expand: explode: true style: deepObject initiating_payment_method_details: explode: true style: deepObject schema: additionalProperties: false properties: amount: description: Amount (in cents) to be transferred. type: integer currency: description: >- 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). type: string description: description: >- An arbitrary string attached to the object. Often useful for displaying to users. maxLength: 5000 type: string expand: description: Specifies which fields in the response should be expanded. items: maxLength: 5000 type: string type: array financial_account: description: The FinancialAccount to pull funds from. type: string initiating_payment_method_details: description: Initiating payment method details for the object. properties: type: enum: - us_bank_account type: string us_bank_account: properties: account_holder_name: maxLength: 5000 type: string account_number: maxLength: 5000 type: string routing_number: maxLength: 5000 type: string title: us_bank_account_source_params type: object required: - type title: source_params type: object network: description: >- Specifies the network rails to be used. If not set, will default to the PaymentMethod's preferred network. See the [docs](https://stripe.com/docs/treasury/money-movement/timelines) to learn more about money movement timelines for each network type. enum: - ach type: string required: - amount - currency - financial_account - network type: object required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/treasury.received_debit' description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. /v1/tokens: post: description: >-

Creates a single-use token that represents a bank account’s details. You can use this token with any API method in place of a bank account dictionary. You can only use this token once. To do so, attach it to a Custom account.

operationId: PostTokens requestBody: content: application/x-www-form-urlencoded: encoding: account: explode: true style: deepObject bank_account: explode: true style: deepObject card: explode: true style: deepObject cvc_update: explode: true style: deepObject expand: explode: true style: deepObject person: explode: true style: deepObject pii: explode: true style: deepObject schema: additionalProperties: false properties: account: description: Information for the account this token represents. properties: business_type: enum: - company - government_entity - individual - non_profit type: string x-stripeBypassValidation: true company: properties: address: properties: city: maxLength: 100 type: string country: maxLength: 5000 type: string line1: maxLength: 200 type: string line2: maxLength: 200 type: string postal_code: maxLength: 5000 type: string state: maxLength: 5000 type: string title: address_specs type: object address_kana: properties: city: maxLength: 5000 type: string country: maxLength: 5000 type: string line1: maxLength: 5000 type: string line2: maxLength: 5000 type: string postal_code: maxLength: 5000 type: string state: maxLength: 5000 type: string town: maxLength: 5000 type: string title: japan_address_kana_specs type: object address_kanji: properties: city: maxLength: 5000 type: string country: maxLength: 5000 type: string line1: maxLength: 5000 type: string line2: maxLength: 5000 type: string postal_code: maxLength: 5000 type: string state: maxLength: 5000 type: string town: maxLength: 5000 type: string title: japan_address_kanji_specs type: object directors_provided: type: boolean executives_provided: type: boolean export_license_id: maxLength: 5000 type: string export_purpose_code: maxLength: 5000 type: string name: maxLength: 100 type: string name_kana: maxLength: 100 type: string name_kanji: maxLength: 100 type: string owners_provided: type: boolean ownership_declaration: properties: date: format: unix-time type: integer ip: type: string user_agent: maxLength: 5000 type: string title: company_ownership_declaration type: object ownership_declaration_shown_and_signed: type: boolean phone: maxLength: 5000 type: string registration_number: maxLength: 5000 type: string structure: enum: - '' - 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 type: string x-stripeBypassValidation: true tax_id: maxLength: 5000 type: string tax_id_registrar: maxLength: 5000 type: string vat_id: maxLength: 5000 type: string verification: properties: document: properties: back: maxLength: 500 type: string front: maxLength: 500 type: string title: verification_document_specs type: object title: verification_specs type: object title: connect_js_account_token_company_specs type: object individual: properties: address: properties: city: maxLength: 100 type: string country: maxLength: 5000 type: string line1: maxLength: 200 type: string line2: maxLength: 200 type: string postal_code: maxLength: 5000 type: string state: maxLength: 5000 type: string title: address_specs type: object address_kana: properties: city: maxLength: 5000 type: string country: maxLength: 5000 type: string line1: maxLength: 5000 type: string line2: maxLength: 5000 type: string postal_code: maxLength: 5000 type: string state: maxLength: 5000 type: string town: maxLength: 5000 type: string title: japan_address_kana_specs type: object address_kanji: properties: city: maxLength: 5000 type: string country: maxLength: 5000 type: string line1: maxLength: 5000 type: string line2: maxLength: 5000 type: string postal_code: maxLength: 5000 type: string state: maxLength: 5000 type: string town: maxLength: 5000 type: string title: japan_address_kanji_specs type: object dob: anyOf: - properties: day: type: integer month: type: integer year: type: integer required: - day - month - year title: date_of_birth_specs type: object - enum: - '' type: string email: type: string first_name: maxLength: 100 type: string first_name_kana: maxLength: 5000 type: string first_name_kanji: maxLength: 5000 type: string full_name_aliases: anyOf: - items: maxLength: 300 type: string type: array - enum: - '' type: string gender: type: string id_number: maxLength: 5000 type: string id_number_secondary: maxLength: 5000 type: string last_name: maxLength: 100 type: string last_name_kana: maxLength: 5000 type: string last_name_kanji: maxLength: 5000 type: string maiden_name: maxLength: 5000 type: string metadata: anyOf: - additionalProperties: type: string type: object - enum: - '' type: string phone: type: string political_exposure: enum: - existing - none type: string registered_address: properties: city: maxLength: 100 type: string country: maxLength: 5000 type: string line1: maxLength: 200 type: string line2: maxLength: 200 type: string postal_code: maxLength: 5000 type: string state: maxLength: 5000 type: string title: address_specs type: object relationship: properties: director: type: boolean executive: type: boolean owner: type: boolean percent_ownership: anyOf: - type: number - enum: - '' type: string title: maxLength: 5000 type: string title: individual_relationship_specs type: object ssn_last_4: maxLength: 5000 type: string verification: properties: additional_document: properties: back: maxLength: 500 type: string front: maxLength: 500 type: string title: person_verification_document_specs type: object document: properties: back: maxLength: 500 type: string front: maxLength: 500 type: string title: person_verification_document_specs type: object title: person_verification_specs type: object title: individual_specs type: object tos_shown_and_accepted: type: boolean title: connect_js_account_token_specs type: object bank_account: description: The bank account this token will represent. properties: account_holder_name: maxLength: 5000 type: string account_holder_type: enum: - company - individual maxLength: 5000 type: string account_number: maxLength: 5000 type: string account_type: enum: - checking - futsu - savings - toza maxLength: 5000 type: string country: maxLength: 5000 type: string currency: type: string payment_method: maxLength: 5000 type: string routing_number: maxLength: 5000 type: string required: - account_number - country title: token_create_bank_account type: object x-stripeBypassValidation: true card: anyOf: - properties: address_city: maxLength: 5000 type: string address_country: maxLength: 5000 type: string address_line1: maxLength: 5000 type: string address_line2: maxLength: 5000 type: string address_state: maxLength: 5000 type: string address_zip: maxLength: 5000 type: string currency: maxLength: 5000 type: string cvc: maxLength: 5000 type: string exp_month: maxLength: 5000 type: string exp_year: maxLength: 5000 type: string name: maxLength: 5000 type: string networks: properties: preferred: enum: - cartes_bancaires - mastercard - visa type: string title: networks_param_specs type: object number: maxLength: 5000 type: string required: - exp_month - exp_year - number title: credit_card_specs type: object - maxLength: 5000 type: string description: >- The card this token will represent. If you also pass in a customer, the card must be the ID of a card belonging to the customer. Otherwise, if you do not pass in a customer, this is a dictionary containing a user's credit card details, with the options described below. x-stripeBypassValidation: true customer: description: >- Create a token for the customer, which is owned by the application's account. You can only use this with an [OAuth access token](https://stripe.com/docs/connect/standard-accounts) or [Stripe-Account header](https://stripe.com/docs/connect/authentication). Learn more about [cloning saved payment methods](https://stripe.com/docs/connect/cloning-saved-payment-methods). maxLength: 5000 type: string cvc_update: description: The updated CVC value this token represents. properties: cvc: maxLength: 5000 type: string required: - cvc title: cvc_params type: object expand: description: Specifies which fields in the response should be expanded. items: maxLength: 5000 type: string type: array person: description: Information for the person this token represents. properties: additional_tos_acceptances: properties: account: properties: date: format: unix-time type: integer ip: type: string user_agent: anyOf: - maxLength: 5000 type: string - enum: - '' type: string title: settings_terms_of_service_specs type: object title: person_additional_tos_acceptances_specs type: object address: properties: city: maxLength: 100 type: string country: maxLength: 5000 type: string line1: maxLength: 200 type: string line2: maxLength: 200 type: string postal_code: maxLength: 5000 type: string state: maxLength: 5000 type: string title: address_specs type: object address_kana: properties: city: maxLength: 5000 type: string country: maxLength: 5000 type: string line1: maxLength: 5000 type: string line2: maxLength: 5000 type: string postal_code: maxLength: 5000 type: string state: maxLength: 5000 type: string town: maxLength: 5000 type: string title: japan_address_kana_specs type: object address_kanji: properties: city: maxLength: 5000 type: string country: maxLength: 5000 type: string line1: maxLength: 5000 type: string line2: maxLength: 5000 type: string postal_code: maxLength: 5000 type: string state: maxLength: 5000 type: string town: maxLength: 5000 type: string title: japan_address_kanji_specs type: object dob: anyOf: - properties: day: type: integer month: type: integer year: type: integer required: - day - month - year title: date_of_birth_specs type: object - enum: - '' type: string documents: properties: company_authorization: properties: files: items: anyOf: - maxLength: 500 type: string - enum: - '' type: string type: array title: documents_param type: object passport: properties: files: items: anyOf: - maxLength: 500 type: string - enum: - '' type: string type: array title: documents_param type: object visa: properties: files: items: anyOf: - maxLength: 500 type: string - enum: - '' type: string type: array title: documents_param type: object title: person_documents_specs type: object email: type: string first_name: maxLength: 5000 type: string first_name_kana: maxLength: 5000 type: string first_name_kanji: maxLength: 5000 type: string full_name_aliases: anyOf: - items: maxLength: 5000 type: string type: array - enum: - '' type: string gender: type: string id_number: maxLength: 5000 type: string id_number_secondary: maxLength: 5000 type: string last_name: maxLength: 5000 type: string last_name_kana: maxLength: 5000 type: string last_name_kanji: maxLength: 5000 type: string maiden_name: maxLength: 5000 type: string metadata: anyOf: - additionalProperties: type: string type: object - enum: - '' type: string nationality: maxLength: 5000 type: string phone: type: string political_exposure: maxLength: 5000 type: string registered_address: properties: city: maxLength: 100 type: string country: maxLength: 5000 type: string line1: maxLength: 200 type: string line2: maxLength: 200 type: string postal_code: maxLength: 5000 type: string state: maxLength: 5000 type: string title: address_specs type: object relationship: properties: director: type: boolean executive: type: boolean legal_guardian: type: boolean owner: type: boolean percent_ownership: anyOf: - type: number - enum: - '' type: string representative: type: boolean title: maxLength: 5000 type: string title: relationship_specs type: object ssn_last_4: type: string verification: properties: additional_document: properties: back: maxLength: 500 type: string front: maxLength: 500 type: string title: person_verification_document_specs type: object document: properties: back: maxLength: 500 type: string front: maxLength: 500 type: string title: person_verification_document_specs type: object title: person_verification_specs type: object title: person_token_specs type: object pii: description: The PII this token represents. properties: id_number: maxLength: 5000 type: string title: pii_token_specs type: object type: object required: false responses: '200': content: application/json: schema: $ref: '#/components/schemas/token' description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. '/v1/tokens/{token}': get: description:

Retrieves the token with the given ID.

operationId: GetTokensToken parameters: - description: Specifies which fields in the response should be expanded. explode: true in: query name: expand required: false schema: items: maxLength: 5000 type: string type: array style: deepObject - in: path name: token required: true schema: maxLength: 5000 type: string style: simple requestBody: content: application/x-www-form-urlencoded: encoding: {} schema: additionalProperties: false properties: {} type: object required: false responses: '200': content: application/json: schema: $ref: '#/components/schemas/token' description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. /v1/topups: get: description:

Returns a list of top-ups.

operationId: GetTopups parameters: - description: A positive integer representing how much to transfer. explode: true in: query name: amount required: false schema: anyOf: - properties: gt: type: integer gte: type: integer lt: type: integer lte: type: integer title: range_query_specs type: object - type: integer style: deepObject - description: >- A filter on the list, based on the object `created` field. The value can be a string with an integer Unix timestamp, or it can be a dictionary with a number of different query options. explode: true in: query name: created required: false schema: anyOf: - properties: gt: type: integer gte: type: integer lt: type: integer lte: type: integer title: range_query_specs type: object - type: integer style: deepObject - description: >- A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. in: query name: ending_before required: false schema: maxLength: 5000 type: string style: form - description: Specifies which fields in the response should be expanded. explode: true in: query name: expand required: false schema: items: maxLength: 5000 type: string type: array style: deepObject - description: >- A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. in: query name: limit required: false schema: type: integer style: form - description: >- A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. in: query name: starting_after required: false schema: maxLength: 5000 type: string style: form - description: >- Only return top-ups that have the given status. One of `canceled`, `failed`, `pending` or `succeeded`. in: query name: status required: false schema: enum: - canceled - failed - pending - succeeded maxLength: 5000 type: string style: form requestBody: content: application/x-www-form-urlencoded: encoding: {} schema: additionalProperties: false properties: {} type: object required: false responses: '200': content: application/json: schema: description: '' properties: data: items: $ref: '#/components/schemas/topup' type: array has_more: description: >- True if this list has another page of items after this one that can be fetched. type: boolean object: description: >- String representing the object's type. Objects of the same type share the same value. Always has the value `list`. enum: - list type: string url: description: The URL where this list can be accessed. maxLength: 5000 pattern: ^/v1/topups type: string required: - data - has_more - object - url title: TopupList type: object x-expandableFields: - data description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. post: description:

Top up the balance of an account

operationId: PostTopups requestBody: content: application/x-www-form-urlencoded: encoding: expand: explode: true style: deepObject metadata: explode: true style: deepObject schema: additionalProperties: false properties: amount: description: A positive integer representing how much to transfer. type: integer currency: description: >- 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). type: string description: description: >- An arbitrary string attached to the object. Often useful for displaying to users. maxLength: 5000 type: string expand: description: Specifies which fields in the response should be expanded. items: maxLength: 5000 type: string type: array metadata: anyOf: - additionalProperties: type: string type: object - enum: - '' type: string description: >- Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. source: description: >- The ID of a source to transfer funds from. For most users, this should be left unspecified which will use the bank account that was set up in the dashboard for the specified currency. In test mode, this can be a test bank token (see [Testing Top-ups](https://stripe.com/docs/connect/testing#testing-top-ups)). maxLength: 5000 type: string statement_descriptor: description: >- Extra information about a top-up for the source's bank statement. Limited to 15 ASCII characters. maxLength: 15 type: string transfer_group: description: A string that identifies this top-up as part of a group. type: string required: - amount - currency type: object required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/topup' description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. '/v1/topups/{topup}': get: description: >-

Retrieves the details of a top-up that has previously been created. Supply the unique top-up ID that was returned from your previous request, and Stripe will return the corresponding top-up information.

operationId: GetTopupsTopup parameters: - description: Specifies which fields in the response should be expanded. explode: true in: query name: expand required: false schema: items: maxLength: 5000 type: string type: array style: deepObject - in: path name: topup required: true schema: maxLength: 5000 type: string style: simple requestBody: content: application/x-www-form-urlencoded: encoding: {} schema: additionalProperties: false properties: {} type: object required: false responses: '200': content: application/json: schema: $ref: '#/components/schemas/topup' description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. post: description: >-

Updates the metadata of a top-up. Other top-up details are not editable by design.

operationId: PostTopupsTopup parameters: - in: path name: topup required: true schema: maxLength: 5000 type: string style: simple requestBody: content: application/x-www-form-urlencoded: encoding: expand: explode: true style: deepObject metadata: explode: true style: deepObject schema: additionalProperties: false properties: description: description: >- An arbitrary string attached to the object. Often useful for displaying to users. maxLength: 5000 type: string expand: description: Specifies which fields in the response should be expanded. items: maxLength: 5000 type: string type: array metadata: anyOf: - additionalProperties: type: string type: object - enum: - '' type: string description: >- Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. type: object required: false responses: '200': content: application/json: schema: $ref: '#/components/schemas/topup' description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. '/v1/topups/{topup}/cancel': post: description:

Cancels a top-up. Only pending top-ups can be canceled.

operationId: PostTopupsTopupCancel parameters: - in: path name: topup required: true schema: maxLength: 5000 type: string style: simple requestBody: content: application/x-www-form-urlencoded: encoding: expand: explode: true style: deepObject schema: additionalProperties: false properties: expand: description: Specifies which fields in the response should be expanded. items: maxLength: 5000 type: string type: array type: object required: false responses: '200': content: application/json: schema: $ref: '#/components/schemas/topup' description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. /v1/transfers: get: description: >-

Returns a list of existing transfers sent to connected accounts. The transfers are returned in sorted order, with the most recently created transfers appearing first.

operationId: GetTransfers parameters: - description: >- Only return transfers that were created during the given date interval. explode: true in: query name: created required: false schema: anyOf: - properties: gt: type: integer gte: type: integer lt: type: integer lte: type: integer title: range_query_specs type: object - type: integer style: deepObject - description: >- Only return transfers for the destination specified by this account ID. in: query name: destination required: false schema: maxLength: 5000 type: string style: form - description: >- A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. in: query name: ending_before required: false schema: maxLength: 5000 type: string style: form - description: Specifies which fields in the response should be expanded. explode: true in: query name: expand required: false schema: items: maxLength: 5000 type: string type: array style: deepObject - description: >- A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. in: query name: limit required: false schema: type: integer style: form - description: >- A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. in: query name: starting_after required: false schema: maxLength: 5000 type: string style: form - description: Only return transfers with the specified transfer group. in: query name: transfer_group required: false schema: maxLength: 5000 type: string style: form requestBody: content: application/x-www-form-urlencoded: encoding: {} schema: additionalProperties: false properties: {} type: object required: false responses: '200': content: application/json: schema: description: '' properties: data: description: Details about each object. items: $ref: '#/components/schemas/transfer' type: array has_more: description: >- True if this list has another page of items after this one that can be fetched. type: boolean object: description: >- String representing the object's type. Objects of the same type share the same value. Always has the value `list`. enum: - list type: string url: description: The URL where this list can be accessed. maxLength: 5000 pattern: ^/v1/transfers type: string required: - data - has_more - object - url title: TransferList type: object x-expandableFields: - data description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. post: description: >-

To send funds from your Stripe account to a connected account, you create a new transfer object. Your Stripe balance must be able to cover the transfer amount, or you’ll receive an “Insufficient Funds” error.

operationId: PostTransfers requestBody: content: application/x-www-form-urlencoded: encoding: expand: explode: true style: deepObject metadata: explode: true style: deepObject schema: additionalProperties: false properties: amount: description: >- A positive integer in cents (or local equivalent) representing how much to transfer. type: integer currency: description: >- 3-letter [ISO code for currency](https://stripe.com/docs/payouts). type: string description: description: >- An arbitrary string attached to the object. Often useful for displaying to users. maxLength: 5000 type: string destination: description: >- The ID of a connected Stripe account. See the Connect documentation for details. type: string expand: description: Specifies which fields in the response should be expanded. items: maxLength: 5000 type: string type: array metadata: additionalProperties: type: string description: >- Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. type: object source_transaction: description: >- You can use this parameter to transfer funds from a charge before they are added to your available balance. A pending balance will transfer immediately but the funds will not become available until the original charge becomes available. [See the Connect documentation](https://stripe.com/docs/connect/separate-charges-and-transfers#transfer-availability) for details. type: string source_type: description: >- The source balance to use for this transfer. One of `bank_account`, `card`, or `fpx`. For most users, this will default to `card`. enum: - bank_account - card - fpx maxLength: 5000 type: string x-stripeBypassValidation: true transfer_group: description: >- 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. type: string required: - currency - destination type: object required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/transfer' description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. '/v1/transfers/{id}/reversals': get: description: >-

You can see a list of the reversals belonging to a specific transfer. Note that the 10 most recent reversals are always available by default on the transfer object. If you need more than those 10, you can use this API method and the limit and starting_after parameters to page through additional reversals.

operationId: GetTransfersIdReversals parameters: - description: >- A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. in: query name: ending_before required: false schema: maxLength: 5000 type: string style: form - description: Specifies which fields in the response should be expanded. explode: true in: query name: expand required: false schema: items: maxLength: 5000 type: string type: array style: deepObject - in: path name: id required: true schema: maxLength: 5000 type: string style: simple - description: >- A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. in: query name: limit required: false schema: type: integer style: form - description: >- A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. in: query name: starting_after required: false schema: maxLength: 5000 type: string style: form requestBody: content: application/x-www-form-urlencoded: encoding: {} schema: additionalProperties: false properties: {} type: object required: false responses: '200': content: application/json: schema: description: '' properties: data: description: Details about each object. items: $ref: '#/components/schemas/transfer_reversal' type: array has_more: description: >- True if this list has another page of items after this one that can be fetched. type: boolean object: description: >- String representing the object's type. Objects of the same type share the same value. Always has the value `list`. enum: - list type: string url: description: The URL where this list can be accessed. maxLength: 5000 type: string required: - data - has_more - object - url title: TransferReversalList type: object x-expandableFields: - data description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. post: description: >-

When you create a new reversal, you must specify a transfer to create it on.

When reversing transfers, you can optionally reverse part of the transfer. You can do so as many times as you wish until the entire transfer has been reversed.

Once entirely reversed, a transfer can’t be reversed again. This method will return an error when called on an already-reversed transfer, or when trying to reverse more money than is left on a transfer.

operationId: PostTransfersIdReversals parameters: - in: path name: id required: true schema: maxLength: 5000 type: string style: simple requestBody: content: application/x-www-form-urlencoded: encoding: expand: explode: true style: deepObject metadata: explode: true style: deepObject schema: additionalProperties: false properties: amount: description: >- A positive integer in cents (or local equivalent) representing how much of this transfer to reverse. Can only reverse up to the unreversed amount remaining of the transfer. Partial transfer reversals are only allowed for transfers to Stripe Accounts. Defaults to the entire transfer amount. type: integer description: description: >- An arbitrary string which you can attach to a reversal object. It is displayed alongside the reversal in the Dashboard. This will be unset if you POST an empty value. maxLength: 5000 type: string expand: description: Specifies which fields in the response should be expanded. items: maxLength: 5000 type: string type: array metadata: anyOf: - additionalProperties: type: string type: object - enum: - '' type: string description: >- Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. refund_application_fee: description: >- Boolean indicating whether the application fee should be refunded when reversing this transfer. If a full transfer reversal is given, the full application fee will be refunded. Otherwise, the application fee will be refunded with an amount proportional to the amount of the transfer reversed. type: boolean type: object required: false responses: '200': content: application/json: schema: $ref: '#/components/schemas/transfer_reversal' description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. '/v1/transfers/{transfer}': get: description: >-

Retrieves the details of an existing transfer. Supply the unique transfer ID from either a transfer creation request or the transfer list, and Stripe will return the corresponding transfer information.

operationId: GetTransfersTransfer parameters: - description: Specifies which fields in the response should be expanded. explode: true in: query name: expand required: false schema: items: maxLength: 5000 type: string type: array style: deepObject - in: path name: transfer required: true schema: maxLength: 5000 type: string style: simple requestBody: content: application/x-www-form-urlencoded: encoding: {} schema: additionalProperties: false properties: {} type: object required: false responses: '200': content: application/json: schema: $ref: '#/components/schemas/transfer' description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. post: description: >-

Updates the specified transfer by setting the values of the parameters passed. Any parameters not provided will be left unchanged.

This request accepts only metadata as an argument.

operationId: PostTransfersTransfer parameters: - in: path name: transfer required: true schema: maxLength: 5000 type: string style: simple requestBody: content: application/x-www-form-urlencoded: encoding: expand: explode: true style: deepObject metadata: explode: true style: deepObject schema: additionalProperties: false properties: description: description: >- An arbitrary string attached to the object. Often useful for displaying to users. maxLength: 5000 type: string expand: description: Specifies which fields in the response should be expanded. items: maxLength: 5000 type: string type: array metadata: anyOf: - additionalProperties: type: string type: object - enum: - '' type: string description: >- Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. type: object required: false responses: '200': content: application/json: schema: $ref: '#/components/schemas/transfer' description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. '/v1/transfers/{transfer}/reversals/{id}': get: description: >-

By default, you can see the 10 most recent reversals stored directly on the transfer object, but you can also retrieve details about a specific reversal stored on the transfer.

operationId: GetTransfersTransferReversalsId parameters: - description: Specifies which fields in the response should be expanded. explode: true in: query name: expand required: false schema: items: maxLength: 5000 type: string type: array style: deepObject - in: path name: id required: true schema: maxLength: 5000 type: string style: simple - in: path name: transfer required: true schema: maxLength: 5000 type: string style: simple requestBody: content: application/x-www-form-urlencoded: encoding: {} schema: additionalProperties: false properties: {} type: object required: false responses: '200': content: application/json: schema: $ref: '#/components/schemas/transfer_reversal' description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. post: description: >-

Updates the specified reversal by setting the values of the parameters passed. Any parameters not provided will be left unchanged.

This request only accepts metadata and description as arguments.

operationId: PostTransfersTransferReversalsId parameters: - in: path name: id required: true schema: maxLength: 5000 type: string style: simple - in: path name: transfer required: true schema: maxLength: 5000 type: string style: simple requestBody: content: application/x-www-form-urlencoded: encoding: expand: explode: true style: deepObject metadata: explode: true style: deepObject schema: additionalProperties: false properties: expand: description: Specifies which fields in the response should be expanded. items: maxLength: 5000 type: string type: array metadata: anyOf: - additionalProperties: type: string type: object - enum: - '' type: string description: >- Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. type: object required: false responses: '200': content: application/json: schema: $ref: '#/components/schemas/transfer_reversal' description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. /v1/treasury/credit_reversals: get: description:

Returns a list of CreditReversals.

operationId: GetTreasuryCreditReversals parameters: - description: >- A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. in: query name: ending_before required: false schema: maxLength: 5000 type: string style: form - description: Specifies which fields in the response should be expanded. explode: true in: query name: expand required: false schema: items: maxLength: 5000 type: string type: array style: deepObject - description: Returns objects associated with this FinancialAccount. in: query name: financial_account required: true schema: type: string style: form - description: >- A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. in: query name: limit required: false schema: type: integer style: form - description: Only return CreditReversals for the ReceivedCredit ID. in: query name: received_credit required: false schema: maxLength: 5000 type: string style: form - description: >- A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. in: query name: starting_after required: false schema: maxLength: 5000 type: string style: form - description: Only return CreditReversals for a given status. in: query name: status required: false schema: enum: - canceled - posted - processing type: string style: form requestBody: content: application/x-www-form-urlencoded: encoding: {} schema: additionalProperties: false properties: {} type: object required: false responses: '200': content: application/json: schema: description: '' properties: data: description: Details about each object. items: $ref: '#/components/schemas/treasury.credit_reversal' type: array has_more: description: >- True if this list has another page of items after this one that can be fetched. type: boolean object: description: >- String representing the object's type. Objects of the same type share the same value. Always has the value `list`. enum: - list type: string url: description: The URL where this list can be accessed. maxLength: 5000 type: string required: - data - has_more - object - url title: TreasuryReceivedCreditsResourceCreditReversalList type: object x-expandableFields: - data description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. post: description:

Reverses a ReceivedCredit and creates a CreditReversal object.

operationId: PostTreasuryCreditReversals requestBody: content: application/x-www-form-urlencoded: encoding: expand: explode: true style: deepObject metadata: explode: true style: deepObject schema: additionalProperties: false properties: expand: description: Specifies which fields in the response should be expanded. items: maxLength: 5000 type: string type: array metadata: additionalProperties: type: string description: >- Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. type: object received_credit: description: The ReceivedCredit to reverse. maxLength: 5000 type: string required: - received_credit type: object required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/treasury.credit_reversal' description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. '/v1/treasury/credit_reversals/{credit_reversal}': get: description: >-

Retrieves the details of an existing CreditReversal by passing the unique CreditReversal ID from either the CreditReversal creation request or CreditReversal list

operationId: GetTreasuryCreditReversalsCreditReversal parameters: - in: path name: credit_reversal required: true schema: maxLength: 5000 type: string style: simple - description: Specifies which fields in the response should be expanded. explode: true in: query name: expand required: false schema: items: maxLength: 5000 type: string type: array style: deepObject requestBody: content: application/x-www-form-urlencoded: encoding: {} schema: additionalProperties: false properties: {} type: object required: false responses: '200': content: application/json: schema: $ref: '#/components/schemas/treasury.credit_reversal' description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. /v1/treasury/debit_reversals: get: description:

Returns a list of DebitReversals.

operationId: GetTreasuryDebitReversals parameters: - description: >- A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. in: query name: ending_before required: false schema: maxLength: 5000 type: string style: form - description: Specifies which fields in the response should be expanded. explode: true in: query name: expand required: false schema: items: maxLength: 5000 type: string type: array style: deepObject - description: Returns objects associated with this FinancialAccount. in: query name: financial_account required: true schema: type: string style: form - description: >- A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. in: query name: limit required: false schema: type: integer style: form - description: Only return DebitReversals for the ReceivedDebit ID. in: query name: received_debit required: false schema: maxLength: 5000 type: string style: form - description: Only return DebitReversals for a given resolution. in: query name: resolution required: false schema: enum: - lost - won type: string style: form - description: >- A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. in: query name: starting_after required: false schema: maxLength: 5000 type: string style: form - description: Only return DebitReversals for a given status. in: query name: status required: false schema: enum: - canceled - completed - processing type: string style: form requestBody: content: application/x-www-form-urlencoded: encoding: {} schema: additionalProperties: false properties: {} type: object required: false responses: '200': content: application/json: schema: description: '' properties: data: description: Details about each object. items: $ref: '#/components/schemas/treasury.debit_reversal' type: array has_more: description: >- True if this list has another page of items after this one that can be fetched. type: boolean object: description: >- String representing the object's type. Objects of the same type share the same value. Always has the value `list`. enum: - list type: string url: description: The URL where this list can be accessed. maxLength: 5000 type: string required: - data - has_more - object - url title: TreasuryReceivedDebitsResourceDebitReversalList type: object x-expandableFields: - data description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. post: description:

Reverses a ReceivedDebit and creates a DebitReversal object.

operationId: PostTreasuryDebitReversals requestBody: content: application/x-www-form-urlencoded: encoding: expand: explode: true style: deepObject metadata: explode: true style: deepObject schema: additionalProperties: false properties: expand: description: Specifies which fields in the response should be expanded. items: maxLength: 5000 type: string type: array metadata: additionalProperties: type: string description: >- Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. type: object received_debit: description: The ReceivedDebit to reverse. maxLength: 5000 type: string required: - received_debit type: object required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/treasury.debit_reversal' description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. '/v1/treasury/debit_reversals/{debit_reversal}': get: description:

Retrieves a DebitReversal object.

operationId: GetTreasuryDebitReversalsDebitReversal parameters: - in: path name: debit_reversal required: true schema: maxLength: 5000 type: string style: simple - description: Specifies which fields in the response should be expanded. explode: true in: query name: expand required: false schema: items: maxLength: 5000 type: string type: array style: deepObject requestBody: content: application/x-www-form-urlencoded: encoding: {} schema: additionalProperties: false properties: {} type: object required: false responses: '200': content: application/json: schema: $ref: '#/components/schemas/treasury.debit_reversal' description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. /v1/treasury/financial_accounts: get: description:

Returns a list of FinancialAccounts.

operationId: GetTreasuryFinancialAccounts parameters: - description: >- Only return FinancialAccounts that were created during the given date interval. explode: true in: query name: created required: false schema: anyOf: - properties: gt: type: integer gte: type: integer lt: type: integer lte: type: integer title: range_query_specs type: object - type: integer style: deepObject - description: An object ID cursor for use in pagination. in: query name: ending_before required: false schema: maxLength: 5000 type: string style: form - description: Specifies which fields in the response should be expanded. explode: true in: query name: expand required: false schema: items: maxLength: 5000 type: string type: array style: deepObject - description: A limit ranging from 1 to 100 (defaults to 10). in: query name: limit required: false schema: type: integer style: form - description: An object ID cursor for use in pagination. in: query name: starting_after required: false schema: maxLength: 5000 type: string style: form requestBody: content: application/x-www-form-urlencoded: encoding: {} schema: additionalProperties: false properties: {} type: object required: false responses: '200': content: application/json: schema: description: '' properties: data: items: $ref: '#/components/schemas/treasury.financial_account' type: array has_more: description: >- True if this list has another page of items after this one that can be fetched. type: boolean object: description: >- String representing the object's type. Objects of the same type share the same value. Always has the value `list`. enum: - list type: string url: description: The URL where this list can be accessed. maxLength: 5000 pattern: ^/v1/treasury/financial_accounts type: string required: - data - has_more - object - url title: TreasuryFinancialAccountsResourceFinancialAccountList type: object x-expandableFields: - data description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. post: description: >-

Creates a new FinancialAccount. For now, each connected account can only have one FinancialAccount.

operationId: PostTreasuryFinancialAccounts requestBody: content: application/x-www-form-urlencoded: encoding: expand: explode: true style: deepObject features: explode: true style: deepObject metadata: explode: true style: deepObject platform_restrictions: explode: true style: deepObject supported_currencies: explode: true style: deepObject schema: additionalProperties: false properties: expand: description: Specifies which fields in the response should be expanded. items: maxLength: 5000 type: string type: array features: description: >- Encodes whether a FinancialAccount has access to a particular feature. Stripe or the platform can control features via the requested field. properties: card_issuing: properties: requested: type: boolean required: - requested title: access type: object deposit_insurance: properties: requested: type: boolean required: - requested title: access type: object financial_addresses: properties: aba: properties: requested: type: boolean required: - requested title: aba_access type: object title: financial_addresses type: object inbound_transfers: properties: ach: properties: requested: type: boolean required: - requested title: access_with_ach_details type: object title: inbound_transfers type: object intra_stripe_flows: properties: requested: type: boolean required: - requested title: access type: object outbound_payments: properties: ach: properties: requested: type: boolean required: - requested title: access_with_ach_details type: object us_domestic_wire: properties: requested: type: boolean required: - requested title: access type: object title: outbound_payments type: object outbound_transfers: properties: ach: properties: requested: type: boolean required: - requested title: access_with_ach_details type: object us_domestic_wire: properties: requested: type: boolean required: - requested title: access type: object title: outbound_transfers type: object title: feature_access type: object metadata: additionalProperties: type: string description: >- Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. type: object platform_restrictions: description: >- The set of functionalities that the platform can restrict on the FinancialAccount. properties: inbound_flows: enum: - restricted - unrestricted type: string outbound_flows: enum: - restricted - unrestricted type: string title: platform_restrictions type: object supported_currencies: description: The currencies the FinancialAccount can hold a balance in. items: maxLength: 5000 type: string type: array required: - supported_currencies type: object required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/treasury.financial_account' description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. '/v1/treasury/financial_accounts/{financial_account}': get: description:

Retrieves the details of a FinancialAccount.

operationId: GetTreasuryFinancialAccountsFinancialAccount parameters: - description: Specifies which fields in the response should be expanded. explode: true in: query name: expand required: false schema: items: maxLength: 5000 type: string type: array style: deepObject - in: path name: financial_account required: true schema: maxLength: 5000 type: string style: simple requestBody: content: application/x-www-form-urlencoded: encoding: {} schema: additionalProperties: false properties: {} type: object required: false responses: '200': content: application/json: schema: $ref: '#/components/schemas/treasury.financial_account' description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. post: description:

Updates the details of a FinancialAccount.

operationId: PostTreasuryFinancialAccountsFinancialAccount parameters: - in: path name: financial_account required: true schema: maxLength: 5000 type: string style: simple requestBody: content: application/x-www-form-urlencoded: encoding: expand: explode: true style: deepObject features: explode: true style: deepObject metadata: explode: true style: deepObject platform_restrictions: explode: true style: deepObject schema: additionalProperties: false properties: expand: description: Specifies which fields in the response should be expanded. items: maxLength: 5000 type: string type: array features: description: >- Encodes whether a FinancialAccount has access to a particular feature, with a status enum and associated `status_details`. Stripe or the platform may control features via the requested field. properties: card_issuing: properties: requested: type: boolean required: - requested title: access type: object deposit_insurance: properties: requested: type: boolean required: - requested title: access type: object financial_addresses: properties: aba: properties: requested: type: boolean required: - requested title: aba_access type: object title: financial_addresses type: object inbound_transfers: properties: ach: properties: requested: type: boolean required: - requested title: access_with_ach_details type: object title: inbound_transfers type: object intra_stripe_flows: properties: requested: type: boolean required: - requested title: access type: object outbound_payments: properties: ach: properties: requested: type: boolean required: - requested title: access_with_ach_details type: object us_domestic_wire: properties: requested: type: boolean required: - requested title: access type: object title: outbound_payments type: object outbound_transfers: properties: ach: properties: requested: type: boolean required: - requested title: access_with_ach_details type: object us_domestic_wire: properties: requested: type: boolean required: - requested title: access type: object title: outbound_transfers type: object title: feature_access type: object metadata: additionalProperties: type: string description: >- Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. type: object platform_restrictions: description: >- The set of functionalities that the platform can restrict on the FinancialAccount. properties: inbound_flows: enum: - restricted - unrestricted type: string outbound_flows: enum: - restricted - unrestricted type: string title: platform_restrictions type: object type: object required: false responses: '200': content: application/json: schema: $ref: '#/components/schemas/treasury.financial_account' description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. '/v1/treasury/financial_accounts/{financial_account}/features': get: description: >-

Retrieves Features information associated with the FinancialAccount.

operationId: GetTreasuryFinancialAccountsFinancialAccountFeatures parameters: - description: Specifies which fields in the response should be expanded. explode: true in: query name: expand required: false schema: items: maxLength: 5000 type: string type: array style: deepObject - in: path name: financial_account required: true schema: maxLength: 5000 type: string style: simple requestBody: content: application/x-www-form-urlencoded: encoding: {} schema: additionalProperties: false properties: {} type: object required: false responses: '200': content: application/json: schema: $ref: '#/components/schemas/treasury.financial_account_features' description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. post: description:

Updates the Features associated with a FinancialAccount.

operationId: PostTreasuryFinancialAccountsFinancialAccountFeatures parameters: - in: path name: financial_account required: true schema: maxLength: 5000 type: string style: simple requestBody: content: application/x-www-form-urlencoded: encoding: card_issuing: explode: true style: deepObject deposit_insurance: explode: true style: deepObject expand: explode: true style: deepObject financial_addresses: explode: true style: deepObject inbound_transfers: explode: true style: deepObject intra_stripe_flows: explode: true style: deepObject outbound_payments: explode: true style: deepObject outbound_transfers: explode: true style: deepObject schema: additionalProperties: false properties: card_issuing: description: >- Encodes the FinancialAccount's ability to be used with the Issuing product, including attaching cards to and drawing funds from the FinancialAccount. properties: requested: type: boolean required: - requested title: access type: object deposit_insurance: description: >- Represents whether this FinancialAccount is eligible for deposit insurance. Various factors determine the insurance amount. properties: requested: type: boolean required: - requested title: access type: object expand: description: Specifies which fields in the response should be expanded. items: maxLength: 5000 type: string type: array financial_addresses: description: >- Contains Features that add FinancialAddresses to the FinancialAccount. properties: aba: properties: requested: type: boolean required: - requested title: aba_access type: object title: financial_addresses type: object inbound_transfers: description: >- Contains settings related to adding funds to a FinancialAccount from another Account with the same owner. properties: ach: properties: requested: type: boolean required: - requested title: access_with_ach_details type: object title: inbound_transfers type: object intra_stripe_flows: description: >- Represents the ability for the FinancialAccount to send money to, or receive money from other FinancialAccounts (for example, via OutboundPayment). properties: requested: type: boolean required: - requested title: access type: object outbound_payments: description: >- Includes Features related to initiating money movement out of the FinancialAccount to someone else's bucket of money. properties: ach: properties: requested: type: boolean required: - requested title: access_with_ach_details type: object us_domestic_wire: properties: requested: type: boolean required: - requested title: access type: object title: outbound_payments type: object outbound_transfers: description: >- Contains a Feature and settings related to moving money out of the FinancialAccount into another Account with the same owner. properties: ach: properties: requested: type: boolean required: - requested title: access_with_ach_details type: object us_domestic_wire: properties: requested: type: boolean required: - requested title: access type: object title: outbound_transfers type: object type: object required: false responses: '200': content: application/json: schema: $ref: '#/components/schemas/treasury.financial_account_features' description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. /v1/treasury/inbound_transfers: get: description: >-

Returns a list of InboundTransfers sent from the specified FinancialAccount.

operationId: GetTreasuryInboundTransfers parameters: - description: >- A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. in: query name: ending_before required: false schema: maxLength: 5000 type: string style: form - description: Specifies which fields in the response should be expanded. explode: true in: query name: expand required: false schema: items: maxLength: 5000 type: string type: array style: deepObject - description: Returns objects associated with this FinancialAccount. in: query name: financial_account required: true schema: type: string style: form - description: >- A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. in: query name: limit required: false schema: type: integer style: form - description: >- A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. in: query name: starting_after required: false schema: maxLength: 5000 type: string style: form - description: >- Only return InboundTransfers that have the given status: `processing`, `succeeded`, `failed` or `canceled`. in: query name: status required: false schema: enum: - canceled - failed - processing - succeeded type: string style: form requestBody: content: application/x-www-form-urlencoded: encoding: {} schema: additionalProperties: false properties: {} type: object required: false responses: '200': content: application/json: schema: description: '' properties: data: description: Details about each object. items: $ref: '#/components/schemas/treasury.inbound_transfer' type: array has_more: description: >- True if this list has another page of items after this one that can be fetched. type: boolean object: description: >- String representing the object's type. Objects of the same type share the same value. Always has the value `list`. enum: - list type: string url: description: The URL where this list can be accessed. maxLength: 5000 type: string required: - data - has_more - object - url title: TreasuryInboundTransfersResourceInboundTransferList type: object x-expandableFields: - data description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. post: description:

Creates an InboundTransfer.

operationId: PostTreasuryInboundTransfers requestBody: content: application/x-www-form-urlencoded: encoding: expand: explode: true style: deepObject metadata: explode: true style: deepObject schema: additionalProperties: false properties: amount: description: Amount (in cents) to be transferred. type: integer currency: description: >- 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). type: string description: description: >- An arbitrary string attached to the object. Often useful for displaying to users. maxLength: 5000 type: string expand: description: Specifies which fields in the response should be expanded. items: maxLength: 5000 type: string type: array financial_account: description: The FinancialAccount to send funds to. type: string metadata: additionalProperties: type: string description: >- Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. type: object origin_payment_method: description: >- The origin payment method to be debited for the InboundTransfer. maxLength: 5000 type: string statement_descriptor: description: >- The complete description that appears on your customers' statements. Maximum 10 characters. maxLength: 10 type: string required: - amount - currency - financial_account - origin_payment_method type: object required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/treasury.inbound_transfer' description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. '/v1/treasury/inbound_transfers/{id}': get: description:

Retrieves the details of an existing InboundTransfer.

operationId: GetTreasuryInboundTransfersId parameters: - description: Specifies which fields in the response should be expanded. explode: true in: query name: expand required: false schema: items: maxLength: 5000 type: string type: array style: deepObject - in: path name: id required: true schema: maxLength: 5000 type: string style: simple requestBody: content: application/x-www-form-urlencoded: encoding: {} schema: additionalProperties: false properties: {} type: object required: false responses: '200': content: application/json: schema: $ref: '#/components/schemas/treasury.inbound_transfer' description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. '/v1/treasury/inbound_transfers/{inbound_transfer}/cancel': post: description:

Cancels an InboundTransfer.

operationId: PostTreasuryInboundTransfersInboundTransferCancel parameters: - in: path name: inbound_transfer required: true schema: maxLength: 5000 type: string style: simple requestBody: content: application/x-www-form-urlencoded: encoding: expand: explode: true style: deepObject schema: additionalProperties: false properties: expand: description: Specifies which fields in the response should be expanded. items: maxLength: 5000 type: string type: array type: object required: false responses: '200': content: application/json: schema: $ref: '#/components/schemas/treasury.inbound_transfer' description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. /v1/treasury/outbound_payments: get: description: >-

Returns a list of OutboundPayments sent from the specified FinancialAccount.

operationId: GetTreasuryOutboundPayments parameters: - description: >- Only return OutboundPayments that were created during the given date interval. explode: true in: query name: created required: false schema: anyOf: - properties: gt: type: integer gte: type: integer lt: type: integer lte: type: integer title: range_query_specs type: object - type: integer style: deepObject - description: Only return OutboundPayments sent to this customer. in: query name: customer required: false schema: maxLength: 5000 type: string style: form - description: >- A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. in: query name: ending_before required: false schema: maxLength: 5000 type: string style: form - description: Specifies which fields in the response should be expanded. explode: true in: query name: expand required: false schema: items: maxLength: 5000 type: string type: array style: deepObject - description: Returns objects associated with this FinancialAccount. in: query name: financial_account required: true schema: type: string style: form - description: >- A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. in: query name: limit required: false schema: type: integer style: form - description: >- A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. in: query name: starting_after required: false schema: maxLength: 5000 type: string style: form - description: >- Only return OutboundPayments that have the given status: `processing`, `failed`, `posted`, `returned`, or `canceled`. in: query name: status required: false schema: enum: - canceled - failed - posted - processing - returned type: string style: form requestBody: content: application/x-www-form-urlencoded: encoding: {} schema: additionalProperties: false properties: {} type: object required: false responses: '200': content: application/json: schema: description: '' properties: data: description: Details about each object. items: $ref: '#/components/schemas/treasury.outbound_payment' type: array has_more: description: >- True if this list has another page of items after this one that can be fetched. type: boolean object: description: >- String representing the object's type. Objects of the same type share the same value. Always has the value `list`. enum: - list type: string url: description: The URL where this list can be accessed. maxLength: 5000 pattern: ^/v1/treasury/outbound_payments type: string required: - data - has_more - object - url title: TreasuryOutboundPaymentsResourceOutboundPaymentList type: object x-expandableFields: - data description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. post: description:

Creates an OutboundPayment.

operationId: PostTreasuryOutboundPayments requestBody: content: application/x-www-form-urlencoded: encoding: destination_payment_method_data: explode: true style: deepObject destination_payment_method_options: explode: true style: deepObject end_user_details: explode: true style: deepObject expand: explode: true style: deepObject metadata: explode: true style: deepObject schema: additionalProperties: false properties: amount: description: Amount (in cents) to be transferred. type: integer currency: description: >- 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). type: string customer: description: >- ID of the customer to whom the OutboundPayment is sent. Must match the Customer attached to the `destination_payment_method` passed in. maxLength: 5000 type: string description: description: >- An arbitrary string attached to the object. Often useful for displaying to users. maxLength: 5000 type: string destination_payment_method: description: >- The PaymentMethod to use as the payment instrument for the OutboundPayment. Exclusive with `destination_payment_method_data`. maxLength: 5000 type: string destination_payment_method_data: description: >- Hash used to generate the PaymentMethod to be used for this OutboundPayment. Exclusive with `destination_payment_method`. properties: billing_details: properties: address: anyOf: - properties: city: maxLength: 5000 type: string country: maxLength: 5000 type: string line1: maxLength: 5000 type: string line2: maxLength: 5000 type: string postal_code: maxLength: 5000 type: string state: maxLength: 5000 type: string title: billing_details_address type: object - enum: - '' type: string email: anyOf: - type: string - enum: - '' type: string name: anyOf: - maxLength: 5000 type: string - enum: - '' type: string phone: anyOf: - maxLength: 5000 type: string - enum: - '' type: string title: billing_details_inner_params type: object financial_account: type: string metadata: additionalProperties: type: string type: object type: enum: - financial_account - us_bank_account type: string us_bank_account: properties: account_holder_type: enum: - company - individual type: string account_number: maxLength: 5000 type: string account_type: enum: - checking - savings type: string financial_connections_account: maxLength: 5000 type: string routing_number: maxLength: 5000 type: string title: payment_method_param type: object required: - type title: payment_method_data type: object destination_payment_method_options: description: >- Payment method-specific configuration for this OutboundPayment. properties: us_bank_account: anyOf: - properties: network: enum: - ach - us_domestic_wire type: string title: payment_method_options_param type: object - enum: - '' type: string title: payment_method_options type: object end_user_details: description: End user details. properties: ip_address: type: string present: type: boolean required: - present title: end_user_details_params type: object expand: description: Specifies which fields in the response should be expanded. items: maxLength: 5000 type: string type: array financial_account: description: The FinancialAccount to pull funds from. type: string metadata: additionalProperties: type: string description: >- Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. type: object statement_descriptor: description: >- The description that appears on the receiving end for this OutboundPayment (for example, bank statement for external bank transfer). Maximum 10 characters for `ach` payments, 140 characters for `us_domestic_wire` payments, or 500 characters for `stripe` network transfers. The default value is "payment". maxLength: 5000 type: string required: - amount - currency - financial_account type: object required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/treasury.outbound_payment' description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. '/v1/treasury/outbound_payments/{id}': get: description: >-

Retrieves the details of an existing OutboundPayment by passing the unique OutboundPayment ID from either the OutboundPayment creation request or OutboundPayment list.

operationId: GetTreasuryOutboundPaymentsId parameters: - description: Specifies which fields in the response should be expanded. explode: true in: query name: expand required: false schema: items: maxLength: 5000 type: string type: array style: deepObject - in: path name: id required: true schema: maxLength: 5000 type: string style: simple requestBody: content: application/x-www-form-urlencoded: encoding: {} schema: additionalProperties: false properties: {} type: object required: false responses: '200': content: application/json: schema: $ref: '#/components/schemas/treasury.outbound_payment' description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. '/v1/treasury/outbound_payments/{id}/cancel': post: description:

Cancel an OutboundPayment.

operationId: PostTreasuryOutboundPaymentsIdCancel parameters: - in: path name: id required: true schema: maxLength: 5000 type: string style: simple requestBody: content: application/x-www-form-urlencoded: encoding: expand: explode: true style: deepObject schema: additionalProperties: false properties: expand: description: Specifies which fields in the response should be expanded. items: maxLength: 5000 type: string type: array type: object required: false responses: '200': content: application/json: schema: $ref: '#/components/schemas/treasury.outbound_payment' description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. /v1/treasury/outbound_transfers: get: description: >-

Returns a list of OutboundTransfers sent from the specified FinancialAccount.

operationId: GetTreasuryOutboundTransfers parameters: - description: >- A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. in: query name: ending_before required: false schema: maxLength: 5000 type: string style: form - description: Specifies which fields in the response should be expanded. explode: true in: query name: expand required: false schema: items: maxLength: 5000 type: string type: array style: deepObject - description: Returns objects associated with this FinancialAccount. in: query name: financial_account required: true schema: type: string style: form - description: >- A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. in: query name: limit required: false schema: type: integer style: form - description: >- A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. in: query name: starting_after required: false schema: maxLength: 5000 type: string style: form - description: >- Only return OutboundTransfers that have the given status: `processing`, `canceled`, `failed`, `posted`, or `returned`. in: query name: status required: false schema: enum: - canceled - failed - posted - processing - returned type: string style: form requestBody: content: application/x-www-form-urlencoded: encoding: {} schema: additionalProperties: false properties: {} type: object required: false responses: '200': content: application/json: schema: description: '' properties: data: description: Details about each object. items: $ref: '#/components/schemas/treasury.outbound_transfer' type: array has_more: description: >- True if this list has another page of items after this one that can be fetched. type: boolean object: description: >- String representing the object's type. Objects of the same type share the same value. Always has the value `list`. enum: - list type: string url: description: The URL where this list can be accessed. maxLength: 5000 type: string required: - data - has_more - object - url title: TreasuryOutboundTransfersResourceOutboundTransferList type: object x-expandableFields: - data description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. post: description:

Creates an OutboundTransfer.

operationId: PostTreasuryOutboundTransfers requestBody: content: application/x-www-form-urlencoded: encoding: destination_payment_method_options: explode: true style: deepObject expand: explode: true style: deepObject metadata: explode: true style: deepObject schema: additionalProperties: false properties: amount: description: Amount (in cents) to be transferred. type: integer currency: description: >- 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). type: string description: description: >- An arbitrary string attached to the object. Often useful for displaying to users. maxLength: 5000 type: string destination_payment_method: description: >- The PaymentMethod to use as the payment instrument for the OutboundTransfer. maxLength: 5000 type: string destination_payment_method_options: description: Hash describing payment method configuration details. properties: us_bank_account: anyOf: - properties: network: enum: - ach - us_domestic_wire type: string title: payment_method_options_param type: object - enum: - '' type: string title: payment_method_options type: object expand: description: Specifies which fields in the response should be expanded. items: maxLength: 5000 type: string type: array financial_account: description: The FinancialAccount to pull funds from. type: string metadata: additionalProperties: type: string description: >- Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. type: object statement_descriptor: description: >- Statement descriptor to be shown on the receiving end of an OutboundTransfer. Maximum 10 characters for `ach` transfers or 140 characters for `us_domestic_wire` transfers. The default value is "transfer". maxLength: 5000 type: string required: - amount - currency - financial_account type: object required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/treasury.outbound_transfer' description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. '/v1/treasury/outbound_transfers/{outbound_transfer}': get: description: >-

Retrieves the details of an existing OutboundTransfer by passing the unique OutboundTransfer ID from either the OutboundTransfer creation request or OutboundTransfer list.

operationId: GetTreasuryOutboundTransfersOutboundTransfer parameters: - description: Specifies which fields in the response should be expanded. explode: true in: query name: expand required: false schema: items: maxLength: 5000 type: string type: array style: deepObject - in: path name: outbound_transfer required: true schema: maxLength: 5000 type: string style: simple requestBody: content: application/x-www-form-urlencoded: encoding: {} schema: additionalProperties: false properties: {} type: object required: false responses: '200': content: application/json: schema: $ref: '#/components/schemas/treasury.outbound_transfer' description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. '/v1/treasury/outbound_transfers/{outbound_transfer}/cancel': post: description: >-

An OutboundTransfer can be canceled if the funds have not yet been paid out.

operationId: PostTreasuryOutboundTransfersOutboundTransferCancel parameters: - in: path name: outbound_transfer required: true schema: maxLength: 5000 type: string style: simple requestBody: content: application/x-www-form-urlencoded: encoding: expand: explode: true style: deepObject schema: additionalProperties: false properties: expand: description: Specifies which fields in the response should be expanded. items: maxLength: 5000 type: string type: array type: object required: false responses: '200': content: application/json: schema: $ref: '#/components/schemas/treasury.outbound_transfer' description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. /v1/treasury/received_credits: get: description:

Returns a list of ReceivedCredits.

operationId: GetTreasuryReceivedCredits parameters: - description: >- A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. in: query name: ending_before required: false schema: maxLength: 5000 type: string style: form - description: Specifies which fields in the response should be expanded. explode: true in: query name: expand required: false schema: items: maxLength: 5000 type: string type: array style: deepObject - description: The FinancialAccount that received the funds. in: query name: financial_account required: true schema: type: string style: form - description: >- A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. in: query name: limit required: false schema: type: integer style: form - description: Only return ReceivedCredits described by the flow. explode: true in: query name: linked_flows required: false schema: properties: source_flow_type: enum: - credit_reversal - other - outbound_payment - payout type: string x-stripeBypassValidation: true required: - source_flow_type title: linked_flows_param type: object style: deepObject - description: >- A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. in: query name: starting_after required: false schema: maxLength: 5000 type: string style: form - description: >- Only return ReceivedCredits that have the given status: `succeeded` or `failed`. in: query name: status required: false schema: enum: - failed - succeeded type: string x-stripeBypassValidation: true style: form requestBody: content: application/x-www-form-urlencoded: encoding: {} schema: additionalProperties: false properties: {} type: object required: false responses: '200': content: application/json: schema: description: '' properties: data: description: Details about each object. items: $ref: '#/components/schemas/treasury.received_credit' type: array has_more: description: >- True if this list has another page of items after this one that can be fetched. type: boolean object: description: >- String representing the object's type. Objects of the same type share the same value. Always has the value `list`. enum: - list type: string url: description: The URL where this list can be accessed. maxLength: 5000 type: string required: - data - has_more - object - url title: TreasuryReceivedCreditsResourceReceivedCreditList type: object x-expandableFields: - data description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. '/v1/treasury/received_credits/{id}': get: description: >-

Retrieves the details of an existing ReceivedCredit by passing the unique ReceivedCredit ID from the ReceivedCredit list.

operationId: GetTreasuryReceivedCreditsId parameters: - description: Specifies which fields in the response should be expanded. explode: true in: query name: expand required: false schema: items: maxLength: 5000 type: string type: array style: deepObject - in: path name: id required: true schema: maxLength: 5000 type: string style: simple requestBody: content: application/x-www-form-urlencoded: encoding: {} schema: additionalProperties: false properties: {} type: object required: false responses: '200': content: application/json: schema: $ref: '#/components/schemas/treasury.received_credit' description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. /v1/treasury/received_debits: get: description:

Returns a list of ReceivedDebits.

operationId: GetTreasuryReceivedDebits parameters: - description: >- A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. in: query name: ending_before required: false schema: maxLength: 5000 type: string style: form - description: Specifies which fields in the response should be expanded. explode: true in: query name: expand required: false schema: items: maxLength: 5000 type: string type: array style: deepObject - description: The FinancialAccount that funds were pulled from. in: query name: financial_account required: true schema: type: string style: form - description: >- A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. in: query name: limit required: false schema: type: integer style: form - description: >- A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. in: query name: starting_after required: false schema: maxLength: 5000 type: string style: form - description: >- Only return ReceivedDebits that have the given status: `succeeded` or `failed`. in: query name: status required: false schema: enum: - failed - succeeded type: string x-stripeBypassValidation: true style: form requestBody: content: application/x-www-form-urlencoded: encoding: {} schema: additionalProperties: false properties: {} type: object required: false responses: '200': content: application/json: schema: description: '' properties: data: description: Details about each object. items: $ref: '#/components/schemas/treasury.received_debit' type: array has_more: description: >- True if this list has another page of items after this one that can be fetched. type: boolean object: description: >- String representing the object's type. Objects of the same type share the same value. Always has the value `list`. enum: - list type: string url: description: The URL where this list can be accessed. maxLength: 5000 type: string required: - data - has_more - object - url title: TreasuryReceivedDebitsResourceReceivedDebitList type: object x-expandableFields: - data description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. '/v1/treasury/received_debits/{id}': get: description: >-

Retrieves the details of an existing ReceivedDebit by passing the unique ReceivedDebit ID from the ReceivedDebit list

operationId: GetTreasuryReceivedDebitsId parameters: - description: Specifies which fields in the response should be expanded. explode: true in: query name: expand required: false schema: items: maxLength: 5000 type: string type: array style: deepObject - in: path name: id required: true schema: maxLength: 5000 type: string style: simple requestBody: content: application/x-www-form-urlencoded: encoding: {} schema: additionalProperties: false properties: {} type: object required: false responses: '200': content: application/json: schema: $ref: '#/components/schemas/treasury.received_debit' description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. /v1/treasury/transaction_entries: get: description:

Retrieves a list of TransactionEntry objects.

operationId: GetTreasuryTransactionEntries parameters: - description: >- Only return TransactionEntries that were created during the given date interval. explode: true in: query name: created required: false schema: anyOf: - properties: gt: type: integer gte: type: integer lt: type: integer lte: type: integer title: range_query_specs type: object - type: integer style: deepObject - explode: true in: query name: effective_at required: false schema: anyOf: - properties: gt: type: integer gte: type: integer lt: type: integer lte: type: integer title: range_query_specs type: object - type: integer style: deepObject - description: >- A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. in: query name: ending_before required: false schema: maxLength: 5000 type: string style: form - description: Specifies which fields in the response should be expanded. explode: true in: query name: expand required: false schema: items: maxLength: 5000 type: string type: array style: deepObject - description: Returns objects associated with this FinancialAccount. in: query name: financial_account required: true schema: type: string style: form - description: >- A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. in: query name: limit required: false schema: type: integer style: form - description: >- The results are in reverse chronological order by `created` or `effective_at`. The default is `created`. in: query name: order_by required: false schema: enum: - created - effective_at type: string style: form - description: >- A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. in: query name: starting_after required: false schema: maxLength: 5000 type: string style: form - description: Only return TransactionEntries associated with this Transaction. in: query name: transaction required: false schema: maxLength: 5000 type: string style: form requestBody: content: application/x-www-form-urlencoded: encoding: {} schema: additionalProperties: false properties: {} type: object required: false responses: '200': content: application/json: schema: description: '' properties: data: description: Details about each object. items: $ref: '#/components/schemas/treasury.transaction_entry' type: array has_more: description: >- True if this list has another page of items after this one that can be fetched. type: boolean object: description: >- String representing the object's type. Objects of the same type share the same value. Always has the value `list`. enum: - list type: string url: description: The URL where this list can be accessed. maxLength: 5000 pattern: ^/v1/treasury/transaction_entries type: string required: - data - has_more - object - url title: TreasuryTransactionsResourceTransactionEntryList type: object x-expandableFields: - data description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. '/v1/treasury/transaction_entries/{id}': get: description:

Retrieves a TransactionEntry object.

operationId: GetTreasuryTransactionEntriesId parameters: - description: Specifies which fields in the response should be expanded. explode: true in: query name: expand required: false schema: items: maxLength: 5000 type: string type: array style: deepObject - in: path name: id required: true schema: maxLength: 5000 type: string style: simple requestBody: content: application/x-www-form-urlencoded: encoding: {} schema: additionalProperties: false properties: {} type: object required: false responses: '200': content: application/json: schema: $ref: '#/components/schemas/treasury.transaction_entry' description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. /v1/treasury/transactions: get: description:

Retrieves a list of Transaction objects.

operationId: GetTreasuryTransactions parameters: - description: >- Only return Transactions that were created during the given date interval. explode: true in: query name: created required: false schema: anyOf: - properties: gt: type: integer gte: type: integer lt: type: integer lte: type: integer title: range_query_specs type: object - type: integer style: deepObject - description: >- A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. in: query name: ending_before required: false schema: maxLength: 5000 type: string style: form - description: Specifies which fields in the response should be expanded. explode: true in: query name: expand required: false schema: items: maxLength: 5000 type: string type: array style: deepObject - description: Returns objects associated with this FinancialAccount. in: query name: financial_account required: true schema: type: string style: form - description: >- A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. in: query name: limit required: false schema: type: integer style: form - description: >- The results are in reverse chronological order by `created` or `posted_at`. The default is `created`. in: query name: order_by required: false schema: enum: - created - posted_at type: string x-stripeBypassValidation: true style: form - description: >- A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. in: query name: starting_after required: false schema: maxLength: 5000 type: string style: form - description: >- Only return Transactions that have the given status: `open`, `posted`, or `void`. in: query name: status required: false schema: enum: - open - posted - void type: string style: form - description: >- A filter for the `status_transitions.posted_at` timestamp. When using this filter, `status=posted` and `order_by=posted_at` must also be specified. explode: true in: query name: status_transitions required: false schema: properties: posted_at: anyOf: - properties: gt: type: integer gte: type: integer lt: type: integer lte: type: integer title: range_query_specs type: object - type: integer title: status_transition_timestamp_specs type: object style: deepObject requestBody: content: application/x-www-form-urlencoded: encoding: {} schema: additionalProperties: false properties: {} type: object required: false responses: '200': content: application/json: schema: description: '' properties: data: description: Details about each object. items: $ref: '#/components/schemas/treasury.transaction' type: array has_more: description: >- True if this list has another page of items after this one that can be fetched. type: boolean object: description: >- String representing the object's type. Objects of the same type share the same value. Always has the value `list`. enum: - list type: string url: description: The URL where this list can be accessed. maxLength: 5000 type: string required: - data - has_more - object - url title: TreasuryTransactionsResourceTransactionList type: object x-expandableFields: - data description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. '/v1/treasury/transactions/{id}': get: description:

Retrieves the details of an existing Transaction.

operationId: GetTreasuryTransactionsId parameters: - description: Specifies which fields in the response should be expanded. explode: true in: query name: expand required: false schema: items: maxLength: 5000 type: string type: array style: deepObject - in: path name: id required: true schema: maxLength: 5000 type: string style: simple requestBody: content: application/x-www-form-urlencoded: encoding: {} schema: additionalProperties: false properties: {} type: object required: false responses: '200': content: application/json: schema: $ref: '#/components/schemas/treasury.transaction' description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. /v1/webhook_endpoints: get: description:

Returns a list of your webhook endpoints.

operationId: GetWebhookEndpoints parameters: - description: >- A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. in: query name: ending_before required: false schema: maxLength: 5000 type: string style: form - description: Specifies which fields in the response should be expanded. explode: true in: query name: expand required: false schema: items: maxLength: 5000 type: string type: array style: deepObject - description: >- A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. in: query name: limit required: false schema: type: integer style: form - description: >- A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. in: query name: starting_after required: false schema: maxLength: 5000 type: string style: form requestBody: content: application/x-www-form-urlencoded: encoding: {} schema: additionalProperties: false properties: {} type: object required: false responses: '200': content: application/json: schema: description: '' properties: data: items: $ref: '#/components/schemas/webhook_endpoint' type: array has_more: description: >- True if this list has another page of items after this one that can be fetched. type: boolean object: description: >- String representing the object's type. Objects of the same type share the same value. Always has the value `list`. enum: - list type: string url: description: The URL where this list can be accessed. maxLength: 5000 pattern: ^/v1/webhook_endpoints type: string required: - data - has_more - object - url title: NotificationWebhookEndpointList type: object x-expandableFields: - data description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. post: description: >-

A webhook endpoint must have a url and a list of enabled_events. You may optionally specify the Boolean connect parameter. If set to true, then a Connect webhook endpoint that notifies the specified url about events from all connected accounts is created; otherwise an account webhook endpoint that notifies the specified url only about events from your account is created. You can also create webhook endpoints in the webhooks settings section of the Dashboard.

operationId: PostWebhookEndpoints requestBody: content: application/x-www-form-urlencoded: encoding: description: explode: true style: deepObject enabled_events: explode: true style: deepObject expand: explode: true style: deepObject metadata: explode: true style: deepObject schema: additionalProperties: false properties: api_version: description: >- Events sent to this endpoint will be generated with this Stripe Version instead of your account's default Stripe Version. enum: - '2011-01-01' - '2011-06-21' - '2011-06-28' - '2011-08-01' - '2011-09-15' - '2011-11-17' - '2012-02-23' - '2012-03-25' - '2012-06-18' - '2012-06-28' - '2012-07-09' - '2012-09-24' - '2012-10-26' - '2012-11-07' - '2013-02-11' - '2013-02-13' - '2013-07-05' - '2013-08-12' - '2013-08-13' - '2013-10-29' - '2013-12-03' - '2014-01-31' - '2014-03-13' - '2014-03-28' - '2014-05-19' - '2014-06-13' - '2014-06-17' - '2014-07-22' - '2014-07-26' - '2014-08-04' - '2014-08-20' - '2014-09-08' - '2014-10-07' - '2014-11-05' - '2014-11-20' - '2014-12-08' - '2014-12-17' - '2014-12-22' - '2015-01-11' - '2015-01-26' - '2015-02-10' - '2015-02-16' - '2015-02-18' - '2015-03-24' - '2015-04-07' - '2015-06-15' - '2015-07-07' - '2015-07-13' - '2015-07-28' - '2015-08-07' - '2015-08-19' - '2015-09-03' - '2015-09-08' - '2015-09-23' - '2015-10-01' - '2015-10-12' - '2015-10-16' - '2016-02-03' - '2016-02-19' - '2016-02-22' - '2016-02-23' - '2016-02-29' - '2016-03-07' - '2016-06-15' - '2016-07-06' - '2016-10-19' - '2017-01-27' - '2017-02-14' - '2017-04-06' - '2017-05-25' - '2017-06-05' - '2017-08-15' - '2017-12-14' - '2018-01-23' - '2018-02-05' - '2018-02-06' - '2018-02-28' - '2018-05-21' - '2018-07-27' - '2018-08-23' - '2018-09-06' - '2018-09-24' - '2018-10-31' - '2018-11-08' - '2019-02-11' - '2019-02-19' - '2019-03-14' - '2019-05-16' - '2019-08-14' - '2019-09-09' - '2019-10-08' - '2019-10-17' - '2019-11-05' - '2019-12-03' - '2020-03-02' - '2020-08-27' - '2022-08-01' - '2022-11-15' - '2023-08-16' - '2023-10-16' - '2024-04-10' maxLength: 5000 type: string x-stripeBypassValidation: true connect: description: >- Whether this endpoint should receive events from connected accounts (`true`), or from your account (`false`). Defaults to `false`. type: boolean description: anyOf: - maxLength: 5000 type: string - enum: - '' type: string description: An optional description of what the webhook is used for. enabled_events: description: >- The list of events to enable for this endpoint. You may specify `['*']` to enable all events, except those that require explicit selection. items: enum: - '*' - account.application.authorized - account.application.deauthorized - account.external_account.created - account.external_account.deleted - account.external_account.updated - account.updated - application_fee.created - application_fee.refund.updated - application_fee.refunded - balance.available - billing_portal.configuration.created - billing_portal.configuration.updated - billing_portal.session.created - capability.updated - cash_balance.funds_available - charge.captured - charge.dispute.closed - charge.dispute.created - charge.dispute.funds_reinstated - charge.dispute.funds_withdrawn - charge.dispute.updated - charge.expired - charge.failed - charge.pending - charge.refund.updated - charge.refunded - charge.succeeded - charge.updated - checkout.session.async_payment_failed - checkout.session.async_payment_succeeded - checkout.session.completed - checkout.session.expired - climate.order.canceled - climate.order.created - climate.order.delayed - climate.order.delivered - climate.order.product_substituted - climate.product.created - climate.product.pricing_updated - coupon.created - coupon.deleted - coupon.updated - credit_note.created - credit_note.updated - credit_note.voided - customer.created - customer.deleted - customer.discount.created - customer.discount.deleted - customer.discount.updated - customer.source.created - customer.source.deleted - customer.source.expiring - customer.source.updated - customer.subscription.created - customer.subscription.deleted - customer.subscription.paused - customer.subscription.pending_update_applied - customer.subscription.pending_update_expired - customer.subscription.resumed - customer.subscription.trial_will_end - customer.subscription.updated - customer.tax_id.created - customer.tax_id.deleted - customer.tax_id.updated - customer.updated - customer_cash_balance_transaction.created - entitlements.active_entitlement_summary.updated - file.created - financial_connections.account.created - financial_connections.account.deactivated - financial_connections.account.disconnected - financial_connections.account.reactivated - financial_connections.account.refreshed_balance - financial_connections.account.refreshed_ownership - financial_connections.account.refreshed_transactions - identity.verification_session.canceled - identity.verification_session.created - identity.verification_session.processing - identity.verification_session.redacted - identity.verification_session.requires_input - identity.verification_session.verified - invoice.created - invoice.deleted - invoice.finalization_failed - invoice.finalized - invoice.marked_uncollectible - invoice.paid - invoice.payment_action_required - invoice.payment_failed - invoice.payment_succeeded - invoice.sent - invoice.upcoming - invoice.updated - invoice.voided - invoiceitem.created - invoiceitem.deleted - issuing_authorization.created - issuing_authorization.request - issuing_authorization.updated - issuing_card.created - issuing_card.updated - issuing_cardholder.created - issuing_cardholder.updated - issuing_dispute.closed - issuing_dispute.created - issuing_dispute.funds_reinstated - issuing_dispute.submitted - issuing_dispute.updated - issuing_token.created - issuing_token.updated - issuing_transaction.created - issuing_transaction.updated - mandate.updated - payment_intent.amount_capturable_updated - payment_intent.canceled - payment_intent.created - payment_intent.partially_funded - payment_intent.payment_failed - payment_intent.processing - payment_intent.requires_action - payment_intent.succeeded - payment_link.created - payment_link.updated - payment_method.attached - payment_method.automatically_updated - payment_method.detached - payment_method.updated - payout.canceled - payout.created - payout.failed - payout.paid - payout.reconciliation_completed - payout.updated - person.created - person.deleted - person.updated - plan.created - plan.deleted - plan.updated - price.created - price.deleted - price.updated - product.created - product.deleted - product.updated - promotion_code.created - promotion_code.updated - quote.accepted - quote.canceled - quote.created - quote.finalized - radar.early_fraud_warning.created - radar.early_fraud_warning.updated - refund.created - refund.updated - reporting.report_run.failed - reporting.report_run.succeeded - reporting.report_type.updated - review.closed - review.opened - setup_intent.canceled - setup_intent.created - setup_intent.requires_action - setup_intent.setup_failed - setup_intent.succeeded - sigma.scheduled_query_run.created - source.canceled - source.chargeable - source.failed - source.mandate_notification - source.refund_attributes_required - source.transaction.created - source.transaction.updated - subscription_schedule.aborted - subscription_schedule.canceled - subscription_schedule.completed - subscription_schedule.created - subscription_schedule.expiring - subscription_schedule.released - subscription_schedule.updated - tax.settings.updated - tax_rate.created - tax_rate.updated - terminal.reader.action_failed - terminal.reader.action_succeeded - test_helpers.test_clock.advancing - test_helpers.test_clock.created - test_helpers.test_clock.deleted - test_helpers.test_clock.internal_failure - test_helpers.test_clock.ready - topup.canceled - topup.created - topup.failed - topup.reversed - topup.succeeded - transfer.created - transfer.reversed - transfer.updated - treasury.credit_reversal.created - treasury.credit_reversal.posted - treasury.debit_reversal.completed - treasury.debit_reversal.created - treasury.debit_reversal.initial_credit_granted - treasury.financial_account.closed - treasury.financial_account.created - treasury.financial_account.features_status_updated - treasury.inbound_transfer.canceled - treasury.inbound_transfer.created - treasury.inbound_transfer.failed - treasury.inbound_transfer.succeeded - treasury.outbound_payment.canceled - treasury.outbound_payment.created - treasury.outbound_payment.expected_arrival_date_updated - treasury.outbound_payment.failed - treasury.outbound_payment.posted - treasury.outbound_payment.returned - treasury.outbound_transfer.canceled - treasury.outbound_transfer.created - treasury.outbound_transfer.expected_arrival_date_updated - treasury.outbound_transfer.failed - treasury.outbound_transfer.posted - treasury.outbound_transfer.returned - treasury.received_credit.created - treasury.received_credit.failed - treasury.received_credit.succeeded - treasury.received_debit.created type: string x-stripeBypassValidation: true type: array expand: description: Specifies which fields in the response should be expanded. items: maxLength: 5000 type: string type: array metadata: anyOf: - additionalProperties: type: string type: object - enum: - '' type: string description: >- Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. url: description: The URL of the webhook endpoint. type: string required: - enabled_events - url type: object required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/webhook_endpoint' description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. '/v1/webhook_endpoints/{webhook_endpoint}': delete: description: >-

You can also delete webhook endpoints via the webhook endpoint management page of the Stripe dashboard.

operationId: DeleteWebhookEndpointsWebhookEndpoint parameters: - in: path name: webhook_endpoint required: true schema: maxLength: 5000 type: string style: simple requestBody: content: application/x-www-form-urlencoded: encoding: {} schema: additionalProperties: false properties: {} type: object required: false responses: '200': content: application/json: schema: $ref: '#/components/schemas/deleted_webhook_endpoint' description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. get: description:

Retrieves the webhook endpoint with the given ID.

operationId: GetWebhookEndpointsWebhookEndpoint parameters: - description: Specifies which fields in the response should be expanded. explode: true in: query name: expand required: false schema: items: maxLength: 5000 type: string type: array style: deepObject - in: path name: webhook_endpoint required: true schema: maxLength: 5000 type: string style: simple requestBody: content: application/x-www-form-urlencoded: encoding: {} schema: additionalProperties: false properties: {} type: object required: false responses: '200': content: application/json: schema: $ref: '#/components/schemas/webhook_endpoint' description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. post: description: >-

Updates the webhook endpoint. You may edit the url, the list of enabled_events, and the status of your endpoint.

operationId: PostWebhookEndpointsWebhookEndpoint parameters: - in: path name: webhook_endpoint required: true schema: maxLength: 5000 type: string style: simple requestBody: content: application/x-www-form-urlencoded: encoding: description: explode: true style: deepObject enabled_events: explode: true style: deepObject expand: explode: true style: deepObject metadata: explode: true style: deepObject schema: additionalProperties: false properties: description: anyOf: - maxLength: 5000 type: string - enum: - '' type: string description: An optional description of what the webhook is used for. disabled: description: Disable the webhook endpoint if set to true. type: boolean enabled_events: description: >- The list of events to enable for this endpoint. You may specify `['*']` to enable all events, except those that require explicit selection. items: enum: - '*' - account.application.authorized - account.application.deauthorized - account.external_account.created - account.external_account.deleted - account.external_account.updated - account.updated - application_fee.created - application_fee.refund.updated - application_fee.refunded - balance.available - billing_portal.configuration.created - billing_portal.configuration.updated - billing_portal.session.created - capability.updated - cash_balance.funds_available - charge.captured - charge.dispute.closed - charge.dispute.created - charge.dispute.funds_reinstated - charge.dispute.funds_withdrawn - charge.dispute.updated - charge.expired - charge.failed - charge.pending - charge.refund.updated - charge.refunded - charge.succeeded - charge.updated - checkout.session.async_payment_failed - checkout.session.async_payment_succeeded - checkout.session.completed - checkout.session.expired - climate.order.canceled - climate.order.created - climate.order.delayed - climate.order.delivered - climate.order.product_substituted - climate.product.created - climate.product.pricing_updated - coupon.created - coupon.deleted - coupon.updated - credit_note.created - credit_note.updated - credit_note.voided - customer.created - customer.deleted - customer.discount.created - customer.discount.deleted - customer.discount.updated - customer.source.created - customer.source.deleted - customer.source.expiring - customer.source.updated - customer.subscription.created - customer.subscription.deleted - customer.subscription.paused - customer.subscription.pending_update_applied - customer.subscription.pending_update_expired - customer.subscription.resumed - customer.subscription.trial_will_end - customer.subscription.updated - customer.tax_id.created - customer.tax_id.deleted - customer.tax_id.updated - customer.updated - customer_cash_balance_transaction.created - entitlements.active_entitlement_summary.updated - file.created - financial_connections.account.created - financial_connections.account.deactivated - financial_connections.account.disconnected - financial_connections.account.reactivated - financial_connections.account.refreshed_balance - financial_connections.account.refreshed_ownership - financial_connections.account.refreshed_transactions - identity.verification_session.canceled - identity.verification_session.created - identity.verification_session.processing - identity.verification_session.redacted - identity.verification_session.requires_input - identity.verification_session.verified - invoice.created - invoice.deleted - invoice.finalization_failed - invoice.finalized - invoice.marked_uncollectible - invoice.paid - invoice.payment_action_required - invoice.payment_failed - invoice.payment_succeeded - invoice.sent - invoice.upcoming - invoice.updated - invoice.voided - invoiceitem.created - invoiceitem.deleted - issuing_authorization.created - issuing_authorization.request - issuing_authorization.updated - issuing_card.created - issuing_card.updated - issuing_cardholder.created - issuing_cardholder.updated - issuing_dispute.closed - issuing_dispute.created - issuing_dispute.funds_reinstated - issuing_dispute.submitted - issuing_dispute.updated - issuing_token.created - issuing_token.updated - issuing_transaction.created - issuing_transaction.updated - mandate.updated - payment_intent.amount_capturable_updated - payment_intent.canceled - payment_intent.created - payment_intent.partially_funded - payment_intent.payment_failed - payment_intent.processing - payment_intent.requires_action - payment_intent.succeeded - payment_link.created - payment_link.updated - payment_method.attached - payment_method.automatically_updated - payment_method.detached - payment_method.updated - payout.canceled - payout.created - payout.failed - payout.paid - payout.reconciliation_completed - payout.updated - person.created - person.deleted - person.updated - plan.created - plan.deleted - plan.updated - price.created - price.deleted - price.updated - product.created - product.deleted - product.updated - promotion_code.created - promotion_code.updated - quote.accepted - quote.canceled - quote.created - quote.finalized - radar.early_fraud_warning.created - radar.early_fraud_warning.updated - refund.created - refund.updated - reporting.report_run.failed - reporting.report_run.succeeded - reporting.report_type.updated - review.closed - review.opened - setup_intent.canceled - setup_intent.created - setup_intent.requires_action - setup_intent.setup_failed - setup_intent.succeeded - sigma.scheduled_query_run.created - source.canceled - source.chargeable - source.failed - source.mandate_notification - source.refund_attributes_required - source.transaction.created - source.transaction.updated - subscription_schedule.aborted - subscription_schedule.canceled - subscription_schedule.completed - subscription_schedule.created - subscription_schedule.expiring - subscription_schedule.released - subscription_schedule.updated - tax.settings.updated - tax_rate.created - tax_rate.updated - terminal.reader.action_failed - terminal.reader.action_succeeded - test_helpers.test_clock.advancing - test_helpers.test_clock.created - test_helpers.test_clock.deleted - test_helpers.test_clock.internal_failure - test_helpers.test_clock.ready - topup.canceled - topup.created - topup.failed - topup.reversed - topup.succeeded - transfer.created - transfer.reversed - transfer.updated - treasury.credit_reversal.created - treasury.credit_reversal.posted - treasury.debit_reversal.completed - treasury.debit_reversal.created - treasury.debit_reversal.initial_credit_granted - treasury.financial_account.closed - treasury.financial_account.created - treasury.financial_account.features_status_updated - treasury.inbound_transfer.canceled - treasury.inbound_transfer.created - treasury.inbound_transfer.failed - treasury.inbound_transfer.succeeded - treasury.outbound_payment.canceled - treasury.outbound_payment.created - treasury.outbound_payment.expected_arrival_date_updated - treasury.outbound_payment.failed - treasury.outbound_payment.posted - treasury.outbound_payment.returned - treasury.outbound_transfer.canceled - treasury.outbound_transfer.created - treasury.outbound_transfer.expected_arrival_date_updated - treasury.outbound_transfer.failed - treasury.outbound_transfer.posted - treasury.outbound_transfer.returned - treasury.received_credit.created - treasury.received_credit.failed - treasury.received_credit.succeeded - treasury.received_debit.created type: string x-stripeBypassValidation: true type: array expand: description: Specifies which fields in the response should be expanded. items: maxLength: 5000 type: string type: array metadata: anyOf: - additionalProperties: type: string type: object - enum: - '' type: string description: >- Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. url: description: The URL of the webhook endpoint. type: string type: object required: false responses: '200': content: application/json: schema: $ref: '#/components/schemas/webhook_endpoint' description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. security: - basicAuth: [] - bearerAuth: [] servers: - url: 'https://api.stripe.com/'